Export Speed Dials

Exports speed dial mappings to a CSV file as an asynchronous task. Use the returned task ID to query the task progress and obtain the download URL of the generated file.

Request URL

POST {base_url}/uc-cconfig/api/v1/speed-dials/export

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 filter the mappings to export. The matching rule is the same as the one used by the Search Speed Dials interface. If not specified, all mappings are exported. Maximum 1024 characters.
ids No Array<String> The IDs of the mappings selected for export, up to 1024 IDs. When keyword is also specified, only the selected mappings within the filtered result are exported. Selections across pages are supported.
excludeIds No Array<String> The IDs to exclude from the export. Use this parameter when all mappings except the selected ones are exported.
sorts No Array<Sort_Condition> The sort conditions of the exported file. If not specified, the mappings are sorted by creation time in descending order.
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<Export_Result> The export result.
Export_Result
Parameter Type Description
taskId String The ID of the asynchronous export task. When the task completes, the download entry is available in business.resultRefs.

Example

Request example

POST /uc-cconfig/api/v1/speed-dials/export 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
{
  "ids": [
    "375819170839093248",
    "375819171325632512"
  ],
  "sorts": [
    {
      "property": "speed_dial_number",
      "direction": "asc"
    }
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "706edc03ea992be384aaf335e7c0db60",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "taskId": "375819236978122752"
  }
}