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.

NameTypeDescriptionRequiredDefault value
customerIntegerID of customer owning mailbox.Yes
mailboxStringMailbox containing message.Yes
folderStringFolder containing message. Most commonly "INBOX".Yes
messageStringMessage file to delete.Yes
hashStringHash of message file.Yes

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
404The 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

VersionChanges
3.13Function added.