JSON API » cards » cards/files/delete
Deletes a message file for a card group.
Input parameters
Requires authentication and the cards role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
cardgroup | Integer | ID of card group. | Yes | |
file | String | Which message file to delete. "balance", "connecting", "destination", "dest-invalid", "expired", "goodbye", "in-use", "locked", "no-credit", or "no-permission-to-dial-number". | Yes |
Responses
Code | Description |
---|---|
204 | Success. |
400 | Invalid file specified. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
Version | Changes |
---|---|
3.13 | Function added. |