Query Feature Code Settings

Query settings of all feature codes.

Request URL

GET {base_url}/{api_path}/feature_code/get?access_token={access_token}

Request parameters

No request parameters. Send the request URL directly to query the feature code settings.

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.
feature_code Object<Feature_Code_Setting> The settings of all feature codes.
Feature_Code_Setting
Parameter Type Description
digit_timeout Integer The timeout (in milliseconds) to input the next digit when dialing feature code.
enb_auto_record Integer Whether the feature code for pausing or resuming recording during a call is enabled.
  • 0: Disabled
  • 1: Enabled
auto_record String The feature code for pausing or resuming recording during a call.
enb_vm Integer Whether the feature code for checking voicemail and subscribing voicemail status is enabled.
  • 0: Disabled
  • 1: Enabled
voicemail String The feature code for checking voicemail and subscribing voicemail status.
enb_leave_vm_for_ext Integer Whether the feature code for leaving a voicemail for extension/group voicemail is enabled.
  • 0: Disabled
  • 1: Enabled
leave_vm_for_ext String The feature code for leaving a voicemail for extension/group voicemail.
enb_attend_transfer Integer Whether the feature code for attended transfer is enabled.
  • 0: Disabled
  • 1: Enabled
attend_transfer String The feature code for attended transfer.
enb_blind_transfer Integer Whether the feature code for blind transfer is enabled.
  • 0: Disabled
  • 1: Enabled
blind_transfer String The feature code for blind transfer.
transfer_digit_timeout Integer The timeout (in seconds) to input the next digit when transferring a call.
attend_transfer_timeout Integer The the ring timeout (in seconds) for an extension to pick up an attended transfer call.
enb_pickup Integer Whether the feature code for picking up the ringing call of a group member is enabled.
  • 0: Disabled
  • 1: Enabled
pickup String The feature code for picking up the ringing call of a group member.
enb_ext_pickup Integer Whether the feature code for picking up the ringing call of an extension is enabled.
  • 0: Disabled
  • 1: Enabled
ext_pickup String The feature code for picking up the ringing call of an extension.
enb_park Integer Whether the feature code for call parking is enabled.
  • 0: Disabled
  • 1: Enabled
park String The feature code for call parking.
enb_park_on_slots Integer Whether the feature code for directed call parking is enabled.
  • 0: Disabled
  • 1: Enabled
park_on_slots String The feature code for directed call parking.
park_start String The start number of the parking number range.
park_end String The end number of the parking number range.
park_timeout Integer The timeout (in seconds) to retrieve a parked call.
park_timeout_dest String The type of the destination for call parking timeout.
  • 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 String The value of the destination for call parking timeout.
park_timeout_dest_prefix String The prefix of the destination for call parking timeout.
Note:
  • If the value of park_timeout_dest is external_num, this parameter indicates the prefix of outbound rout.
  • If the value of park_timeout_dest is play_greeting, this parameter indicates the prompt play count.
enb_paging Integer Whether the feature code for placing an intercom call to an extension is enabled.
  • 0: Disabled
  • 1: Enabled
paging String The feature code for placing an intercom call to an extension.
enb_queue_login_logout Integer Whether the feature code for logging in to or logging out of a queue is enabled.
  • 0: Disabled
  • 1: Enabled
queue_login_logout String The feature code for logging in to or logging out of a queue.
enb_queue_pause_unpause Integer Whether the feature code for pausing or resuming receiving calls from a queue is enabled.
  • 0: Disabled
  • 1: Enabled
queue_pause_unpause String The feature code for pausing or resuming receiving calls from a queue.
enb_listen Integer Whether the feature code for listening to an extension call without talking with any party is enabled.
  • 0: Disabled
  • 1: Enabled
listen String The feature code for listening to an extension call without talking with any party.
listen_permission_ext_list Array<Listen_Permission> The list of extensions and extension groups that are allowed to monitor calls (in the Listen mode).
enb_whisper Integer Whether the feature code for listening to an extension call and talking to the monitored extension without being heard by the other party is enabled.
  • 0: Disabled
  • 1: Enabled
whisper String The feature code for listening to an extension call and talking to the monitored extension without being heard by the other party.
whisper_permission_ext_list Array<Whisper_Permission> The list of extensions and extension groups that are allowed to monitor calls (in the Whisper mode).
enb_barge_in Integer Whether the feature code for listening to an extension call and talking with both parties is enabled.
  • 0: Disabled
  • 1: Enabled
barge_in String The feature code for listening to an extension call and talking with both parties.
barge_in_permission_ext_list 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 Integer Whether the feature code for speed dial prefix is enabled.
  • 0: Disabled
  • 1: Enabled
speed_dial String The feature code for speed dial prefix.
enb_office_time Integer Whether the feature code for overriding time condition for the Business Hours and Holidays configured in system's default time zone is enabled.
  • 0: Disabled
  • 1: Enabled
office_time String The feature code for overriding time condition for the Business Hours and Holidays configured in system's default time zone.
office_time_permit_list 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 Integer Whether the feature code for changing extension presence status to "Available" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_available String The feature code for changing extension presence status to "Available".
enb_presence_away Integer Whether the feature code for changing extension presence status to "Away" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_away String The feature code for changing extension presence status to "Away".
enb_presence_do_not_disturb Integer Whether the feature code for changing extension presence status to "Do Not Disturb" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_do_not_disturb String The feature code for changing extension presence status to "Do Not Disturb".
enb_presence_lunch_break Integer Whether the feature code for changing extension presence status to "Lunch Break" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_lunch_break String The feature code for changing extension presence status to "Lunch Break".
enb_presence_business_trip Integer Whether the feature code for changing extension presence status to "Business Trip" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_business_trip String The feature code for changing extension presence status to "Business Trip".
enb_presence_off_work Integer Whether the feature code for changing extension presence status to "Off Work" is enabled.
  • 0: Disabled
  • 1: Enabled
presence_off_work String The feature code for changing extension presence status to "Off Work".
enb_inbound_route Integer Whether the feature code for switching the custom time condition of inbound routes is enabled.
  • 0: Disabled
  • 1: Enabled
inbound_route_code String The feature code for switching the custom time condition of inbound routes.
inbound_route_allow_ext_list 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 Integer Whether 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 is enabled.
  • 0: Disabled
  • 1: Enabled
enb_enable_forward_all_calls Integer Whether the feature code for forwarding all calls to extension voicemail or a specific extension number is enabled.
  • 0: Disabled
  • 1: Enabled
enable_forward_all_calls String The feature code for forwarding all calls to extension voicemail or a specific extension number.
enb_disable_forward_all_calls Integer Whether the feature code for disabling the automatic call forwarding of all calls is enabled.
  • 0: Disabled
  • 1: Enabled
disable_forward_all_calls String The feature code for disabling the automatic call forwarding of all calls.
enb_enable_forward_when_busy Integer Whether the feature code for forwarding calls to extension voicemail or a specific extension number when busy is enabled.
  • 0: Disabled
  • 1: Enabled
enable_forward_when_busy String The feature code for forwarding calls to extension voicemail or a specific extension number when busy.
enb_disable_forward_when_busy Integer Whether the feature code for disabling the automatic call forwarding when busy is enabled.
  • 0: Disabled
  • 1: Enabled
disable_forward_when_busy String The feature code for disabling the automatic call forwarding when busy.
enb_enable_forward_no_answer Integer Whether the feature code for forwarding no-answered calls to extension voicemail or a specific extension number is enabled.
  • 0: Disabled
  • 1: Enabled
enable_forward_no_answer String The feature code for forwarding no-answered calls to extension voicemail or a specific extension number.
enb_disable_forward_no_answer Integer Whether the feature code for disabling the automatic call forwarding of no-answered calls is enabled.
  • 0: Disabled
  • 1: Enabled
disable_forward_no_answer String The feature code for disabling the automatic call forwarding of no-answered calls.
enb_call_flip Integer Whether the feature code for flipping an active call from current device to another device is enabled.
  • 0: Disabled
  • 1: Enabled
call_flip String The feature code for flipping an active call from current device to another device.
pause_reason_list Array<Pause_Reason> The list of pause reasons and the corresponding feature codes.
enb_guest_in Integer Whether the feature code for registering an extension to a hot desking phone is enabled.
  • 0: Disabled
  • 1: Enabled
guest_in String The feature code for registering an extension to a hot desking phone.
enb_guest_out Integer Whether the feature code for de-registering an extension to a hot desking phone is enabled.
  • 0: Disabled
  • 1: Enabled
guest_out String The feature code for de-registering an extension from a hot desking phone.
enb_blind_transfer_recall Integer Whether the call bounce back to the initiator is enabled for blind transfers and semi-attended transfers when the transferred destination does not answer is enabled.
  • 0: Disabled
  • 1: Enabled
enb_enable_boss_secretary Integer Whether the feature code for enabling Boss-Secretary feature is enabled.
  • 0: Disabled
  • 1: Enabled
enable_boss_secretary String The feature code for enabling Boss-Secretary feature.
enb_disabled_boss_secretary Integer Whether the feature code for disabling Boss-Secretary feature is enabled.
  • 0: Disabled
  • 1: Enabled
disabled_boss_secretary String The feature code for disabling Boss-Secretary feature.
enb_pms_minibar Integer Whether the feature code for posting minibar charges is enabled.
  • 0: Disabled
  • 1: Enabled
pms_minibar String The feature code for posting minibar charges.
enb_pms_makeup_room Integer Whether the feature code for updating the room status to "Dirty/Vacant" is enabled.
  • 0: Disabled
  • 1: Enabled
pms_makeup_room String The feature code for updating the room status to "Dirty/Vacant".
enb_enable_busy_camp_on Integer Whether the feature code for enabling Busy Camp-on is enabled.
  • 0: Disabled
  • 1: Enabled
enable_busy_camp_on String The feature code for enabling Busy Camp-on.
enb_disable_busy_camp_on Integer Whether the feature code for disabling Busy Camp-on is enabled.
  • 0: Disabled
  • 1: Enabled
disable_busy_camp_on String The feature code for disabling Busy Camp-on.
park_moh String The global MoH playlist played when parking a number.
  • 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.
enb_call_force_drop Integer Whether the feature code for forcibly dropping the current call of a specified or monitored extension is enabled.
  • 0: Disabled
  • 1: Enabled
call_force_drop String The feature code for forcibly dropping the current call of a specified or monitored extension.
call_force_drop_permission_ext_list 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 Integer The BLF light scheme.
  • 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 Integer Whether the feature code for querying the extension number registered on the current endpoint is enabled.
  • 0: Disabled
  • 1: Enabled
query_self_number String The feature code for querying the extension number registered on the current endpoint.
enb_query_number_call_back Integer Whether the PBX initiates a line detection call to the extension after the number query call is hung up is enabled.
  • 0: Disabled
  • 1: Enabled
enb_hotel_room_status Integer Whether the feature code for updating the hotel room status is enabled.
  • 0: Disabled
  • 1: Enabled
hotel_room_status String The feature code for updating the hotel room status.
enb_update_cfw_dest Integer Whether changing the call forwarding destinations for specific extensions is enabled.
  • 0: Disabled
  • 1: Enabled
cfw_permission_list 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 Integer Whether the feature code for logging in to all assigned queues is enabled.
  • 0: Disabled
  • 1: Enabled
queue_login_all String The feature code for logging in to all assigned queues.
enb_queue_logout_all Integer Whether the feature code for logging out of all assigned queues is enabled.
  • 0: Disabled
  • 1: Enabled
queue_logout_all String The feature code for logging out of all assigned queues.
enb_queue_login_last Integer Whether the feature code for logging in to all previously logged-in queues is enabled.
  • 0: Disabled
  • 1: Enabled
queue_login_last String The feature code for logging in to all previously logged-in queues.
enb_ext_set_dod Integer Whether the feature code for setting a default DOD or calling with a specified DOD is enabled.
  • 0: Disabled
  • 1: Enabled
ext_set_dod String The feature code for setting a default DOD or calling with a specified DOD.
enb_park_group Integer Whether grouping parking numbers and specifying a MoH playlist for each group is enabled.
  • 0: Disabled
  • 1: Enabled
park_group_list Array<Parking_Group> The list of parking number groups.
Permission_List
Parameter Type Description
id Integer The ID of the extension or extension group.
text String The name of the extension or extension group.
type String The type of target object.
  • extension: Extension
  • ext_group: Extension Group

Pause_Reason

Parameter Type Description
code String The pause feature code.
reason String The pause reasons.
CFW_Permission
Parameter Type Description
id Integer The ID of the permission entry.
active_list 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 Integer The type of object that performs the operation.
  • 0: Specified extensions and extension groups
  • 1: All extensions and extension groups
select_type Integer The permission type.
  • 0: Allowed
  • 1: Disallowed
passive_list Array<Passive_List> The list of extensions and extension groups for which call forwarding destinations are allowed or disallowed to be changed.
passive_type Integer The type of object on which the operation is performed.
  • 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 Integer The priority of the permission entry in the list; the lower the value, the higher the priority.
deal_type Integer The deal type.
  • 0: Extension or extension group

Parking_Group

Parameter Type Description
park_group_start String The start parking number.
park_group_end String The end parking number.
park_group_moh String The MoH playlist for the parking number group.
  • 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.

Examples

Request example

GET /openapi/v1.0/feature_code/get?access_token=9lpNw53mp6Wpubgy5h4oSAHauz0K83q9 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "feature_code": {
        "digit_timeout": 4000,
        "enb_auto_record": 1,
        "auto_record": "*1",
        "enb_vm": 1,
        "voicemail": "*2",
        "enb_leave_vm_for_ext": 1,
        "leave_vm_for_ext": "*12",
        "enb_attend_transfer": 1,
        "attend_transfer": "*3",
        "enb_blind_transfer": 1,
        "blind_transfer": "*03",
        "transfer_digit_timeout": 8,
        "attend_transfer_timeout": 15,
        "enb_pickup": 1,
        "pickup": "*4",
        "enb_ext_pickup": 1,
        "ext_pickup": "*04",
        "enb_park": 1,
        "park": "*5",
        "enb_park_on_slots": 1,
        "park_on_slots": "*05",
        "park_start": "6000",
        "park_end": "6099",
        "park_timeout": 60,
        "park_timeout_dest": "original",
        "park_timeout_dest_value": "",
        "park_timeout_dest_prefix": "",
        "enb_paging": 1,
        "paging": "*6",
        "enb_queue_login_logout": 1,
        "queue_login_logout": "*7",
        "enb_queue_pause_unpause": 1,
        "queue_pause_unpause": "*07",
        "enb_listen": 1,
        "listen": "*51",
        "enb_whisper": 1,
        "whisper": "*52",
        "enb_barge_in": 1,
        "barge_in": "*53",
        "enb_speed_dial": 1,
        "speed_dial": "*89",
        "enb_office_time": 1,
        "office_time": "*99",
        "enb_presence_available": 1,
        "presence_available": "*91",
        "enb_presence_away": 1,
        "presence_away": "*92",
        "enb_presence_do_not_disturb": 1,
        "presence_do_not_disturb": "*93",
        "enb_presence_lunch_break": 1,
        "presence_lunch_break": "*94",
        "enb_presence_business_trip": 1,
        "presence_business_trip": "*95",
        "enb_presence_off_work": 1,
        "presence_off_work": "*96",
        "enb_inbound_route": 1,
        "inbound_route_code": "*8",
        "enable_always_keep_status": 0,
        "enb_enable_forward_all_calls": 1,
        "enable_forward_all_calls": "*31",
        "enb_disable_forward_all_calls": 1,
        "disable_forward_all_calls": "*031",
        "enb_enable_forward_when_busy": 1,
        "enable_forward_when_busy": "*32",
        "enb_disable_forward_when_busy": 1,
        "disable_forward_when_busy": "*032",
        "enb_enable_forward_no_answer": 1,
        "enable_forward_no_answer": "*33",
        "enb_disable_forward_no_answer": 1,
        "disable_forward_no_answer": "*033",
        "enb_call_flip": 1,
        "call_flip": "*01",
        "pause_reason_list": [
            {
                "code": "*01",
                "reason": "Lunch"
            },
            {
                "code": "*02",
                "reason": "Break"
            },
            {
                "code": "*03",
                "reason": "Wrap up"
            }
        ],
        "enb_guest_in": 1,
        "guest_in": "*84",
        "enb_guest_out": 1,
        "guest_out": "*084",
        "enb_blind_transfer_recall": 0,
        "enb_enable_boss_secretary": 1,
        "enable_boss_secretary": "*59",
        "enb_disabled_boss_secretary": 1,
        "disabled_boss_secretary": "*059",
        "enb_pms_minibar": 1,
        "pms_minibar": "*62",
        "enb_pms_makeup_room": 1,
        "pms_makeup_room": "*61",
        "enb_enable_busy_camp_on": 1,
        "enable_busy_camp_on": "*79",
        "enb_disable_busy_camp_on": 1,
        "disable_busy_camp_on": "*079",
        "park_moh": "follow_system",
        "call_force_drop": "*54",
        "enb_call_force_drop": 1,
        "blf_light_scheme": 0,
        "enb_query_self_number": 1,
        "query_self_number": "*97",
        "enb_query_number_call_back": 0,
        "hotel_room_status": "*63",
        "enb_hotel_room_status": 1,
        "enb_update_cfw_dest": 0,
        "cfw_permission_list": [
            {
                "id": 1,
                "active_list": [
                    {
                        "id": 150,
                        "text": "PM",
                        "type": "ext_group"
                    }
                ],
                "active_type": 0,
                "select_type": 1,
                "passive_list": [
                    {
                        "id": 3,
                        "text": "Hotel Room Group",
                        "type": "ext_group"
                    }
                ],
                "passive_type": 0,
                "pos": 1,
                "deal_type": 0
            }
        ],
        "enb_queue_login_all": 1,
        "queue_login_all": "*77",
        "enb_queue_logout_all": 1,
        "queue_logout_all": "*077",
        "enb_queue_login_last": 1,
        "queue_login_last": "*78",
        "enb_ext_set_dod": 1,
        "ext_set_dod": "*085",
        "enb_park_group": 1,
        "park_group_list": [
            {
                "park_group_start": "6000",
                "park_group_end": "6011",
                "park_group_moh": "default"
            }
        ]
    }
}