GET/fax/messages

The get/fax/messages method returns a list of fax documents received or sent for a particular mailbox. 


Each listed fax document includes the following fields of information:


  • ID - a particular identification number identifying the fax document. This is important for the get/fax/message method, that returns details about a particular fax.
  • time - the time the message was recorded (in Unix timestamp format).
  • pages - number of pages for the fax document
  • mailbox - the mailbox containing the fax document (same as the one specified in the API request).
  • called - the destination phone number of the fax.
  • caller - the phone number of the sender of the fax.
  • callerid - the caller ID associated to the sender of the fax.
  • name - the file name of the fax document - this name is generated by the system by combining several of the above fields - time, pages, mailbox, called, caller, and callerid.
  • dir - the directory where the document is stored - either INBOX or SENT. This also indicates if the fax inbound or outbound in direction.
  • sent_by - a name or ID (such as an extension) of the user who sent the document.
  • read_by - name or ID (such as an extension) of the user who read the message, if any.
  • seen - indicates if the user has seen the notice about the message. Think of this as an email attachment. A user can open the email containing the attachment and than the attachment is seen by him as being available. Once he actually opens it will also be indicated as read by him.


Parameters


Parameter Type Operation
mailbox string Indicate the number for the mailbox for which you want to have the list of fax documents.
descending
Boolean Use this to sort the list in descending order
dir string The directory for which the documents will be listed, either INBOX or SENT
*start integer The  starting time for displaying the documents in Unix timestamp.
*end
integer
The ending time for displaying the documents in Unix timestamp.
limit
integer
Specify the number of voicemails to be returned by the request.
offset
integer
Specify the first voicemails to display. For example an offset of 3 will start the list on the 3rd voicemails. If left empty the default will be the first record.


*Use start=0 and end=-1 to display all voicemails.


Example


To get a list of fax documents for mailbox 1-646-741-5360 use this syntax:


whttps://webserv.telebroad.com/api/teleconsole/rest/fax/messages?descending=1&end=-1&mailbox=1113840&start=0


Result:


.

.

.
{
    "error": null,
    "result":[
        {
        "id": "3604696",
        "time": "1484376960",
        "pages": "1",
        "mailbox": "16467415360",
        "called": "13474367740",
        "caller": "16467415360",
        "callerid": "16467415360"
        "name": "fax_1484376960_1_13474367740_16467415360_13474367740",
        "dir": "SENT",
        "sent_by": "13697",
        "read_by": "",
        "seen": ""
    },
    {
        "id": "3461066",
        "time": "1483091348",
        "pages": "5",
        "mailbox": "16467415360",
        "called": "13474367740",
        "caller": "16467415360",
        "callerid": "16467415360",
        "name": "fax_1483091348_5_13474367740_16467415360_13474367740",
        "dir": "SENT",
        "sent_by": "13697",
        "read_by": "",
        "seen": ""
    }
}

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.