Update a Speed Dial

Updates a speed dial mapping. The update is partial: parameters that are not specified keep their current values. To clear the remark, pass an empty string.

Request URL

PUT {base_url}/uc-cconfig/api/v1/speed-dials/{id}

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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the speed dial mapping. You can obtain the ID using the Search Speed Dials interface.
Body parameters
Parameter Required Type Description
speedDialNumber No String The new speed dial number, 1 to 4 characters. Only digits and the asterisk are allowed. If not specified, the value is not updated.
phoneNumber No String The new phone number, 1 to 31 characters. Only digits, +, -, (, ), ., and spaces are allowed, and + can appear only at the beginning. If not specified, the value is not updated.
remark No String The new remark, up to 63 characters. If not specified, the value is not updated. An empty string clears the remark.

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<Speed_Dial_Data> The updated speed dial mapping.
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

PUT /uc-cconfig/api/v1/speed-dials/375819170839093248 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
{
  "speedDialNumber": "*911",
  "phoneNumber": "1003",
  "remark": "doc-updated"
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "e7e6e85285b8ec66b2f21e7de86c647b",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "375819170839093248",
    "speedDialNumber": "*911",
    "phoneNumber": "1003",
    "remark": "doc-updated",
    "createdAt": "1793669472710",
    "updatedAt": "1793669473051"
  }
}