Get Feature Code Setting

Retrieve the current feature code settings for a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/feature-codes

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<Feature_Code_Setting> The feature code settings.
Feature_Code_Setting
Parameter Type Description
digitTimeout Integer The maximum time the system waits for the next digit input when dialing a feature code.
Recording
recordingEnabled Boolean Whether the call recording feature code is enabled.
  • true: Enabled
  • false: Disabled
recordingCode String The feature code for switching user's call recording status.
Voicemail
voicemailCheckEnabled Boolean Whether the feature code for checking voicemail messages is enabled.
  • true: Enabled
  • false: Disabled
voicemailCheckCode String The feature code for checking voicemail messages.
voicemailLeaveEnabled Boolean Whether the feature code for leaving a voicemail is enabled.
  • true: Enabled
  • false: Disabled
voicemailLeaveCode String The feature code for leaving a voicemail on a specified extension.
Call Transfer
transferAttendedEnabled Boolean Whether the attended transfer feature code is enabled.
  • true: Enabled
  • false: Disabled
transferAttendedCode String The attended transfer feature code.
transferBlindEnabled Boolean Whether the blind transfer feature code is enabled.
  • true: Enabled
  • false: Disabled
transferBlindCode String The blind transfer feature code.
transferDigitTimeout Integer

The maximum interval (in seconds) allowed between digits when transferring a call.

If the timeout is reached, the transfer will be canceled and the original call will be resumed.
Call Forwarding
forwardAlwaysOnEnabled Boolean Whether the Enable "Forward All Calls" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardAlwaysOnCode String The feature code for Enable "Forward All Calls".
forwardAlwaysOffEnabled Boolean Whether the Disable "Forward All Calls" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardAlwaysOffCode String The feature code for Disable "Forward All Calls".
forwardBusyOnEnabled Boolean Whether the Enable "Forward When Busy" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardBusyOnCode String The feature code for Enable "Forward When Busy".
forwardBusyOffEnabled Boolean Whether the Disable "Forward When Busy" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardBusyOffCode String The feature code for Disable "Forward When Busy".
forwardNoAnswerOnEnabled Boolean Whether the Enable "Forward No Answer" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardNoAnswerOnCode String The feature code for Enable "Forward No Answer".
forwardNoAnswerOffEnabled Boolean Whether the Disable "Forward No Answer" feature code is enabled.
  • true: Enabled
  • false: Disabled
forwardNoAnswerOffCode String The feature code for Disable "Forward No Answer".
Call Pickup
pickupEnabled Boolean Whether the extension call pickup feature code is enabled.
  • true: Enabled
  • false: Disabled
pickupCode String The extension call pickup feature code.
Call Parking
parkingRandomEnabled Boolean Whether the system park feature code is enabled.
  • true: Enabled
  • false: Disabled
parkingRandomCode String The system park feature code.
parkingDirectedEnabled Boolean Whether the directed call parking feature code is enabled.
  • true: Enabled
  • false: Disabled
parkingDirectedCode String The directed call parking feature code.
parkingRange Object<Parking_Range> The range of parking numbers.
parkingTimeout Integer The maximum time allowed before a parked call is retrieved.
parkingTimeoutDestination Object<Destination> The destination to which the call is routed when the parking timeout is reached.
parkingMoh String The music played when a call is parked.
Switch Business Hours and Holidays Status
statusSwitchCodePrefixEnabled Boolean Whether the Business Hours Status Switch Code prefix is enabled.
  • true: Enabled
  • false: Disabled
statusSwitchCodePrefix String The prefix of the Business Hours Status Switch Code.
statusSwitchPermissionAllUsers Boolean Whether all users can switch the business hours status.
  • true: All users can switch the business hours status.
  • false: Only specific users can switch the business hours status.
statusSwitchPermissionUserIds Array<String> The list of user IDs that can switch the business hours status.
keepStatusAfterSwitching Boolean Whether to keep the switched status.
  • true: The status is kept until the next manual switch.
  • false: The status is temporary and automatically resets in next hop of time condition.
Intercom
intercomEnabled Boolean Whether the intercom feature code is enabled.
  • true: Enabled
  • false: Disabled
intercomCode String The intercom feature code.
Queues
queueLoginEnabled Boolean Whether the queue login/logout feature code is enabled.
  • true: Enabled
  • false: Disabled
queueLoginCode String The feature code for logging in to or logging out of a queue.
queuePauseEnabled Boolean Whether the feature code for pausing or resuming queue calls is enabled.
  • true: Enabled
  • false: Disabled
queuePauseCode String The feature code for pausing or resuming receiving calls from a queue.
queueLoginAllEnabled Boolean Whether the feature code for logging in to all queues is enabled.
  • true: Enabled
  • false: Disabled
queueLoginAllCode String The feature code for logging in to all queues.
queueLogoutAllEnabled Boolean Whether the feature code for logging out of all queues is enabled.
  • true: Enabled
  • false: Disabled
queueLogoutAllCode String The feature code for logging out of all queues.
queueLoginLastEnabled Boolean Whether the feature code for logging in to the last queue is enabled.
  • true: Enabled
  • false: Disabled
queueLoginLastCode String The feature code for logging in to the last logged-in queue.
Pause Reason
pauseReasons Object<Pause_Reason> The list of queue pause reasons.
Destination
Parameter Type Description
type String The type of the destination to which the call is routed when the parking timeout is reached.
  • INITIATOR: Route the call back to the user who parked it.
  • USER: Route the call to a specific user.
  • USER_VOICEMAIL: Route the call to a specific user's voicemail.
  • EXTERNAL_NUMBER: Route the call to an external number.
value String The specific destination to which the call is routed when the parking timeout is reached.
prefix String The outbound call prefix.
Parking_Range
Parameter Type Description
rangeStart String The start number of the parking range.
rangeEnd String The end number of the parking range.
PauseReasonList
Parameter Type Description
items Array<Pause_Reason> The list of queue pause reasons.
Pause_Reason
Parameter Type Description
id String The unique identifier of the pause reason.
featureCode String The status code of the pause reason.
reason String The pause reason description.

Example

Request example

GET {base_url}/uc-cconfig/api/v1/feature-codes HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJyZWdpb24ta2V5LTEiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc4NjQ2NjA2MywiaWF0IjoxNzg2NDQ0NDYzLCJqdGkiOiIyNmU1MzM1Yi0yNGM2LTQyNmUtOWI3Zi1lZmRhNmIzMDdlMmMiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.MMsBmL-6NiGCfDRZ56IhiJa2FMSq02XDYNxK3DbT__7A40yyNpsL4CKwjGvCLNX9n5cDf_YtW2c1Tk0_VCYJ63RbhtWdgpBaf987vzqvV93rl6WffdrC_am2-uhxsp1RVpvWhVPujpDHtuCHQv_Fko4k4uCfEl-KLwUqVeqBhpdLiKJeP5Ss-LDCLDxmjC28URsmK7JB_c4TbraLvPo34pjASN5BEtlj2lVo9AE2JErty0e_l9L_7db2BlBDaQLeXlXH-JaUI9tymhQZd1FknyIyXsBKUeMLFGvVgtw3LCM6F9UeaoByayczEkPI9w-ipNEZpKHHxol8Du1S8wGcDg
x-tenant-code: jint
Response example
HTTP/1.1 200 OK
{
  "requestId": "c972a0e830ab3393ed423dc4d650b3c6",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "recordingCode": "*1",
    "recordingEnabled": true,
    "voicemailCheckCode": "*2",
    "voicemailCheckEnabled": true,
    "voicemailLeaveCode": "*12",
    "voicemailLeaveEnabled": true,
    "transferBlindCode": "*03",
    "transferBlindEnabled": true,
    "transferAttendedCode": "*3",
    "transferAttendedEnabled": true,
    "transferDigitTimeout": 8,
    "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": true,
    "parkingDirectedCode": "*05",
    "parkingDirectedEnabled": true,
    "parkingTimeout": 60,
    "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": {
      "items": [
        {
          "id": "338556457263144960",
          "featureCode": "*01",
          "reason": "Lunch"
        },
        {
          "id": "338556457267339264",
          "featureCode": "*02",
          "reason": "Break"
        },
        {
          "id": "338556457267339265",
          "featureCode": "*03",
          "reason": "Wrap-up"
        }
      ]
    },
    "parkingRange": {
      "rangeStart": "6000",
      "rangeEnd": "6099"
    },
    "parkingMoh": "follow_system",
    "statusSwitchCodePrefix": "*99",
    "statusSwitchCodePrefixEnabled": true,
    "statusSwitchPermissionAllUsers": false,
    "statusSwitchPermissionUserIds": [],
    "keepStatusAfterSwitching": false
  }
}