Assign a DID Direct Destination

Assigns one or more DIDs to a direct destination at the tenant level, such as a user, a queue, an IVR, a ring group, or an AI receptionist.

Request URL

POST {base_url}/uc-cconfig/api/v1/tenant-dids/direct-assignment

Request 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
destinationType Yes String

The type of the direct destination.

Valid value:

  • USER: An extension user.
  • QUEUE: A queue.
  • IVR: An IVR.
  • RING_GROUP: A ring group.
  • AI_ROUTE: An AI receptionist.
destinationId Yes String The resource ID of the destination. The value must be greater than 0. You can obtain the ID using the Search Destination Resources interface.
didIds Yes Array<String> The list of DIDs to assign. At least one DID is required, and each value must be greater than 0. You can obtain the IDs using the Search Tenant DIDs 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.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
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<Assign_Result> The assignment result.
Assign_Result
Parameter Type Description
directDidNumbers Array<Direct_DID_Number> The list of DIDs that are assigned to the destination.
failures Array<Direct_DID_Conflict> The list of DIDs that conflict with an existing destination. This parameter is empty when the request succeeds; the details are returned only in a 422 DID_DIRECT_OCCUPIED error response.
Direct_DID_Number
Parameter Type Description
id String The ID of the DID.
number String The DID number in default display format.
name String The name of the DID.
Direct_DID_Conflict
Parameter Type Description
destinationType String The type of the destination that already occupies the DID.
destinationNumber String The extension number of the occupying destination.
destinationName String The name of the occupying destination.
destinationId String The resource ID of the occupying destination.

Example

Request example

POST /uc-cconfig/api/v1/tenant-dids/direct-assignment HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyMzU3MywiaWF0IjoxNzkzNjAxOTczLCJqdGkiOiI3OTlmMzNkYS0yNmI0LTRkNDEtYmZkMC0zZGJiMjIxYzRhNmYiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImMwZjlmOGU3LWQ1M2QtNDFjOS04ZmZmLTNhYTQzZWUyNzU2YyIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.Pi7k5H5k8i02gpC3ry4JWNlkc836SfaD6a3wITzgerCEjyz9YFwX5VDYuqrQiYIsL6raVkBz_vwUaTnPdRN0xQxOeRIKOLEPaCBZCjJ_lB7IXyNrNU3O62nXefT6OpWbas6rap9K-3zpppBzxorHWD57yso1OzD-kWUhCRb3rkybe-gtOFhExl7gc3WqBgJA1V7IGoQfX4aRGhwuJ1DAC_CY5oqhE6vjw5rxWx_nCoMiN-wmsY2ou22Py7oeC83b0W21lEQY0nyECk-GCYKdJ0CBSeNKTY5ridST_QX9FBn3ETj2GrjlODRWj4tniWY2PJszVp2XswULShQoXuMsXw
x-tenant-code: jint
Content-Type: application/json
{
  "destinationType": "USER",
  "destinationId": "338136731335409664",
  "didIds": [
    "367178921942994944"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "21a76d8033b403545cc6aaec62f26e5d",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "directDidNumbers": [
      {
        "id": "367178921942994944",
        "number": "364726328",
        "name": "cc测试"
      }
    ],
    "failures": []
  }
}