Articles in this support section discuss Telebroad's legacy APIs. To learn about the current version of Telebroad APIs, which offer additional authentication options and support for advanced features, please go to https://developers.telebroad.com/.
Function and Response Fields
Note the distinction between this API and the GET/fax/message requestthat returns information for a single fax.
The GET/fax/messages method returns a list of fax documents received or sent for a particular mailbox (on the Telebroad system, mailboxes hold both voicemail and fax messages).
Each listed fax document includes the following fields of information:
- ID - a specific identification number of the fax document. This can be used for the get/fax/message request, 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 with 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 - a name or ID (such as an extension) of the user who read the message, if any.
- seen - A Boolean response. A value of 1 indicates that the message was seen (read) by someone. A value of 0 indicates it has not.
Parameters
All parameters go in the header.
| Parameter | Type | Operation |
| mailbox | string | Indicates the mailbox number for which to list the fax documents. |
| descending | Boolean | Use this to sort the list in descending order. |
| dir | string | The directory for which the fax documents will be listed, either INBOX or SENT. |
| *start | integer | The starting time for displaying the documents in Unix time. |
| *end | integer | The ending time for displaying the documents in Unix time. |
| 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 voicemail. If left empty the default will be the first voicemail. |
*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:
HTTP method: GET
whttps://webserv.telebroad.com/api/teleconsole/rest/fax/messages?descending=1&end=-1&mailbox=1113840&start=0
Response:
{
"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": "0"
},
{
"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": "Abby Turner",
"seen": "1"
}
}