1. Teleboard | Support Center
  2. Solution home
  3. API Documentation
  4. REST API - DELETE Requests
Open navigation

DELETE/fax/messages

Function


The DELETE/fax/messages request will delete one or more fax documents from the user's account archive. 


Parameters


All parameters go in the header.


Parameter
Type
Operation
mailboxstring
The  mailbox line from which the fax document is to be deleted.
file
stringThe file name of the message to be deleted (several can be specified in one request, but each in a separate parameter item.)
 
You obtain this file name using the get/fax/messages method.
dirstringThe directory for which the messages will be listed, either INBOX or SENT. Default is INBOX.

Example


To delete a message in the inbox directory for fax mailbox 1113840 use this syntax:


HTTPS method: DELETE


webserv.telebroad.com/api/teleconsole/rest/fax/messages?mailbox=1113840&dir=INBOX&file=fax_1484376960_1_13474367740_16466991356_13474367740


Response:


A "null" error indicates successful deletion.


    {"error":null,"result":[]}