Edit Feature Code Settings

Edit feature code settings.

Request URL

POST {base_url}/{api_path}/feature_code/update?access_token={access_token}

Request parameters

Parameter Required Type Description
digit_timeout No Integer The timeout (in milliseconds) to input the next digit when dialing feature code.
enb_auto_record No Integer Whether to enable the feature code for pausing or resuming recording during a call.

Valid value:

  • 0: Disable
  • 1: Enable
auto_record No String The feature code for pausing or resuming recording during a call.
Note: The maximum character length is 7.
enb_vm No Integer Whether to enable the feature code for checking voicemail and subscribing voicemail status.

Valid value:

  • 0: Disable
  • 1: Enable
voicemail No String The feature code for checking voicemail and subscribing voicemail status.
Note: The maximum character length is 7.
enb_leave_vm_for_ext No Integer Whether to enable the feature code for leaving a voicemail for extension/group voicemail.

Valid value:

  • 0: Disable
  • 1: Enable
leave_vm_for_ext No String The feature code for leaving a voicemail for extension/group voicemail.
Note: The maximum character length is 7.
enb_attend_transfer No Integer Whether to enable the feature code for attended transfer.

Valid value:

  • 0: Disable
  • 1: Enable
attend_transfer No String The feature code for attended transfer.
Note: The maximum character length is 7.
enb_blind_transfer No Integer Whether to enable the feature code for blind transfer.

Valid value:

  • 0: Disable
  • 1: Enable
blind_transfer No String The feature code for blind transfer.
Note: The maximum character length is 7.
transfer_digit_timeout No Integer The timeout (in seconds) to input the next digit when transferring a call.
Note: An integer from 3 to 8 is allowed.
attend_transfer_timeout No Integer The the ring timeout (in seconds) for an extension to pick up an attended transfer call.
enb_pickup No Integer Whether to enable the feature code for picking up the ringing call of a group member.

Valid value:

  • 0: Disable
  • 1: Enable
pickup No String The feature code for picking up the ringing call of a group member.
Note: The maximum character length is 7.
enb_ext_pickup No Integer Whether to enable the feature code for picking up the ringing call of an extension.

Valid value:

  • 0: Disable
  • 1: Enable
ext_pickup No String The feature code for picking up the ringing call of an extension.
Note: The maximum character length is 7.
enb_park No Integer Whether to enable the feature code for call parking.

Valid value:

  • 0: Disable
  • 1: Enable
park No String The feature code for call parking.
Note: The maximum character length is 7.
enb_park_on_slots No Integer Whether to enable the feature code for directed call parking.

Valid value:

  • 0: Disable
  • 1: Enable
park_on_slots No String The feature code for directed call parking.
Note: The maximum character length is 7.
park_start No String The start number of the parking number range.
Note: The maximum character length is 7.
park_end No String The end number of the parking number range.
Note: The maximum character length is 7.
park_timeout No Integer The timeout (in seconds) to retrieve a parked call.
park_timeout_dest No String The type of the destination for call parking timeout.

Valid value:

  • original: Call parking initiator
  • extension: Extension number
  • ext_vm: Extension voicemail
  • external_num: External number
  • group_vm: Group voicemail
  • call_flow: Call flow
  • end_call: End the call
  • ivr: IVR
  • ring_group: Ring group
  • queue: Queue
  • play_greeting: Play prompt and end the call
park_timeout_dest_value No String The value of the destination for call parking timeout.
Note: The maximum character length is 255.
park_timeout_dest_prefix No String The prefix of the destination for call parking timeout.
Note:
  • If park_timeout_dest is set to external_num, this parameter indicates the prefix of outbound rout.
  • If park_timeout_dest is set to play_greeting, this parameter indicates the prompt play count.
enb_paging No Integer Whether to enable the feature code for placing an intercom call to an extension.

Valid value:

  • 0: Disable
  • 1: Enable
paging No String The feature code for placing an intercom call to an extension.
Note: The maximum character length is 7.
enb_queue_login_logout No Integer Whether to enable the feature code for logging in to or logging out of a queue.

Valid value:

  • 0: Disable
  • 1: Enable
queue_login_logout No String The feature code for logging in to or logging out of a queue.
Note: The maximum character length is 7.
enb_queue_pause_unpause No Integer Whether to enable the feature code for pausing or resuming receiving calls from a queue.

Valid value:

  • 0: Disable
  • 1: Enable
queue_pause_unpause No String The feature code for pausing or resuming receiving calls from a queue.
Note: The maximum character length is 7.
enb_listen No Integer Whether to enable the feature code for listening to an extension call without talking with any party.

Valid value:

  • 0: Disable
  • 1: Enable
listen No String The feature code for listening to an extension call without talking with any party.
Note: The maximum character length is 7.
listen_permission_ext_list No Array<Listen_Permission> The list of extensions and extension groups that are allowed to monitor calls (in the Listen mode).
enb_whisper No Integer Whether to enable the feature code for listening to an extension call and talking to the monitored extension without being heard by the other party.

Valid value:

  • 0: Disable
  • 1: Enable
whisper No String The feature code for listening to an extension call and talking to the monitored extension without being heard by the other party.
Note: The maximum character length is 7.
whisper_permission_ext_list No Array<Whisper_Permission> The list of extensions and extension groups that are allowed to monitor calls (in the Whisper mode).
enb_barge_in No Integer Whether to enable the feature code for listening to an extension call and talking with both parties.

Valid value:

  • 0: Disable
  • 1: Enable
barge_in No String The feature code for listening to an extension call and talking with both parties.
Note: The maximum character length is 7.
barge_in_permission_ext_list No Array<Barge_in_Permission> The list of extensions and extension groups that are allowed to monitor calls (in the Barge-in mode).
enb_speed_dial No Integer Whether to enable the feature code for speed dial prefix.

Valid value:

  • 0: Disable
  • 1: Enable
speed_dial No String The feature code for speed dial prefix.
Note: The maximum character length is 7.
enb_office_time No Integer Whether to enable the feature code for overriding time condition for the Business Hours and Holidays configured in system's default time zone.

Valid value:

  • 0: Disable
  • 1: Enable
office_time No String The feature code for overriding time condition for the Business Hours and Holidays configured in system's default time zone.
Note: The maximum character length is 7.
office_time_permit_list No Array<Office_Time_Permission> The list of extensions and extension groups that are allowed to override time condition for the Business Hours and Holidays configured in system's default time zone.
enb_presence_available No Integer Whether to enable the feature code for changing extension presence status to "Available".

Valid value:

  • 0: Disable
  • 1: Enable
presence_available No String The feature code for changing extension presence status to "Available".
Note: The maximum character length is 7.
enb_presence_away No Integer Whether to enable the feature code for changing extension presence status to "Away".

Valid value:

  • 0: Disable
  • 1: Enable
presence_away No String The feature code for changing extension presence status to "Away".
Note: The maximum character length is 7.
enb_presence_do_not_disturb No Integer Whether to enable the feature code for changing extension presence status to "Do Not Disturb".

Valid value:

  • 0: Disable
  • 1: Enable
presence_do_not_disturb No String The feature code for changing extension presence status to "Do Not Disturb".
Note: The maximum character length is 7.
enb_presence_lunch_break No Integer Whether to enable the feature code for changing extension presence status to "Lunch Break".

Valid value:

  • 0: Disable
  • 1: Enable
presence_lunch_break No String The feature code for changing extension presence status to "Lunch Break".
Note: The maximum character length is 7.
enb_presence_business_trip No Integer Whether to enable the feature code for changing extension presence status to "Business Trip".

Valid value:

  • 0: Disable
  • 1: Enable
presence_business_trip No String The feature code for changing extension presence status to "Business Trip".
Note: The maximum character length is 7.
enb_presence_off_work No Integer Whether to enable the feature code for changing extension presence status to "Off Work".

Valid value:

  • 0: Disable
  • 1: Enable
presence_off_work No String The feature code for changing extension presence status to "Off Work".
Note: The maximum character length is 7.
enb_inbound_route No Integer Whether to enable the feature code for switching the custom time condition of inbound routes.

Valid value:

  • 0: Disable
  • 1: Enable
inbound_route_code No String The feature code for switching the custom time condition of inbound routes.
Note: The maximum character length is 7.
inbound_route_allow_ext_list No Array<Switch_Time_Condition_Permission> The list of extensions and extension groups that are allowed to switch the custom time condition of inbound routes.
enable_always_keep_status No Integer Whether to enable keeping the status after users switched the PBX's Business Hours status or dialed a feature code to switch the time condition of an inbound route.

Valid value:

  • 0: Disable
  • 1: Enable
enb_enable_forward_all_calls No Integer Whether to enable the feature code for forwarding all calls to extension voicemail or a specific extension number.

Valid value:

  • 0: Disable
  • 1: Enable
enable_forward_all_calls No String The feature code for forwarding all calls to extension voicemail or a specific extension number.
Note: The maximum character length is 7.
enb_disable_forward_all_calls No Integer Whether to enable the feature code for disabling the automatic call forwarding of all calls.

Valid value:

  • 0: Disable
  • 1: Enable
disable_forward_all_calls No String The feature code for disabling the automatic call forwarding of all calls.
Note: The maximum character length is 7.
enb_enable_forward_when_busy No Integer Whether to enable the feature code for forwarding calls to extension voicemail or a specific extension number when busy.

Valid value:

  • 0: Disable
  • 1: Enable
enable_forward_when_busy No String The feature code for forwarding calls to extension voicemail or a specific extension number when busy.
Note: The maximum character length is 7.
enb_disable_forward_when_busy No Integer Whether to enable the feature code for disabling the automatic call forwarding when busy.

Valid value:

  • 0: Disable
  • 1: Enable
disable_forward_when_busy No String The feature code for disabling the automatic call forwarding when busy.
Note: The maximum character length is 7.
enb_enable_forward_no_answer No Integer Whether to enable the feature code for forwarding no-answered calls to extension voicemail or a specific extension number.

Valid value:

  • 0: Disable
  • 1: Enable
enable_forward_no_answer No String The feature code for forwarding no-answered calls to extension voicemail or a specific extension number.
Note: The maximum character length is 7.
enb_disable_forward_no_answer No Integer Whether to enable the feature code for disabling the automatic call forwarding of no-answered calls.

Valid value:

  • 0: Disable
  • 1: Enable
disable_forward_no_answer No String The feature code for disabling the automatic call forwarding of no-answered calls.
Note: The maximum character length is 7.
enb_call_flip No Integer Whether to enable the feature code for flipping an active call from current device to another device.

Valid value:

  • 0: Disable
  • 1: Enable
call_flip No String The feature code for flipping an active call from current device to another device.
Note: The maximum character length is 7.
pause_reason_list No Array<Pause_Reason> The list of pause reasons and the corresponding feature codes.
enb_guest_in No Integer Whether to enable the feature code for registering an extension to a hot desking phone.

Valid value:

  • 0: Disable
  • 1: Enable
guest_in No String The feature code for registering an extension to a hot desking phone.
Note: The maximum character length is 7.
enb_guest_out No Integer Whether to enable the feature code for de-registering an extension to a hot desking phone.

Valid value:

  • 0: Disable
  • 1: Enable
guest_out No String The feature code for de-registering an extension from a hot desking phone.
Note: The maximum character length is 7.
enb_blind_transfer_recall No Integer Whether to enable the call bounce back to the initiator is enabled for blind transfers and semi-attended transfers when the transferred destination does not answer.

Valid value:

  • 0: Disable
  • 1: Enable
enb_enable_boss_secretary No Integer Whether to enable the feature code for enabling Boss-Secretary feature.

Valid value:

  • 0: Disable
  • 1: Enable
enable_boss_secretary No String The feature code for enabling Boss-Secretary feature.
Note: The maximum character length is 7.
enb_disabled_boss_secretary No Integer Whether to enable the feature code for disabling Boss-Secretary feature.

Valid value:

  • 0: Disable
  • 1: Enable
disabled_boss_secretary No String The feature code for disabling Boss-Secretary feature.
Note: The maximum character length is 7.
enb_pms_minibar No Integer Whether to enable the feature code for posting minibar charges.

Valid value:

  • 0: Disable
  • 1: Enable
pms_minibar No String The feature code for posting minibar charges.
Note: The maximum character length is 7.
enb_pms_makeup_room No Integer Whether to enable the feature code for updating the room status to "Dirty/Vacant".

Valid value:

  • 0: Disable
  • 1: Enable
pms_makeup_room No String The feature code for updating the room status to "Dirty/Vacant".
Note: The maximum character length is 7.
enb_enable_busy_camp_on No Integer Whether to enable the feature code for enabling Busy Camp-on.

Valid value:

  • 0: Disable
  • 1: Enable
enable_busy_camp_on No String The feature code for enabling Busy Camp-on.
Note: The maximum character length is 7.
enb_disable_busy_camp_on No Integer Whether to enable the feature code for disabling Busy Camp-on.

Valid value:

  • 0: Disable
  • 1: Enable
disable_busy_camp_on No String The feature code for disabling Busy Camp-on.
Note: The maximum character length is 7.
park_moh No String The global MoH playlist played when parking a number.

Valid value:

  • follow_system: Follow system setting (Set on PBX Settings > Voice Prompt > Prompt Preferences > Music on Hold).
  • none: No music.
  • Other value: The name of the MoH playlist.
    Note: You can query the name using Query MoH Playlists.
enb_call_force_drop No Integer Whether to enable the feature code for forcibly dropping the current call of a specified or monitored extension.

Valid value:

  • 0: Disable
  • 1: Enable
call_force_drop No String The feature code for forcibly dropping the current call of a specified or monitored extension.
Note: The maximum character length is 7.
call_force_drop_permission_ext_list No Array<CFD_Permission> The list of extensions and extension groups that are allowed to forcibly drop the current call of a specified or monitored extension.
blf_light_scheme No Integer The BLF light scheme.

Valid value:

  • 0: Show Red when in business hours/destination and Green when outside business hours/destination.
  • 1: Show Green when in business hours/destination and Red when outside business hours/destination.
enb_query_self_number No Integer Whether to enable the feature code for querying the extension number registered on the current endpoint.

Valid value:

  • 0: Disable
  • 1: Enable
query_self_number No String The feature code for querying the extension number registered on the current endpoint.
Note: The maximum character length is 7.
enb_query_number_call_back No Integer Whether to enable the PBX initiates a line detection call to the extension after the number query call is hung up.

Valid value:

  • 0: Disable
  • 1: Enable
enb_hotel_room_status No Integer Whether to enable the feature code for updating the hotel room status.

Valid value:

  • 0: Disable
  • 1: Enable
hotel_room_status No String The feature code for updating the hotel room status.
Note: The maximum character length is 7.
enb_update_cfw_dest No Integer Whether to enable changing the call forwarding destinations for specific extensions.

Valid value:

  • 0: Disable
  • 1: Enable
cfw_permission_list No Array<CFW_Permission> The list of extensions and extension groups that are allowed or disallowed to change the call forwarding destinations for specific extensions.
enb_queue_login_all No Integer Whether to enable the feature code for logging in to all assigned queues.

Valid value:

  • 0: Disable
  • 1: Enable
queue_login_all No String The feature code for logging in to all assigned queues.
Note: The maximum character length is 7.
enb_queue_logout_all No Integer Whether to enable the feature code for logging out of all assigned queues.

Valid value:

  • 0: Disable
  • 1: Enable
queue_logout_all No String The feature code for logging out of all assigned queues.
Note: The maximum character length is 7.
enb_queue_login_last No Integer Whether to enable the feature code for logging in to all previously logged-in queues.

Valid value:

  • 0: Disable
  • 1: Enable
queue_login_last No String The feature code for logging in to all previously logged-in queues.
Note: The maximum character length is 7.
enb_ext_set_dod No Integer Whether to enable the feature code for setting a default DOD or calling with a specified DOD.

Valid value:

  • 0: Disable
  • 1: Enable
ext_set_dod No String The feature code for setting a default DOD or calling with a specified DOD.
Note: The maximum character length is 7.
enb_park_group No Integer Whether to enable grouping parking numbers and specifying a MoH playlist for each group.

Valid value:

  • 0: Disable
  • 1: Enable
park_group_list No Array<Parking_Group> The list of parking number groups.
Permission_List
Parameter Required Type Description
id Yes Integer The ID of the extension or extension group.
Note: You can query the ID using Get Menu Options(menu= extension or ext_group).
type Yes String The type of target object.

Valid value:

  • extension: Extension
  • ext_group: Extension Group
Pause_Reason
Parameter Required Type Description
code No String The pause feature code.
Note: The maximum character length is 7.
reason No String The pause reasons.
Note: The maximum character length is 68.
CFW_Permission
Parameter Required Type Description
active_list No Array<Active_List> The list of extensions and extension groups that are allowed or disallowed to change the call forwarding destinations for specific extensions.
active_type No Integer The type of object that performs the operation.

Valid value:

  • 0: Specified extensions and extension groups
  • 1: All extensions and extension groups
select_type No Integer The permission type.

Valid value:

  • 0: Allow
  • 1: Disallow
passive_list No Array<Passive_List> The list of extensions and extension groups for which call forwarding destinations are allowed or disallowed to be changed.
Note: This parameter takes effect only when the passive_type is set to 4.
passive_type No Integer The type of object on which the operation is performed.

Valid value:

  • 0: Extensions and extension groups selected in the active_list
  • 1: All extensions and extension groups
  • 2: Extensions in the group specified in the active_list
  • 4: Manually specified extensions and extension groups
pos No Integer The priority of the permission entry in the list; the lower the value, the higher the priority.
Note: An integers greater than or equal to 0 is allowed.
deal_type No Integer The deal type.

Valid value:

  • 0: Extension or extension group
Parking_Group
Parameter Required Type Description
park_group_start Yes String The start parking number.
Note: The maximum character length is 7.
park_group_end Yes String The end parking number.
Note: The maximum character length is 7.
park_group_moh No String The MoH playlist for the parking number group.

Valid value:

  • park_global_moh: Follow global MoH playlist for parking numbers.
  • follow_system: Follow system setting (Set on PBX Settings > Voice Prompt > Prompt Preferences > Music on Hold).
  • none: No music.
  • Other value: The name of the MoH playlist.
    Note: You can query the name using Query MoH Playlists.

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

GET /openapi/v1.0/feature_code/get?access_token=9lpNw53mp6Wpubgy5h4oSAHauz0K83q9 HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "enb_auto_record":1
}

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "submsg": ""
}