编辑特征码设置

编辑特征码设置。

请求 URL

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

请求参数

参数 是否必填 类型 说明
digit_timeout 否 Integer 输入特征码时，等待输入下一个数字的超时时长 (毫秒)。
enb_auto_record 否 Integer 是否启用在通话过程中暂停或恢复录音的特征码。

取值范围：

  • 0：禁用
  • 1：启用
auto_record 否 String 在通话过程中暂停或恢复录音的特征码。
注： 最大字符长度为 7。
enb_vm 否 Integer 是否启用收听留言和订阅留言状态的特征码。

取值范围：

  • 0：禁用
  • 1：启用
voicemail 否 String 收听留言和订阅留言状态的特征码。
注： 最大字符长度为 7。
enb_leave_vm_for_ext 否 Integer 是否启用指定分机或群语音信箱进行留言的特征码。

取值范围：

  • 0：禁用
  • 1：启用
leave_vm_for_ext 否 String 指定分机或群语音信箱进行留言的特征码。
注： 最大字符长度为 7。
enb_attend_transfer 否 Integer 是否启用咨询转特征码。

取值范围：

  • 0：禁用
  • 1：启用
attend_transfer 否 String 咨询转特征码。
注： 最大字符长度为 7。
enb_blind_transfer 否 Integer 是否启用盲转特征码。

取值范围：

  • 0：禁用
  • 1：启用
blind_transfer 否 String 盲转特征码。
注： 最大字符长度为 7。
transfer_digit_timeout 否 Integer 转接通话时，等待输入下一个数字的超时时长 (秒)。
注： 允许输入 3 到 8 的整数。
attend_transfer_timeout 否 Integer 等待咨询转的通话被应答的超时时长 (秒)。
enb_pickup 否 Integer 是否启用截听分机组成员的来电的特征码。

取值范围：

  • 0：禁用
  • 1：启用
pickup 否 String 截听分机组成员的来电的特征码。
注： 最大字符长度为 7。
enb_ext_pickup 否 Integer 是否启用截听分机组成员的来电的特征码。

取值范围：

  • 0：禁用
  • 1：启用
ext_pickup 否 String 截听分机组成员的来电的特征码。
注： 最大字符长度为 7。
enb_park 否 Integer 是否启用呼叫停泊特征码。

取值范围：

  • 0：禁用
  • 1：启用
park 否 String 呼叫停泊特征码。
注： 最大字符长度为 7。
enb_park_on_slots 否 Integer 是否启用指定停泊特征码。

取值范围：

  • 0：禁用
  • 1：启用
park_on_slots 否 String 指定停泊特征码。
注： 最大字符长度为 7。
park_start 否 String 停泊号码范围的起始号码。
注： 最大字符长度为 7。
park_end 否 String 停泊号码范围的结束号码。
注： 最大字符长度为 7。
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 通话停泊超时目的地的值。
注： 最大字符长度为 255。
park_timeout_dest_prefix 否 String 通话停泊超时目的地的前缀。
注：
  • 如果 park_timeout_dest 设置为 external_num，此参数表示呼出路由的前缀。
  • 如果 park_timeout_dest 设置为 play_greeting，此参数表示提示音播放次数。
enb_paging 否 Integer 是否启用向指定分机发起对讲的特征码。

取值范围：

  • 0：禁用
  • 1：启用
paging 否 String 向指定分机发起对讲的特征码。
注： 最大字符长度为 7。
enb_queue_login_logout 否 Integer 是否启用签入或签出队列的特征码。

取值范围：

  • 0：禁用
  • 1：启用
queue_login_logout 否 String 签入或签出队列的特征码。
注： 最大字符长度为 7。
enb_queue_pause_unpause 否 Integer 是否启用暂停或恢复接收队列来电的特征码。

取值范围：

  • 0：禁用
  • 1：启用
queue_pause_unpause 否 String 暂停或恢复接收队列来电的特征码。
注： 最大字符长度为 7。
enb_listen 否 Integer 是否启用普通监听特征码。

取值范围：

  • 0：禁用
  • 1：启用
listen 否 String 普通监听特征码。
注： 最大字符长度为 7。
listen_permission_ext_list 否 Array<Listen_Permission> 允许普通监听的分机和分机组的列表。
enb_whisper 否 Integer 是否启用密语监听特征码。

取值范围：

  • 0：禁用
  • 1：启用
whisper 否 String 密语监听特征码。
注： 最大字符长度为 7。
whisper_permission_ext_list 否 Array<Whisper_Permission> 允许密语监听的分机和分机组的列表。
enb_barge_in 否 Integer 是否启用强插监听特征码。

取值范围：

  • 0：禁用
  • 1：启用
barge_in 否 String 强插监听特征码。
注： 最大字符长度为 7。
barge_in_permission_ext_list 否 Array<Barge_in_Permission> 允许强插监听的分机和分机组的列表。
enb_speed_dial 否 Integer 是否启用速拨前缀特征码。

取值范围：

  • 0：禁用
  • 1：启用
speed_dial 否 String 速拨前缀特征码。
注： 最大字符长度为 7。
enb_office_time 否 Integer 是否启用切换系统默认时区中的上下班状态的特征码。

取值范围：

  • 0：禁用
  • 1：启用
office_time 否 String 切换系统默认时区中的上下班状态的特征码。
注： 最大字符长度为 7。
office_time_permit_list 否 Array<Office_Time_Permission> 允许切换系统默认时区中的上下班状态的分机或分机组列表。
enb_presence_available 否 Integer 是否启用切换分机在线状态为 空闲 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_available 否 String 切换分机在线状态为 空闲 的特征码。
注： 最大字符长度为 7。
enb_presence_away 否 Integer 是否启用切换分机在线状态为 离开 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_away 否 String 切换分机在线状态为 离开 的特征码。
注： 最大字符长度为 7。
enb_presence_do_not_disturb 否 Integer 是否启用切换分机在线状态为 免打扰 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_do_not_disturb 否 String 切换分机在线状态为 免打扰 的特征码。
注： 最大字符长度为 7。
enb_presence_lunch_break 否 Integer 是否启用切换分机在线状态为 午休 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_lunch_break 否 String 切换分机在线状态为 午休 的特征码。
注： 最大字符长度为 7。
enb_presence_business_trip 否 Integer 是否启用切换分机在线状态为 出差 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_business_trip 否 String 切换分机在线状态为 出差 的特征码。
注： 最大字符长度为 7。
enb_presence_off_work 否 Integer 是否启用切换分机在线状态为 下班 的特征码。

取值范围：

  • 0：禁用
  • 1：启用
presence_off_work 否 String 切换分机在线状态为 下班 的特征码。
注： 最大字符长度为 7。
enb_inbound_route 否 Integer 是否启用切换呼入路由的自定义时间条件的特征码。

取值范围：

  • 0：禁用
  • 1：启用
inbound_route_code 否 String 切换呼入路由的自定义时间条件的特征码。
注： 最大字符长度为 7。
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 将所有来电前转至自己的语音信箱或指定分机的特征码。
注： 最大字符长度为 7。
enb_disable_forward_all_calls 否 Integer 是否启用取消来电“总是” 呼叫前转的特征码。

取值范围：

  • 0：禁用
  • 1：启用
disable_forward_all_calls 否 String 取消来电“总是” 呼叫前转的特征码。
注： 最大字符长度为 7。
enb_enable_forward_when_busy 否 Integer 是否启用忙时将来电前转至自己的语音信箱或指定分机的特征码。

取值范围：

  • 0：禁用
  • 1：启用
enable_forward_when_busy 否 String 忙时将来电前转至自己的语音信箱或指定分机的特征码。
注： 最大字符长度为 7。
enb_disable_forward_when_busy 否 Integer 是否启用取消来电“忙时” 呼叫前转的特征码。

取值范围：

  • 0：禁用
  • 1：启用
disable_forward_when_busy 否 String 取消来电“忙时” 呼叫前转的特征码。
注： 最大字符长度为 7。
enb_enable_forward_no_answer 否 Integer 是否启用将无应答来电前转至自己的语音信箱或指定分机的特征码。

取值范围：

  • 0：禁用
  • 1：启用
enable_forward_no_answer 否 String 将无应答来电前转至自己的语音信箱或指定分机的特征码。
注： 最大字符长度为 7。
enb_disable_forward_no_answer 否 Integer 是否启用取消来电“无应答” 呼叫前转的特征码。

取值范围：

  • 0：禁用
  • 1：启用
disable_forward_no_answer 否 String 取消来电“无应答” 呼叫前转的特征码。
注： 最大字符长度为 7。
enb_call_flip 否 Integer 是否启用将正在进行的通话切换至其他设备接听的特征码。

取值范围：

  • 0：禁用
  • 1：启用
call_flip 否 String 将正在进行的通话切换至其他设备接听的特征码。
注： 最大字符长度为 7。
pause_reason_list 否 Array<Pause_Reason> 暂停原因及其对应特征码列表。
enb_guest_in 否 Integer 是否启用登入共享话机的特征码。

取值范围：

  • 0：禁用
  • 1：启用
guest_in 否 String 登入共享话机的特征码。
注： 最大字符长度为 7。
enb_guest_out 否 Integer 是否启用登出共享话机的特征码。

取值范围：

  • 0：禁用
  • 1：启用
guest_out 否 String 登出共享话机的特征码。
注： 最大字符长度为 7。
enb_blind_transfer_recall 否 Integer 转接目的地未应答盲转/半咨询的通话时，是否将通话转会发起人。

取值范围：

  • 0：禁用
  • 1：启用
enb_enable_boss_secretary 否 Integer 是否启用启用老板秘书功能的特征码。

取值范围：

  • 0：禁用
  • 1：启用
enable_boss_secretary 否 String 启用老板秘书功能的特征码
注： 最大字符长度为 7。
enb_disabled_boss_secretary 否 Integer 是否启用禁用老板秘书功能的特征码。

取值范围：

  • 0：禁用
  • 1：启用
disabled_boss_secretary 否 String 禁用老板秘书功能的特征码。
注： 最大字符长度为 7。
enb_enable_busy_camp_on 否 Integer 是否启用启用遇忙回拨功能的特征码。

取值范围：

  • 0：禁用
  • 1：启用
enable_busy_camp_on 否 String 启用遇忙回拨功能的特征码。
注： 最大字符长度为 7。
enb_disable_busy_camp_on 否 Integer 是否启用取消遇忙回拨功能的特征码。

取值范围：

  • 0：禁用
  • 1：启用
disable_busy_camp_on 否 String 取消遇忙回拨功能的特征码。
注： 最大字符长度为 7。
park_moh 否 String 呼叫停泊的全局等待音乐播放列表。

取值范围：

  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 等待音乐 中设置)。
  • none：无音乐。
  • 其他值：等待音乐播放列表的名称。
    注： 可使用 查询等待音乐列表 接口查询名称。
enb_call_force_drop 否 Integer 是否启用强拆指定分机或监听分机的通话的特征码。

取值范围：

  • 0：禁用
  • 1：启用
call_force_drop 否 String 强拆指定分机或监听分机的通话的特征码。
注： 最大字符长度为 7。
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 查询本机号码的特征码。
注： 最大字符长度为 7。
enb_query_number_call_back 否 Integer 挂断号码查询通话后，PBX 是否向该分机发起线路检测呼叫。

取值范围：

  • 0：禁用
  • 1：启用
enb_hotel_room_status 否 Integer 是否启用更新酒店房间状态的特征码。

取值范围：

  • 0：禁用
  • 1：启用
hotel_room_status 否 String 更新酒店房间状态的特征码。
注： 最大字符长度为 7。
enb_update_cfw_dest 否 Integer 是否启用修改指定分机的呼叫前转目的地。

取值范围：

  • 0：禁用
  • 1：启用
cfw_permission_list 否 Array<CFW_Permission> 允许或禁止修改指定分机的呼叫前转目的地的分机或分机组列表。
enb_queue_login_all 否 Integer 是否启用签入所在的所有队列的特征码。

取值范围：

  • 0：禁用
  • 1：启用
queue_login_all 否 String 签入所在的所有队列的特征码。
注： 最大字符长度为 7。
enb_queue_logout_all 否 Integer 是否启用签出所在的所有队列的特征码。

取值范围：

  • 0：禁用
  • 1：启用
queue_logout_all 否 String 签出所在的所有队列的特征码。
注： 最大字符长度为 7。
enb_queue_login_last 否 Integer 是否启用签入上次签入的所有队列的特征码。

取值范围：

  • 0：禁用
  • 1：启用
queue_login_last 否 String 签入上次签入的所有队列的特征码。
注： 最大字符长度为 7。
enb_ext_set_dod 否 Integer 是否启用设置默认 DOD 或指定 DOD 外呼的特征码。

取值范围：

  • 0：禁用
  • 1：启用
ext_set_dod 否 String 设置默认 DOD 或指定 DOD 外呼的特征码。
注： 最大字符长度为 7。
enb_ai_transcription 否 Integer 是否启用在通话期间启动或暂停 AI 通话转写的特征码。

取值范围：

  • 0：禁用
  • 1：启用
ai_transcription_code 否 String 在通话期间启动或暂停 AI 通话转写的特征码。

注： 最大字符长度为 7。
enb_park_group 否 Integer 是否启用将停泊号码分组并指定等待音乐播放列表。

取值范围：

  • 0：禁用
  • 1：启用
park_group_list 否 Array<Parking_Group> 停泊号码组的列表。
Permission_List
参数 是否必填 类型 说明
id 是 Integer 分机或分机组的 ID。
注： 可使用 获取菜单选项 接口查询 ID (menu= extension 或 ext_group)。
type 是 String 目标对象的类型。

取值范围：

  • extension：分机
  • ext_group：分机组
Pause_Reason
参数 是否必填 类型 说明
code 是 String 暂停特征码。
注： 最大字符长度为 7。
reason 是 String 暂停原因。
注： 最大字符长度为 68。
CFW_Permission
参数 是否必填 类型 说明
active_list 否 Array<Active_List> 允许或禁止修改指定分机的呼叫前转目的地的分机或分机组列表。
active_type 否 Integer 执行操作的对象类型。

取值范围：

  • 0：指定的分机和分机组。
  • 1：所有分机和分机组
select_type 否 Integer 权限类型。

取值范围：

  • 0：允许修改
  • 1：禁止修改
passive_list 否 Array<Passive_List> 其呼叫前转目的地允许或不允许被更改的分机和分机组列表。
注： 此参数仅在 passive_type 设置为 4 时生效。
passive_type 否 Integer 被执行操作的对象类型。

取值范围：

  • 0：active_list 中的分机和分机组
  • 1：所有分机和分机组
  • 2：active_list 中的分机组中的分机
  • 4：手动指定的分机和分机组
pos 否 Integer 权限条目在列表中的优先级；值越低，优先级越高。
注： 允许输入大于或等于 0 的整数。
deal_type 否 Integer 提交类型。

取值范围：

  • 0：分机或分机组
Parking_Group
参数 是否必填 类型 说明
park_group_start 是 String 起始停泊号码。
注： 最大字符长度为 7。
park_group_end 是 String 结束停泊号码。
注： 最大字符长度为 7。
park_group_moh 否 String 停泊号码组的等待音乐播放列表。

取值范围：

  • park_global_moh：跟随停泊号码全局等待音乐播放列表。
  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 等待音乐 中设置)。
  • none：无音乐。
  • 其他值：等待音乐播放列表的名称。
    注： 可使用 查询等待音乐列表 接口查询名称。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

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

Host: yeastardocs.example.yeastarcloud.com
Content-类型: application/json
{
    "enb_auto_record":1
}

响应示例

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