JSON API » messages » messages/delete

Deletes voicemail or fax messages. If using Asterisk voicemail, the mailbox is resequenced afterwards.

Input parameters

Requires authentication and the features, messages, or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
mailbox	String	Mailbox containing messages.	Yes
folder	String	Folder containing messages. Most commonly "INBOX".	Yes
messages	String	Message files to delete. Separate multiple with commas.	Yes
customer	Integer	ID of customer owning mailbox.	No	Customer of authentication user.

Responses

Code	Description
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The mailbox does not exist.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/messages/delete/?auth_username=user;auth_password=password;mailbox=1234;folder=INBOX;messages=msg0001,msg0002

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

Change history

Version	Changes
3.13	Function added.