Update Outbound Caller ID Setting
Updates the Default Outbound Caller ID configuration for the current tenant. Trunks that are not listed in the request keep their original configuration. Returns the updated configuration.
Request URL
PUT {base_url}/uc-cconfig/api/v1/tenants/outbound-caller-idRequest 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.
- Body parameters
-
Parameter Required Type Description assignments No Array<Caller_ID_Assignment> The list of trunk-level configurations to upsert. Trunks not listed keep their current configuration.
- Caller_ID_Assignment
-
Parameter Required Type Description trunkId Yes String The ID of the trunk to configure. didId No String The ID of the DID to set as the Default Outbound Caller ID. The value 0 clears the configuration. A non-zero value must be a DID that is already assigned to this trunk for the tenant.
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_Setting_Result> | The updated Default Outbound Caller ID configuration. |
- Caller_ID_Setting_Result
-
Parameter Type Description trunks Array<Caller_ID_Trunk_Detail> The Default Outbound Caller ID configuration details, listed by trunk.
- Caller_ID_Trunk_Detail
-
Parameter Type Description trunkId String The ID of the trunk. trunkName String The name of the trunk. didId String The ID of the currently configured DID. The value 0 indicates that it is not configured. didNumber String The number of the currently configured DID. An empty string indicates that it is not configured. didName String The name of the currently configured DID. An empty string indicates that it is not configured. availableDids Array<Caller_ID_DID_Option> The list of DIDs assigned to this trunk for the tenant, available for selection. didE164 String The E.164 number of the currently configured DID. An empty string indicates that it is not configured.
- Caller_ID_DID_Option
-
Parameter Type Description didId String The ID of the DID. didNumber String The DID number, which prefers the default display format and falls back to the E.164 number. didName String The name of the DID. didE164 String The E.164 number of the DID in standardized format.