Get Tenant DID Options
Retrieves the list of DIDs that are assigned to the current tenant, for use as a dropdown.
Request URL
GET {base_url}/uc-cconfig/api/v1/tenants/didsRequest 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<Tenant_DIDs_Result> | The list of DIDs assigned to the tenant. |
- Tenant_DIDs_Result
-
Parameter Type Description dids Array<Tenant_DID_Option> The list of DIDs that are assigned to the current tenant.
- Tenant_DID_Option
-
Parameter Type Description id 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. numberType String The type of the DID number.