Get Outbound Caller ID Summary
Retrieves a summary of the Default Outbound Caller ID configuration for the current tenant, for display in the persistent header area of the outbound route list.
Request URL
GET {base_url}/uc-cconfig/api/v1/tenants/outbound-caller-id-summaryRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code Yes String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Caller_ID_Summary> | The summary of the Default Outbound Caller ID configuration. |
- Caller_ID_Summary
-
Parameter Type Description configuredNumbers Array<Configured_Number> The list of configured DID numbers, deduplicated by DID. Multiple trunks configured with the same DID appear only once. notSetCount Integer The number of trunks that have no Default Outbound Caller ID configured.
- Configured_Number
-
Parameter Type Description didId String The ID of the DID. number String The DID number, which prefers the default display format and falls back to the E.164 number. name String The name of the DID. An empty name indicates that only the number is displayed.