Get caller ID

User Guide > Resources > Get caller ID

This request returns the external caller ID of the user. This is the phone number that is transmitted to the called party.

Xelion selects the caller ID as follow:

  1. If anonymous calling is set (see Phone Settings) then no caller ID is transmitted to the called party. The caller_id API call response is still giving the last selected caller id.

  2. Else, if the user external caller ID is set then that ID is used. The caller_id API call response is returning this caller id.

  3. Else, the default caller ID of the selected trunk is used. The caller_id API call response is returning NULL or empty.

Resource

GET /me/phone/caller_id

Parameters

None

Payload

None

Response

Object Response < string >

Context

Authorization

User

Errors

Common Errors

HTTP code Xelion code Description

404

10054

The user has no phone line.

Example

Request
GET https://xelion.nl/api/v1/master/me/phone/caller_id
Response
{
  "object": "0141632641",
  "links": [
    {
      "rel": "self",
      "href": "http://www.xelion.nl/api/v1/master/me/phone/caller_id",
      "method": "GET"
    }
  ]
}