JSON API » cards » cards/files/delete

Deletes a message file for a card group.

Input parameters

Requires authentication and the cards role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
cardgroupIntegerID of card group.Yes
fileStringWhich message file to delete. "balance", "connecting", "destination", "dest-invalid", "expired", "goodbye", "in-use", "locked", "no-credit", or "no-permission-to-dial-number".Yes

Responses

CodeDescription
204Success.
400Invalid file specified.
401The authentication details provided are invalid.
402Your role does not allow this.
404The card group 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/cards/files/delete/?auth_username=user;auth_password=password;cardgroup=123;file=destination

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

Change history

VersionChanges
3.13Function added.