Search Speed Dials

Searches speed dial mappings in the tenant and returns the results by page.

Request URL

POST {base_url}/uc-cconfig/api/v1/speed-dials/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 match the speed dial number, phone number, or remark. The three fields are matched with OR. If not specified, all mappings are returned. Maximum 1024 characters.
sorts No Array<Sort_Condition> The sort conditions. If not specified, the results are sorted by speed dial number in ascending order.
pageSize No Integer The number of records to retrieve per page.
pageNumber No Integer The page number to retrieve.
Sort_Condition
Parameter Required Type Description
property No String The field to sort by. Only speed_dial_number and created_at are supported. Other values return 400.
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.

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<Search_Result> The search result of speed dial mappings.
Search_Result
Parameter Type Description
results Array<Speed_Dial_Data> The list of speed dial mappings on the current page.
count String The total number of mappings that match the search conditions.
Speed_Dial_Data
Parameter Type Description
id String The ID of the speed dial mapping.
speedDialNumber String The speed dial number.
phoneNumber String The phone number.
remark String The remark. It is used as a fallback for the outgoing call display, and the contact name takes precedence.
createdAt String The time when the speed dial mapping was created, in Unix timestamp format (milliseconds).
updatedAt String The time when the speed dial mapping was last updated, in Unix timestamp format (milliseconds).

Example

Request example

POST /uc-cconfig/api/v1/speed-dials/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzY5MDk4NiwiaWF0IjoxNzkzNjY5Mzg2LCJqdGkiOiJjYzE1NjcwMC03ZTI1LTRlYjctOWM4Zi1lODY5ZTBkYjAxYTciLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.wxmbyBDFtsX0rqiS6qnlGlKTtUnqCmHdgnG7DIpLmIMrX5ZaHwSNt_87lMaGavVyvU80BD9GR6ZLSzYaKbb7ekTj-cdWgALmmUcWoOt1P_xAMWY54X31f3djW66NwY24dBIqwuD4Zajb6mOL_hZvMRhhk-brTg61k_FyVz5GSLmFp_jM2hCr4GCD8Me0rIST4-T7KsdhFxMLcq0fxfihfBDyej4Wd6dnkSMq78LgOIfuNMVMG9F6JYl18huJpkio8FcmJGP_jAG1pJjm9dnXSpuzqmoRjI3P7YxCYBxcFxxzplT4UatHKSJYLxUrE1e15qi8W8pAT-VRUE1E-CwiFg
x-tenant-code: jint
Content-Type: application/json
{
  "keyword": "doc-",
  "pageNumber": 1,
  "pageSize": 10,
  "sorts": [
    {
      "property": "speed_dial_number",
      "direction": "asc"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "1b7c94b536631f58328d593f5ad19b5b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "results": [
      {
        "id": "375818868660461568",
        "speedDialNumber": "*901",
        "phoneNumber": "1001",
        "remark": "doc-test",
        "createdAt": "1793669400665",
        "updatedAt": "1793669400665"
      },
      {
        "id": "375819170839093248",
        "speedDialNumber": "*911",
        "phoneNumber": "1003",
        "remark": "doc-updated",
        "createdAt": "1793669472710",
        "updatedAt": "1793669473051"
      },
      {
        "id": "375819171325632512",
        "speedDialNumber": "*912",
        "phoneNumber": "+8613800138000",
        "remark": "doc-speed-dial-b",
        "createdAt": "1793669472826",
        "updatedAt": "1793669472826"
      }
    ],
    "count": "3"
  }
}