JSON API » codes » codes/files/delete

Deletes a feature code sound file.

Input parameters

Requires authentication and the administrator or user role privileges.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
codeStringFeature code.Yes
fileStringWhich file to delete. "message" or "screen".Yes
customerIntegerID of customer owning feature code.NoCustomer of authentication user.

Responses

CodeDescription
204Success.
400Invalid file specified.
401The authentication details provided are invalid.
402Your role does not allow this.
404The feature code or file does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/codes/files/delete/?auth_username=user;auth_password=password;code=100;file=message

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.13Function added.