List Assignable Trunks
Lists the trunks that can be assigned to a target tenant, filtered by the tenant owner's account.
Request URL
POST {base_url}/uc-cconfig/api/v1/tenants/assignable-trunksRequest 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 ownerId Yes String The account ID of the target tenant's owner. For a new tenant, this is the selected owner; for editing, this is the tenant's current owner. RESELLER can only pass their own ID; ADMIN is limited to the current UC domain.
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. |
| trunks | Array<Trunk_Option> | The list of trunks that can be assigned to the target tenant. |
- Trunk_Option
-
Parameter Type Description id String The ID of the trunk. name String The name of the trunk. provider String The line provider of the trunk. sipCustomHeaders Object<SIP_Custom_Headers> The custom SIP header names of the trunk.
- SIP_Custom_Headers
-
Parameter Type Description headers Array<Custom_SIP_Header> The list of custom SIP header names. Up to 5 headers are supported.
- Custom_SIP_Header
-
Parameter Type Description name String The header name, up to 64 characters. Letters, digits, and -,.,!,%,,_,+,~are allowed.id String The stable identifier of the header (UUID). The identifier remains unchanged when the header is renamed and is generated by the server when left empty on creation.