Query DID List

Retrieves the DID list of the tenant in pages, with support for filtering by number, name, type, trunk, reseller, tenant, status, and keyword search.

Request URL

POST {base_url}/uc-cconfig/api/v1/dids/search-page

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
pageSize	Yes	Integer	The number of records to retrieve per page.
pageSize	No	Integer	The number of records to retrieve per page.
keyword	No	String	The global search keyword. Matches by `/` and space word segmentation with AND logic, case-insensitive. Multiple words must all match on the same line: DID (default display format or E.164), DID Name, Assigned Trunk, Assigned Reseller, Assigned Tenant, Owner (email or ownership type).
did	No	String	The DID number filter (fuzzy match on default display format or E.164).
didName	No	String	The DID name filter (fuzzy match).
numberType	No	String	The number type filter (fuzzy match).
assignedTrunkIds	No	Array<String>	The list of assigned trunk IDs to filter by (exact match, returns if any one matches).
assignedReseller	No	String	The Assigned Reseller filter (fuzzy match).
assignedTenant	No	String	The Assigned Tenant filter (fuzzy match).
owner	No	String	The Owner filter (matches owner email or ownership type by word segmentation with AND logic, case-insensitive; supports pasting display text such as `Reseller / xx@xx.com`).
creator	No	String	The Creator filter (fuzzy match on email).
remark	No	String	The Remark filter (fuzzy match).
assignedStatus	No	String	The assignment status filter: - ASSIGNED_STATUS_AVAILABLE: Available (created by Admin, not assigned to Reseller or Tenant). - ASSIGNED_STATUS_RESERVED: Reserved (assigned to Reseller). - ASSIGNED_STATUS_IN_USE: In use (assigned to Tenant).
sorts	No	Array<SortItem>	The sort conditions. Supported fields: `did`, `did_name`, `number_type`, `created_at`, `updated_at`.

SortItem


Parameter	Required	Type	Description
direction	No	String	The sort direction: `asc` or `desc`.
property	No	String	The name of the field to sort by.

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<SearchResult>	The paginated DID list.

SearchResult


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	Integer	The total number of matching records.
results	Array<DIDListItem>	The list of DIDs on the current page.

DIDListItem


Parameter	Type	Description
id	String	The DID ID.
didName	String	The DID name (displayed as `-` if empty).
defaultDisplayFormat	String	The default display format, for example `(261) 111-1127`.
numberType	String	The number type, for example `Local`, `Mobile`.
assignedTrunks	Array<AssignedTrunk>	The list of assigned trunks.
ownerDisplay	String	The owner display text (format: `Admin (email)` or `Reseller (email)`).
assignedResellerName	String	The reseller name (empty = My Tenant).
assignedTenantName	String	The tenant name (empty = Unassigned).
creator	String	The creator's username (from a `tb_user` join query).
remark	String	The remark.
createdAt	String	The creation time as a millisecond timestamp.
updatedAt	String	The update time as a millisecond timestamp.
ownerType	String	The ownership type (`admin` or `reseller`).
callHandling	String	The inbound call handling attribution (4 fixed states): - `-`: Not assigned to a tenant. - Unassigned: Assigned but no destination configured. - Direct Assignment: Direct assignment. - Inbound Route: Matched an inbound route.
destination	Object<Destination>	The call destination details.
didE164	String	The full E.164 format number.
countryCode	String	The ISO 3166-1 country code.
assignedStatus	String	The assignment status: - ASSIGNED_STATUS_AVAILABLE: Available. - ASSIGNED_STATUS_RESERVED: Reserved. - ASSIGNED_STATUS_IN_USE: In use.

AssignedTrunk


Parameter	Type	Description
id	String	The trunk ID.
name	String	The trunk name.
provider	String	The provider name.
displayText	String	The display text (format: Trunk Name - Provider Name).

Destination


Parameter	Type	Description
destinationType	String	The destination type: - USER: The extension user. - QUEUE: The queue. - IVR: The IVR. - RING_GROUP: The ring group. - AI_ROUTE: The AI receptionist.
destinationNumber	String	The destination number (for example extension number 1001; populated on a direct match).
destinationName	String	The destination name (populated on a direct match, concatenated according to viewer preferences).
routeName	String	The name of the matched inbound route (populated when an inbound route matches; empty on a direct match).
destinationId	String	The destination resource ID (populated on a direct match; returns 0 for inbound or unassigned).
timeConditionEnabled	Boolean	Whether time conditions are enabled for the destination (reads the entity's `TBREnabled` for IVR, queue, ring group, and inbound route; `false` for user and AI route).

Example

Request example

POST /uc-cconfig/api/v1/dids/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDc0ODc3OCwiaWF0IjoxNzkwNzI3MTc4LCJqdGkiOiJlZTQwMmQzNC03YjQ5LTQ4YmUtYWM0Yi02NDMyMDkzZDBhZDQiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.mq9d6uoAWxFZ4LJQSdWtSfp3jWK2-5-Nq-YJqA2p5qyN7ClRmxrZdeA9WolJsO7ONIKZfhqfjEYyCZeepU5iYJvShEJX2XlGrSfu9bkX8bO9byMq9pH_fxHmAyVnfu1R6Uy9c4YvQS6QW5iZmnTOjnV7Tzp0HarGi-D6rIzRYhm87ctWoNwtrDrFjB6WxZl-la1_NIOx9_LLlvewB-xoSxJRxXC7xOP-Xy5GC7amqytS8nplu0GwqmHu8PxEkJ3LeDWrSPqkLQqULdyzfsC0e2iJthEvLX7STMH7jSvLnjw7TH7cBLPsg-NdurAZ31TC3H5q4oKGKL0WBAJmrnAcQg
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 20,
  "keyword": "doc-test"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 20,
    "pageNumber": 1,
    "count": 1,
    "results": [
      {
        "id": "363479608634970112",
        "didName": "doc-test-did-01",
        "defaultDisplayFormat": "(999) 000-0001",
        "numberType": "Local",
        "assignedTrunks": [
          {
            "id": "343306926664237056",
            "name": "222EVE",
            "provider": "general",
            "displayText": "222EVE - general"
          }
        ],
        "ownerDisplay": "Admin (distributorexample@outlook.com)",
        "assignedResellerName": "",
        "assignedTenantName": "",
        "creator": "distributorexample@outlook.com",
        "remark": "doc-test-renamed",
        "createdAt": "1790644891000",
        "updatedAt": "1790644891000",
        "ownerType": "admin",
        "callHandling": "Unassigned",
        "destination": {
          "destinationType": "USER",
          "destinationNumber": "1001",
          "destinationName": "1001",
          "routeName": "",
          "destinationId": "0",
          "timeConditionEnabled": false
        },
        "didE164": "+19990000001",
        "countryCode": "US",
        "assignedStatus": "ASSIGNED_STATUS_IN_USE"
      }
    ]
  },
  "requestId": "e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3",
  "code": "200",
  "message": "SUCCESS"
}