JSON API » messages » messages/delete/hash
Deletes a message, using a hash as authentication. Only useful with Enswitch voicemail.
Input parameters
Authentication is not required.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| customer | Integer | ID of customer owning mailbox. | Yes | |
| mailbox | String | Mailbox containing message. | Yes | |
| folder | String | Folder containing message. Most commonly "INBOX". | Yes | |
| message | String | Message file to delete. | Yes | |
| hash | String | Hash of message file. | Yes |
Responses
| Code | Description |
|---|---|
| 204 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 404 | The mailbox or message does not exist, or the hash is incorrect. |
Data returned
No data is returned.
Example: With required parameters
http://enswitch.example.com/api/json/messages/delete/hash/?customer=2;mailbox=1234;folder=INBOX;message=msg0001;hash=1a2b3c...{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |
