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/messages request, which returns a list of fax messages for a mailbox.
The GET/fax/message method returns the file attachment of a particular fax document for the specified mailbox number (on the Telebroad system, mailboxes hold both voicemail and fax messages). The file is displayed as an ASCII string, encoded in Base64 format.
The response has the following fields:
- name - the name of the file of the fax document. This is usually a PDF file and is different than the name in the request.
- data - a text string representing the fax file attachment, encoded in Base64 format.
Parameters
All parameters go in the header.
Parameter | Type | Operation |
mailbox | string | The mailbox from which the fax document is requested. |
file | string | The name of the file (fax document) for which the details are requested. It is different than the name in the response. You obtain this file name from the get/fax/messages method. |
| dir | string | The directory from which to obtain the fax document in the selected mailbox. The value can be either INBOX or SENT. Default is INBOX. |
Example
To get the file of a fax document for mailbox 12741550 in the SENT directory named "1484376960_1_13474367740_16466991356" use the following syntax:
HTTPS method: GET
webserv.telebroad.com/api/teleconsole/rest/fax/message?mailbox=12741550&dir=SENT&file=1484376960_1_13474367740_16466991356
Response:
The returned data field may be dozens of pages long. Shown here is a truncated version.
{
"error":null,
"result":
[{"name":"1484376960_1_13474367740_
16466991356.pdf",
"data":"JVBERi0xLjQKJeHp69MKMiAwIG9iago8PC9U
eXBlIC9DYXRhbG9nCi9QYWdlcyAxIDAgUgo+PgplbmRvYm
oKMyAwIG9iago8PC9UeXBlIC9QYWdlCi9QYXJlbnQgMSAw
IFIKL1Jlc291cmNlcyA8PC9Qcm9jU2V0cyBbL1BERiAvVGV4d
CAvSW1hZ2VCIC9JbWFnZUMgL0ltYWdlSV0KL0V4dEdTdGF0ZSA
8PC9HMCA0IDAgUgo+PgovRm9udCA8PC9GMCA1IDAgUgo+Pgo+Pgov
TWVkaWFCb3ggWzAgMCA1OTUgODQxXQovQ29udGVudHMgNiAwIFIKP
j4KZW5kb2JqCjYgMCBvYmoKPDwvTGVuZ3RoIDQ1NTAKPj4gc3d
fkhsih
.
.
.
RyZWFtC"
}
}]
}