Update My Function Keys

Reorders or updates the function key list of the current user.

Request URL

PUT {base_url}/uc-cconfig/api/v1/users/record-function-keys

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
functionKeys No Object<Function_Key_List> The function key list input. Omitting this parameter keeps the original list, and an empty list clears all keys.
Function_Key_List
Parameter Required Type Description
items No Array<Function_Key_Item> The list of function keys.
Function_Key_Item
Parameter Type Description
keyType String

The type of the function key:

Valid value:

  • n_a: A placeholder key, which has no actual function.
  • line: An account key, which is valid only for IP phones.
  • blf: A BLF key, which monitors the extension status of the monitored object.
  • speed_dial: A speed dial key, which quickly dials a specified number.
  • check_voicemail: A voicemail key.
  • park_retrieve: A park/retrieve key.
  • intercom: An intercom key.
  • dtmf: A DTMF key.
  • agent_login_logout: An agent login/logout key.
  • agent_pause_unpause: An agent pause/unpause key.
  • call_forward: A call forward key, which is valid only for IP phones.
  • action_url: An Action URL key, which is valid only for IP phones.
value String The value of the function key. The maximum length is 128 characters.
label String The display label of the function key. The maximum length is 128 characters.
isDefaultLabel Integer

Whether the label is the default label:

Valid value:

  • 0: Generated by the system.
  • 1: Customized by the user.
valueType String

The value type of the function key:

Valid value:

  • extension: The BLF monitored object is an extension.
  • feature_code: The BLF monitored object is a feature code.

An empty string indicates that the value type is not specified.

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<Function_Key_List_Result> The updated function key list.
Function_Key_List_Result
Parameter Type Description
functionKeys Array<Function_Key_Item> The updated function key list of the user.

Example

Request example

PUT /uc-cconfig/api/v1/users/record-function-keys HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyMTI4NiwiaWF0IjoxNzkzNTk5Njg2LCJqdGkiOiI3ZmM2ZmZiMC02NTBlLTQyZjYtOGJmOC0wZmE3ZWFmYjY3YjgiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImE0NDVkYjRhLTNkMjEtNGRlMi1hYmI2LWEwZmY5NjNmZjY3OCIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.Fetld7VQ6Vu5239kNE05a_-VVdNIHOHwZ3v-GTUmh47xxyKXPtbihGCEMR8-PDS2w1RzMGQKD-3ehpmojGyyh5GaaWl4yBnWg7zZlxrYciXtqsuCAcKre4fr_UViOQAVNkj3huuKEtUUjQtbbsb8WOv6w2rhfKJthJma4XRwoA3iDR8Snr5wT5cUa3kVEomSf1VQtAIMyEWrPXlt5kSPX11ZK3lB-JZtstKa84MIpgrHMlthJDiyYbOlRKDcq570kDQI4BrYCX1sIjACnUHiyvd_7qxK9rNcihnXgbTOC2sEvEJJDwdudoNBENZgH-tKV7wR_8jpaKxa6Djkf_x1sA
x-tenant-code: jint
Content-Type: application/json
{
  "functionKeys": {
    "items": [
      {
        "keyType": "blf",
        "value": "1001",
        "label": "BLF 1001",
        "isDefaultLabel": 1,
        "valueType": "extension"
      }
    ]
  }
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "c9ffad9ba1f8fc6938d938b75ca7d2f3",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "functionKeys": [
      {
        "keyType": "blf",
        "value": "1001",
        "label": "BLF 1001",
        "isDefaultLabel": 1,
        "valueType": "extension"
      }
    ]
  }
}