查询特征码设置

查询所有特征码的设置。

请求 URL

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

请求参数

无请求参数，直接发送请求 URL 查询特征码设置。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
feature_code Object<Feature_Code_Setting> 特征码设置。
Feature_Code_Setting
参数 类型 说明
digit_timeout Integer 输入特征码时，等待输入下一个数字的超时时长 (毫秒)。
enb_auto_record Integer 在通话过程中暂停或恢复录音的特征码是否已启用。
  • 0：禁用
  • 1：启用
auto_record String 在通话过程中暂停或恢复录音的特征码。
enb_vm Integer 收听留言和订阅留言状态的特征码是否已启用。
  • 0：禁用
  • 1：启用
voicemail String 收听留言和订阅留言状态的特征码。
enb_leave_vm_for_ext Integer 指定分机或群语音信箱进行留言的特征码是否已启用。
  • 0：禁用
  • 1：启用
leave_vm_for_ext String 指定分机或群语音信箱进行留言的特征码。
enb_attend_transfer Integer 咨询转特征码是否已启用。
  • 0：禁用
  • 1：启用
attend_transfer String 咨询转特征码。
enb_blind_transfer Integer 盲转特征码是否已启用。
  • 0：禁用
  • 1：启用
blind_transfer String 盲转特征码。
transfer_digit_timeout Integer 转接通话时，等待输入下一个数字的超时时长 (秒)。
attend_transfer_timeout Integer 等待咨询转的通话被应答的超时时长 (秒)。
enb_pickup Integer 截听分机组成员的来电的特征码是否已启用。
  • 0：禁用
  • 1：启用
pickup String 截听分机组成员的来电的特征码。
enb_ext_pickup Integer 截听指定分机的来电的特征码是否已启用。
  • 0：禁用
  • 1：启用
ext_pickup String 截听指定分机的来电的特征码。
enb_park Integer 呼叫停泊特征码是否已启用。
  • 0：禁用
  • 1：启用
park String 呼叫停泊特征码。
enb_park_on_slots Integer 指定停泊特征码是否已启用。
  • 0：禁用
  • 1：启用
park_on_slots String 指定停泊特征码。
park_start String 停泊号码范围的起始号码。
park_end String 停泊号码范围的结束号码。
park_timeout Integer 取回被停泊通话的超时时长 (秒)。
park_timeout_dest String 通话停泊超时的目的地类型。
  • original：原通话方
  • extension：分机号码
  • ext_vm：分机语音信箱
  • external_num：外部号码
  • group_vm：群语音信箱
  • call_flow：通话流程
  • end_call：结束通话
  • ai_receptionist： AI 接待员
  • ivr：IVR
  • ring_group：响铃组
  • queue：队列
  • play_greeting：播放提示音后挂断
park_timeout_dest_value String 通话停泊超时目的地的值。
park_timeout_dest_prefix String 通话停泊超时目的地的前缀。
注：
  • 如果 park_timeout_dest 的值为 external_num，此参数表示呼出路由的前缀。
  • 如果 park_timeout_dest 的值为 play_greeting，此参数表示提示音播放次数。
enb_paging Integer 向指定分机发起对讲的特征码是否已启用。
  • 0：禁用
  • 1：启用
paging String 向指定分机发起对讲的特征码。
enb_queue_login_logout Integer 签入或签出队列的特征码是否已启用。
  • 0：禁用
  • 1：启用
queue_login_logout String 签入或签出队列的特征码。
enb_queue_pause_unpause Integer 暂停或恢复接收队列来电的特征码是否已启用。
  • 0：禁用
  • 1：启用
queue_pause_unpause String 暂停或恢复接收队列来电的特征码。
enb_listen Integer 普通监听特征码是否已启用。
  • 0：禁用
  • 1：启用
listen String 普通监听特征码。
listen_permission_ext_list Array<Listen_Permission> 允许普通监听的分机和分机组的列表。
enb_whisper Integer 密语监听特征码是否已启用。
  • 0：禁用
  • 1：启用
whisper String 密语监听特征码。
whisper_permission_ext_list Array<Whisper_Permission> 允许密语监听的分机和分机组的列表。
enb_barge_in Integer 强插监听特征码是否已启用。
  • 0：禁用
  • 1：启用
barge_in String 强插监听特征码。
barge_in_permission_ext_list Array<Barge_in_Permission> 允许强插监听的分机和分机组的列表。
enb_speed_dial Integer 速拨前缀特征码是否已启用。
  • 0：禁用
  • 1：启用
speed_dial String 速拨前缀特征码。
enb_office_time Integer 切换系统默认时区中的上下班状态的特征码是否已启用。
  • 0：禁用
  • 1：启用
office_time String 切换系统默认时区中的上下班状态的特征码。
office_time_permit_list Array<Office_Time_Permission> 允许切换系统默认时区中的上下班状态的分机或分机组列表。
enb_presence_available Integer 切换分机在线状态为 空闲 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_available String 切换分机在线状态为 空闲 的特征码。
enb_presence_away Integer 切换分机在线状态为 离开 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_away String 切换分机在线状态为 离开 的特征码。
enb_presence_do_not_disturb Integer 切换分机在线状态为 免打扰 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_do_not_disturb String 切换分机在线状态为 免打扰 的特征码。
enb_presence_lunch_break Integer 切换分机在线状态为 午休 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_lunch_break String 切换分机在线状态为 午休 的特征码。
enb_presence_business_trip Integer 切换分机在线状态为 出差 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_business_trip String 切换分机在线状态为 出差 的特征码。
enb_presence_off_work Integer 切换分机在线状态为 下班 的特征码是否已启用。
  • 0：禁用
  • 1：启用
presence_off_work String 切换分机在线状态为 下班 的特征码。
enb_inbound_route Integer 切换呼入路由的自定义时间条件的特征码是否已启用。
  • 0：禁用
  • 1：启用
inbound_route_code String 切换呼入路由的自定义时间条件的特征码。
inbound_route_allow_ext_list Array<Switch_Time_Condition_Permission> 允许切换呼入路由的自定义时间条件的分机和分机组列表。
enable_always_keep_status Integer 在切换 PBX 全局上下班状态或拨打特征码切换某一呼入路由的时间条件后，是否始终维持切换成功之后的状态不变。
  • 0：禁用
  • 1：启用
enb_enable_forward_all_calls Integer 将所有来电前转至自己的语音信箱或指定分机的特征码是否已启用。
  • 0：禁用
  • 1：启用
enable_forward_all_calls String 将所有来电前转至自己的语音信箱或指定分机的特征码。
enb_disable_forward_all_calls Integer 取消来电“总是” 呼叫前转的特征码是否已启用。
  • 0：禁用
  • 1：启用
disable_forward_all_calls String 取消来电“总是” 呼叫前转的特征码。
enb_enable_forward_when_busy Integer 忙时将来电前转至自己的语音信箱或指定分机的特征码是否已启用。
  • 0：禁用
  • 1：启用
enable_forward_when_busy String 忙时将来电前转至自己的语音信箱或指定分机的特征码。
enb_disable_forward_when_busy Integer 取消来电“忙时” 呼叫前转的特征码是否已启用。
  • 0：禁用
  • 1：启用
disable_forward_when_busy String 取消来电“忙时” 呼叫前转的特征码。
enb_enable_forward_no_answer Integer 将无应答来电前转至自己的语音信箱或指定分机的特征码是否已启用。
  • 0：禁用
  • 1：启用
enable_forward_no_answer String 将无应答来电前转至自己的语音信箱或指定分机的特征码。
enb_disable_forward_no_answer Integer 取消来电“无应答” 呼叫前转的特征码是否已启用。
  • 0：禁用
  • 1：启用
disable_forward_no_answer String 取消来电“无应答” 呼叫前转的特征码。
enb_call_flip Integer 将正在进行的通话切换至其他设备接听的特征码是否已启用。
  • 0：禁用
  • 1：启用
call_flip String 将正在进行的通话切换至其他设备接听的特征码。
pause_reason_list Array<Pause_Reason> 暂停原因及其对应特征码列表。
enb_guest_in Integer 登入共享话机的特征码是否已启用。
  • 0：禁用
  • 1：启用
guest_in String 登入共享话机的特征码。
enb_guest_out Integer 登出共享话机的特征码是否已启用。
  • 0：禁用
  • 1：启用
guest_out String 登出共享话机的特征码。
enb_blind_transfer_recall Integer 转接目的地未应答盲转/半咨询的通话时，是否将通话转会发起人。
  • 0：禁用
  • 1：启用
enb_enable_boss_secretary Integer 启用老板秘书功能的特征码是否已启用。
  • 0：禁用
  • 1：启用
enable_boss_secretary String 启用老板秘书功能的特征码。
enb_disabled_boss_secretary Integer 禁用老板秘书功能的特征码是否已启用。
  • 0：禁用
  • 1：启用
disabled_boss_secretary String 禁用老板秘书功能的特征码。
enb_enable_busy_camp_on Integer 启用遇忙回拨功能的特征码是否已启用。
  • 0：禁用
  • 1：启用
enable_busy_camp_on String 启用遇忙回拨功能的特征码。
enb_disable_busy_camp_on Integer 取消遇忙回拨功能的特征码是否已启用。
  • 0：禁用
  • 1：启用
disable_busy_camp_on String 取消遇忙回拨功能的特征码。
park_moh String 呼叫停泊的全局等待音乐播放列表。
  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 等待音乐 中设置)。
  • none：无音乐。
  • 其他值：等待音乐播放列表的名称。
enb_call_force_drop Integer 强拆指定分机或监听分机的通话的特征码是否已启用。
  • 0：禁用
  • 1：启用
call_force_drop String 强拆指定分机或监听分机的通话的特征码。
call_force_drop_permission_ext_list Array<CFD_Permission> 允许强拆指定分机或监听分机的通话的分机或分机组列表。
blf_light_scheme Integer 上下班 BLF 亮灯方案。
  • 0：红色表示上班/在目的地状态，绿色表示下班/不在目的地状态。
  • 1：绿色表示上班/在目的地状态，红色表示下班/不在目的地状态。
enb_query_self_number Integer 查询本机号码的特征码是否已启用。
  • 0：禁用
  • 1：启用
query_self_number String 查询本机号码的特征码。
enb_query_number_call_back Integer 挂断号码查询通话后，PBX 是否向该分机发起线路检测呼叫。
  • 0：禁用
  • 1：启用
enb_hotel_room_status Integer 更新酒店房间状态的特征码是否已启用。
  • 0：禁用
  • 1：启用
hotel_room_status String 更新酒店房间状态的特征码。
enb_update_cfw_dest Integer 修改指定分机的呼叫前转目的地是否已启用。
  • 0：禁用
  • 1：启用
cfw_permission_list Array<CFW_Permission> 允许或禁止修改指定分机的呼叫前转目的地的分机或分机组列表。
enb_queue_login_all Integer 签入所在的所有队列的特征码是否已启用。
  • 0：禁用
  • 1：启用
queue_login_all String 签入所在的所有队列的特征码。
enb_queue_logout_all Integer 签出所在的所有队列的特征码是否已启用。
  • 0：禁用
  • 1：启用
queue_logout_all String 签出所在的所有队列的特征码。
enb_queue_login_last Integer 签入上次签入的所有队列的特征码是否已启用。
  • 0：禁用
  • 1：启用
queue_login_last String 签入上次签入的所有队列的特征码。
enb_ext_set_dod Integer 设置默认 DOD 或指定 DOD 外呼的特征码是否已启用。
  • 0：禁用
  • 1：启用
ext_set_dod String 设置默认 DOD 或指定 DOD 外呼的特征码。
enb_ai_transcription Integer 在通话期间启动或暂停 AI 通话转写的特征码是否已启用。

  • 0：禁用
  • 1：启用
ai_transcription_code String 在通话期间启动或暂停 AI 通话转写的特征码。
enb_park_group Integer 将停泊号码分组并指定等待音乐播放列表是否已启用。
  • 0：禁用
  • 1：启用
park_group_list Array<Parking_Group> 停泊号码组的列表。
Permission_List
参数 类型 说明
id Integer 分机或分机组的 ID。
text String 分机或分机组的号码。
type String 目标对象的类型。
  • extension：分机
  • ext_group：分机组

Pause_Reason

参数 类型 说明
code String 暂停特征码。
reason String 暂停原因。
CFW_Permission
参数 类型 说明
id Integer 权限条目的ID。
active_list Array<Active_List> 允许或禁止修改指定分机的呼叫前转目的地的分机或分机组列表。
active_type Integer 执行操作的对象类型。
  • 0：指定的分机和分机组。
  • 1：所有分机和分机组
select_type Integer 权限类型。
  • 0：允许修改
  • 1：禁止修改
passive_list Array<Passive_List> 其呼叫前转目的地允许或不允许被更改的分机和分机组列表。
passive_type Integer 被执行操作的对象类型。
  • 0：active_list 中的分机和分机组
  • 1：所有分机和分机组
  • 2：active_list 中的分机组中的分机
  • 4：手动指定的分机和分机组
pos Integer 权限条目在列表中的优先级；值越低，优先级越高。
deal_type Integer 提交类型。
  • 0：分机或分机组

Parking_Group

参数 类型 说明
park_group_start String 起始停泊号码。
park_group_end String 结束停泊号码。
park_group_moh String 停泊号码组的等待音乐播放列表。
  • park_global_moh：跟随停泊号码全局等待音乐播放列表。
  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 等待音乐 中设置)。
  • none：无音乐。
  • 其他值：等待音乐播放列表的名称。

示例

请求示例

GET /openapi/v1.0/feature_code/get?access_token=9lpNw53mp6Wpubgy5h4oSAHauz0K83q9 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

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_ai_transcription": 1,
        "ai_transcription_code": "*09",
        "enb_park_group": 1,
        "park_group_list": [
            {
                "park_group_start": "6000",
                "park_group_end": "6011",
                "park_group_moh": "default"
            }
        ]
    }
}