Search DIDs for Reports

Request URL

POST {base_url}/uc-cconfig/api/v1/reports/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
keyword	No	String	The keyword used to search for DIDs by E.164 number or name.
pageNumber	No	Integer	The page number to retrieve.
pageSize	No	Integer	The number of records to retrieve per page.

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<DID_Search_Result>	The search result of DIDs.

DID_Search_Result


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

DID_Option


Parameter	Type	Description
id	String	The ID of the DID.
didNumber	String	The number of the DID, 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, such as `Local` and `National`.

Example

Request example

POST /uc-cconfig/api/v1/reports/dids/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM3MTMxNSwiaWF0IjoxNzkzMzQ5NzE1LCJqdGkiOiIwNWExNDc5MS0xNGI3LTQ3MDUtYWZlYS1jMzhjYjk3NzM5N2QiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.yCJxwidp6iZtDeBDrxJ7TYfFgqHhVq0_179C39ekjtemXg82N9AIGVjokH00AHFJLUfLkzf-8-rQ7oxnHjlsmCbnB4MmuUBYs7mV5ZtRw0f3S2vH32lKflqw0cUjhVXnQfxqD5gtkH0z19kGnIwbxXa26mDLdjpqpIzmaC1V88sBjDeflA8Ty2W4tzggYoiTZwf52HGkSRaQ-t-hYqcw4JI8gy02Flew6VlWRQuM1BP8QORDKcasZGDQf5nBqLAaq8ez0pzuM0wZkeVNWI8nwonDWo04EiiTQaXsxZMJea7X5vvT_oSxMZi2Yp_zp6dZmpMmEg-lRCkZmZQce0gTbw
x-tenant-code: jint
Content-Type: application/json
{
  "pageNumber": 1,
  "pageSize": 5
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c7252b289d084088263465f136c548a5",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "pageSize": 5,
    "pageNumber": 1,
    "count": "80",
    "results": [
      {
        "id": "369376237366337536",
        "didNumber": "(02) 4302 3961",
        "didName": "",
        "numberType": "Local"
      },
      {
        "id": "369373007085363200",
        "didNumber": "02 1234 1678",
        "didName": "0是号码位",
        "numberType": "Local"
      },
      {
        "id": "369365658463428608",
        "didNumber": "(02) 4302 3962",
        "didName": "测试0是prefix的号",
        "numberType": "Local"
      },
      {
        "id": "367178921942994944",
        "didNumber": "364 726 328",
        "didName": "cc测试",
        "numberType": "Local"
      },
      {
        "id": "349095413464047636",
        "didNumber": "612 34 56 20",
        "didName": "啊哈哈哈",
        "numberType": "National"
      }
    ]
  }
}