Read Caller ID Settings for a Virtual Line
Retrieve a virtual line's Caller ID settings.
Caller ID settings control how a virtual line's information is displayed when making outgoing calls.
Retrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a virtual line with the matching ID.
Query Parameters
ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API.
Response Properties
Allowed types for the selected field. This field is read-only and cannot be modified.
Outgoing caller ID will show the caller's direct line number
Outgoing caller ID will show the main number for the location.
Outgoing caller ID will show the value from the customNumber field.
Which type of outgoing Caller ID will be used. This setting is for the number portion.
Outgoing caller ID will show the caller's direct line number.
Outgoing caller ID will show the main number for the location.
Outgoing caller ID will show the value from the customNumber field.
Direct number which will be shown if DIRECT_LINE is selected.
Extension number of the virtual line.
Location number which will be shown if LOCATION_NUMBER is selected.
Flag to indicate if the location number is toll-free number.
Custom number which will be shown if CUSTOM is selected. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location.
Virtual line's Caller ID first name. The characters %, +, ``, " and Unicode characters are not allowed.
Virtual line's Caller ID last name. The characters %, +, ``, " and Unicode characters are not allowed.
Block this virtual line's identity when receiving a call.
Designates which type of External Caller ID Name policy is used. Default is DIRECT_LINE.
Outgoing caller ID will show the caller's direct line name.
Outgoing caller ID will show the external caller ID name for the location.
Outgoing caller ID will show the value from the customExternalCallerIdName field.
Custom external caller ID name which will be shown if external caller ID name policy is OTHER.
Location's external caller ID name which will be shown if external caller ID name policy is LOCATION.
Flag to indicate the virtual line's direct line number is available as an additional external caller ID for the virtual line.
Flag to indicate the location main number is available as an additional external caller ID for the virtual line.
The custom number available as an additional external caller ID for the virtual line. This value must be a number from the virtual line's location or from another location with the same country, PSTN provider, and zone (only applicable for India locations) as the virtual line's location.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The 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. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The 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. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The 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. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too 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. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API.
{
"types": ["DIRECT_LINE", "LOCATION_NUMBER", "CUSTOM"],
"selected": "DIRECT_LINE",
"directNumber": "3182202028",
"extensionNumber": "4000",
"locationNumber": "+13182202021",
"tollFreeLocationNumber": false,
"firstName": "Lya",
"lastName": "Charrel",
"blockInForwardCallsEnabled": false,
"externalCallerIdNamePolicy": "OTHER",
"customExternalCallerIdName": "Lya Custom",
"locationExternalCallerIdName": "Location caller id",
"additionalExternalCallerIdDirectLineEnabled": false,
"additionalExternalCallerIdLocationNumberEnabled": false,
"additionalExternalCallerIdCustomNumber": "2025552000"
}