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
The GET/phone/destinations method returns a list of destinations (users) on the company's PBX along with phone lines, extensions, and internal caller IDs.
The method can return all destinations or just those owned by the user. The latter can also achieved with the GET/myProfile request, but with many additional response details that may be redundant for just checking destination information.
The response has the following fields:
- name - the name (practically the number) of the internal PBX phone line.
- description - a description of the user or the phone line. It could be a name of a person, a department, or the function of the extension.
- callerIDInternal - a caller ID associated with the phone line to be used by internal users. In most cases, this is the same as fcode (see below).
- callerID - the caller ID associated with the phone line that is to be displayed to outside callers.
- owner - a container with the following details of the owner of the extension -
- username - the PBX user name of the owner of the extension, usually his email address.
- title - the title of the owner if the extension.
- forename - the forename of the owner of the extension.
- surname - the surname of the owner of the extension.
- extension - the extension of the owner of the phone line. By default this is identical to the phone line itself. The exception is in a case where a user has several extensions.
- fcode - stands for feature code. It is a shortened internal extension associated with the phone line that makes it easier for agents to contact each other. For example, instead of Agent A dialing 1174831 to reach Agent B, they can simply dial 220.
Parameters
All parameters go in the header.
Parameter | Type | Operation |
all_destinations | Boolean | A value of 1 will return all extensions in the company. A value of 0 will return only the extension owned by the user. |
Example
To see the extension(s) owned by a user, use this syntax:
HTTPS method: GET
webserv.telebroad.com/api/teleconsole/rest/phone/destinations?all_destinations=0
Response:
{
"error":null,
"result":[
{
"name":"1784240",
"description":"Greg Tucker",
"callerIDint":"217",
"callerID":"18425824711",
"owner":{
"username":"G.tucker@gcp-us.co.",
"title":"Mr.",
"forename":"Greg",
"surname":"Tucker",
"extension":"1784240"
},
"fcode":"201"
},
]
}