GET/phone/destinations

Function


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 later can be also achieve with the GET/myProfile method, but with many other response details that may be redundant for just checking basic information.


The response has the following fields of information:


  • name - the name (practically the number) of the internal PBX phone line.
  • description -  a description of the user of 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 is set by an administrator. It makes it easier for agents to contact each other. For example instead of agent A dialing 1174831 to reach Agent B, he 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.


Examples


To see the extension(s) owned by a user use this syntax:


HTTP 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"
        },

    ]

}

Did you find it helpful? Yes No

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