Get My Function Keys

Retrieves the function key list and the feature codes of the current user.

Request URL

GET {base_url}/uc-cconfig/api/v1/users/my-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.

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<My_Function_Keys> The function key list and feature codes of the current user.
My_Function_Keys
Parameter Type Description
functionKeys Array<Function_Key_Item> The list of function keys of the current user.
featureCodes Object<Feature_Codes> The feature code configuration of the current user.
Function_Key_Item
Parameter Type Description
keyType String

The type of the function key:

  • n_a: A placeholder key, which has no actual function.
  • line: An account key, which is valid only for IP phones and is used to select an account or act as a line key.
  • blf: A BLF key, which monitors the extension status of the monitored object. valueType can be set to extension or feature_code.
  • speed_dial: A speed dial key, which quickly dials a specified number.
  • check_voicemail: A voicemail key, which accesses the voicemail menu of the current user or a specified extension.
  • park_retrieve: A park/retrieve key, which parks a call to a parking slot or retrieves a parked call.
  • intercom: An intercom key, which initiates an intercom call to a specified user.
  • dtmf: A DTMF key, which sends DTMF signals to the other party during a call.
  • agent_login_logout: An agent login/logout key, which sets the login or logout status of the user in a specified queue.
  • agent_pause_unpause: An agent pause/unpause key, which sets the pause or resume status of the user in a specified queue.
  • call_forward: A call forward key, which is valid only for IP phones and quickly sets the call forward switch of the phone.
  • action_url: An Action URL key, which is valid only for IP phones and sends an HTTP GET request to a specified URL from the phone.
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:

  • 0: The label is generated by the system.
  • 1: The label is customized by the user.
valueType String

The value type of the function key:

  • extension: The BLF monitored object is an extension.
  • feature_code: The BLF monitored object is a feature code. The maximum length is 32 characters.

An empty string indicates that the value type is not specified.
Feature_Codes
Parameter Type Description
recordingCode String The feature code that toggles call recording.
recordingEnabled Boolean

Whether the recording feature code is enabled.

  • true: Enabled.
  • false: Disabled.
voicemailCheckCode String The feature code that accesses the voicemail menu.
voicemailCheckEnabled Boolean

Whether the voicemail check feature code is enabled.

  • true: Enabled.
  • false: Disabled.
voicemailLeaveCode String The feature code that leaves a voicemail.
voicemailLeaveEnabled Boolean

Whether the voicemail leave feature code is enabled.

  • true: Enabled.
  • false: Disabled.
transferBlindCode String The feature code for blind transfer.
transferBlindEnabled Boolean

Whether the blind transfer feature code is enabled.

  • true: Enabled.
  • false: Disabled.
transferAttendedCode String The feature code for attended transfer.
transferAttendedEnabled Boolean

Whether the attended transfer feature code is enabled.

  • true: Enabled.
  • false: Disabled.
transferDigitTimeout Integer The digit timeout for transfer, in seconds.
forwardAlwaysOnCode String The feature code that enables call forward always.
forwardAlwaysOnEnabled Boolean

Whether the forward always on feature code is enabled.

  • true: Enabled.
  • false: Disabled.
forwardAlwaysOffCode String The feature code that disables call forward always.
forwardAlwaysOffEnabled Boolean

Whether the forward always off feature code is enabled.

  • true: Enabled.
  • false: Disabled.
forwardBusyOnCode String The feature code that enables call forward when busy.
forwardBusyOnEnabled Boolean

Whether the forward busy on feature code is enabled.

  • true: Enabled.
  • false: Disabled.
forwardBusyOffCode String The feature code that disables call forward when busy.
forwardBusyOffEnabled Boolean

Whether the forward busy off feature code is enabled.

  • true: Enabled.
  • false: Disabled.
forwardNoAnswerOnCode String The feature code that enables call forward on no answer.
forwardNoAnswerOnEnabled Boolean

Whether the forward no answer on feature code is enabled.

  • true: Enabled.
  • false: Disabled.
forwardNoAnswerOffCode String The feature code that disables call forward on no answer.
forwardNoAnswerOffEnabled Boolean

Whether the forward no answer off feature code is enabled.

  • true: Enabled.
  • false: Disabled.
pickupCode String The feature code for call pickup.
pickupEnabled Boolean

Whether the pickup feature code is enabled.

  • true: Enabled.
  • false: Disabled.
parkingRandomCode String The feature code for random parking.
parkingRandomEnabled Boolean

Whether the random parking feature code is enabled.

  • true: Enabled.
  • false: Disabled.
parkingDirectedCode String The feature code for directed parking.
parkingDirectedEnabled Boolean

Whether the directed parking feature code is enabled.

  • true: Enabled.
  • false: Disabled.
parkingTimeout Integer The parking timeout, in seconds.
parkingTimeoutDestination Object<Feature_Destination> The destination when the parking times out.
intercomCode String The feature code for intercom.
intercomEnabled Boolean

Whether the intercom feature code is enabled.

  • true: Enabled.
  • false: Disabled.
queueLoginCode String The feature code that logs the user in to a queue.
queueLoginEnabled Boolean

Whether the queue login feature code is enabled.

  • true: Enabled.
  • false: Disabled.
queuePauseCode String The feature code that pauses the user in a queue.
queuePauseEnabled Boolean

Whether the queue pause feature code is enabled.

  • true: Enabled.
  • false: Disabled.
queueLoginAllCode String The feature code that logs the user in to all queues.
queueLoginAllEnabled Boolean

Whether the queue login all feature code is enabled.

  • true: Enabled.
  • false: Disabled.
queueLogoutAllCode String The feature code that logs the user out of all queues.
queueLogoutAllEnabled Boolean

Whether the queue logout all feature code is enabled.

  • true: Enabled.
  • false: Disabled.
queueLoginLastCode String The feature code that logs the user in to the last queue.
queueLoginLastEnabled Boolean

Whether the queue login last feature code is enabled.

  • true: Enabled.
  • false: Disabled.
digitTimeout Integer The digit timeout, in milliseconds.
pauseReasons Array<String> The list of pause reasons. This parameter is null when no pause reason is configured.
parkingRange Object The parking range. This parameter is null when no parking range is configured.
parkingMoh String The ID of the music-on-hold playlist used for parking.
statusSwitchCodePrefix String The prefix of the status switch feature code.
statusSwitchCodePrefixEnabled Boolean

Whether the status switch feature code is enabled.

  • true: Enabled.
  • false: Disabled.
statusSwitchPermissionAllUsers Boolean

Whether all users can switch the presence status.

  • true: All users.
  • false: Only the users in statusSwitchPermissionUserIds.
statusSwitchPermissionUserIds Array<String> The list of users that can switch the presence status.
keepStatusAfterSwitching Boolean

Whether to keep the presence status after switching.

  • true: Keep.
  • false: Do not keep.
businessHoursBlfColor String The BLF color during business hours.
speedDialPrefixCode String The prefix of the speed dial feature code.
Feature_Destination
Parameter Type Description
type String The type of the destination.
value String The value of the destination.
prefix String The prefix of the destination.

Example

Request example

GET /uc-cconfig/api/v1/users/my-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

Response example

HTTP/1.1 200 OK
{
  "requestId": "9673afef061f8725c79660521543041d",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "functionKeys": [
      {
        "keyType": "park_retrieve",
        "value": "6000",
        "label": "Park - 6000",
        "isDefaultLabel": 0,
        "valueType": "extension"
      },
      {
        "keyType": "intercom",
        "value": "1001",
        "label": "INT - Terrell Smith",
        "isDefaultLabel": 0,
        "valueType": "extension"
      },
      {
        "keyType": "agent_login_logout",
        "value": "6400",
        "label": "Q: Login/Logout",
        "isDefaultLabel": 0,
        "valueType": "extension"
      },
      {
        "keyType": "agent_pause_unpause",
        "value": "6401",
        "label": "Q: Pause/Unpause",
        "isDefaultLabel": 0,
        "valueType": "extension"
      },
      {
        "keyType": "blf",
        "value": "1002",
        "label": "Philip Huff",
        "isDefaultLabel": 0,
        "valueType": "extension"
      }
    ],
    "featureCodes": {
      "recordingCode": "*1",
      "recordingEnabled": true,
      "voicemailCheckCode": "*2",
      "voicemailCheckEnabled": true,
      "voicemailLeaveCode": "*12",
      "voicemailLeaveEnabled": true,
      "transferBlindCode": "*03",
      "transferBlindEnabled": true,
      "transferAttendedCode": "*3",
      "transferAttendedEnabled": true,
      "transferDigitTimeout": 5,
      "forwardAlwaysOnCode": "*31",
      "forwardAlwaysOnEnabled": true,
      "forwardAlwaysOffCode": "*031",
      "forwardAlwaysOffEnabled": true,
      "forwardBusyOnCode": "*32",
      "forwardBusyOnEnabled": true,
      "forwardBusyOffCode": "*032",
      "forwardBusyOffEnabled": true,
      "forwardNoAnswerOnCode": "*33",
      "forwardNoAnswerOnEnabled": true,
      "forwardNoAnswerOffCode": "*033",
      "forwardNoAnswerOffEnabled": true,
      "pickupCode": "*04",
      "pickupEnabled": true,
      "parkingRandomCode": "*5",
      "parkingRandomEnabled": false,
      "parkingDirectedCode": "*05",
      "parkingDirectedEnabled": true,
      "parkingTimeout": 30,
      "parkingTimeoutDestination": {
        "type": "INITIATOR",
        "value": "",
        "prefix": ""
      },
      "intercomCode": "*6",
      "intercomEnabled": true,
      "queueLoginCode": "*7",
      "queueLoginEnabled": true,
      "queuePauseCode": "*07",
      "queuePauseEnabled": true,
      "queueLoginAllCode": "*77",
      "queueLoginAllEnabled": true,
      "queueLogoutAllCode": "*077",
      "queueLogoutAllEnabled": true,
      "queueLoginLastCode": "*78",
      "queueLoginLastEnabled": true,
      "digitTimeout": 4000,
      "pauseReasons": null,
      "parkingRange": null,
      "parkingMoh": "338596681041158144",
      "statusSwitchCodePrefix": "*99",
      "statusSwitchCodePrefixEnabled": true,
      "statusSwitchPermissionAllUsers": true,
      "statusSwitchPermissionUserIds": [],
      "keepStatusAfterSwitching": false,
      "businessHoursBlfColor": "RED",
      "speedDialPrefixCode": "*89",
      "speedDialPrefixEnabled": true
    },
    "rows": 10
  }
}
Note:

The response is condensed.