REST API
Getting Started Basics
API Reference
Guides
API Changelog

Read Caller ID Settings for a Person

Retrieve a Person's Caller ID Settings

Caller ID settings control how a person’s information is displayed when making outgoing calls.

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read or a user auth token with spark:people_read scope can be used by a person to read their own settings.

GET/v1/people/{personId}/features/callerId
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.

Response Properties
types
array

Allowed types for the selected field.

selected
CallerIdSelectedType

Which type of outgoing Caller ID will be used.

directNumber
string

Direct number which will be shown if DIRECT_LINE is selected.

extensionNumber
string

Extension number which will be shown if DIRECT_LINE is selected.

locationNumber
string

Location number which will be shown if LOCATION_NUMBER is selected.

mobileNumber
string

Mobile number which will be shown if MOBILE_NUMBER is selected.

customNumber
string

This value must be an assigned number from the person's location.

customNumberInfo
object

Information about the custom caller ID number.

type
enum

EXTERNAL if the custom caller ID number is external, otherwise INTERNAL.

INTERNAL
string

Custom caller ID number is internal.

EXTERNAL
string

Custom caller ID number is external.

firstName
string

First name of custom caller ID number.

lastName
string

Last name of custom caller ID number.

firstName
string

Person's Caller ID first name. Characters of %, +, ``, " and Unicode characters are not allowed.

lastName
string

Person's Caller ID last name. Characters of %, +, ``, " and Unicode characters are not allowed.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/people//features/callerId{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as token used to access API.
https://webexapis.com/v1/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/callerId?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
200 / OK
{
    "types": ["DIRECT_LINE", "LOCATION_NUMBER", "MOBILE_NUMBER", "CUSTOM"],
    "selected": "DIRECT_LINE",
    "directNumber": "3182202028",
    "extensionNumber": "4000",
    "locationNumber": "+13182202021",
    "firstName": "Lya",
    "lastName": "Charrel"
}