编辑分机

编辑分机配置。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id 是 Integer 分机的唯一 ID。
注： 可使用 搜索特定分机 接口搜索分机 ID。
avatar 否 String 分机头像的文件 ID。
注：
  • 你需要先上传头像文件到 PBX，然后在此参数中传入返回的文件 ID。
  • 若不传此参数，分机将使用系统默认头像。
first_name 否 String 名称。
last_name 否 String 姓氏。
email_addr 否 String 邮箱地址。
mobile_number 否 String 手机号码。
user_password 否 String 用户密码。
注：
  • 必须包含数字、大写字母和小写字母。
  • 不允许包含 4 位连续的数字，4 位相同的数字，分机号，姓氏和名字。
role_id 否 Integer 分机用户角色 ID。
注： 可使用 获取菜单选项 接口查询用户角色的 ID。
organization_list 否 Array <Organization_Info> 分机所属部门。
注： 如果启用 部门管理 功能，此参数为必填项。
title 否 String 分机用户的职位。
email_language 否 String 分机收到的邮件通知的语言。

取值范围：

  • follow_system：默认系统邮件语言
  • zh-cn：简体中文 (Chinese Simplified)
  • en：English
  • ru：Pусский (Russian)
  • de：Deutsch (German)
  • fr：Française (French)
  • bp：Português Brasil (Portuguese Brazil)
  • it：Italiano (Italian)
  • tr：Türkçe (Turkish)
user_lang 否 String 分机在通话过程中听到的系统提示音的语言。
取值范围：follow_system 或 PBX 系统中已存在的提示音语言 (如 German )。
注： 可使用 获取菜单选项 接口查询已有的系统提示音。
vm_lang 否 String 来电者进入分机语音信箱时听到的系统提示音的语言。

取值范围：follow_system 或 PBX 系统中已存在的提示音语言 (如 German )。

注： 可使用 获取菜单选项 接口查询已有的系统提示音。
caller_id 否 String 显示号码。
注：
  • 允许填写数字、字母和符号 ( ) . - + * #。
  • 最大字符长度限制为 31。
reg_name 否 String 认证名称。
注： 最大字符长度限制为 63。
reg_password 否 String 注册密码。
注：
  • 必须包含数字、大写字母和小写字母。
  • 不允许包含 4 位连续的数字，4 位相同的数字，分机号，姓氏和名字。
concurrent_registrations 否 Integer IP 话机同时注册数。

取值范围：

  • 1 (默认)
  • 2
  • 3
  • 4
  • 5
presence_status 否 String 分机在线状态。

取值范围：

  • available：空闲
  • away：离开
  • business_trip：出差
  • do_not_disturb：免打扰 (DND)
  • lunch：午休
  • off_work：下班
presence_list 否 Array <Presence_Setting> 在线状态设置列表。
presence_mobile_prefix 否 String “手机号码同时响铃” 功能的手机号码拨号前缀。
agent_id 否 String

分机作为队列坐席接听来电后，系统向呼叫者播报的坐席工号。

默认播报分机号作为坐席的工号。

注： 在 PBX 网页上为队列启用 播报坐席工号 功能（路径：呼叫功能 > 队列 > 队列偏好设置 > 播报设置）后，才会播报队列坐席的工号。
enb_vm 否 Integer 是否启用语音信箱。

取值范围：

  • 0：禁用
  • 1：启用
enb_vm_pin 否 Integer 是否启用语音信箱 PIN 码认证。

取值范围：

  • 0：禁用
  • 1：启用
vm_pin 否 String 用于访问语音信箱的 PIN 码。
new_vm_notification 否 String 收到新语音留言时是否通知分机，以及如何通知。
取值范围：
  • no：不发送电子邮件通知。
  • with_attach：发送电子邮件通知，并将新的语音留言转换成 .wav 格式的文件附在邮件中。
  • without_attach：发送电子邮件通知，但不附上语音留言文件。
vm_after_notification 否 String 发送通知邮件后如何处理留言。

取值范围：

  • no：保留语音信箱中的新语音留言并标记为未读。
  • mark_read：保留语音信箱中的新语音留言并标记为已读。
  • delete：删除语音留言。
    注： 只有当 new_vm_notification 设置为 with_attach 时，才支持设置此参数值为 delete。
enb_vm_play_datetime 否 Integer 是否在播放语音留言之前播放留言接收时间。

取值范围：

  • 0：禁用
  • 1：启用
vm_play_time_format 否 String 留言接收时间的播放格式。

取值范围：

  • follow_system：跟随系统设置 (在 系统 > 日期和时间 > 显示格式 > 时间显示格式 中设置)
  • 12-hour：12小时制
  • 24-hour：24小时制
enb_missed_call_auto_reply 否 Integer 是否启用分机的 自动回复未接来电 功能。

取值范围：

  • 0：禁用
  • 1：启用
missed_call_auto_reply 否 Object <Missed_Call_Auto_Reply> 分机未接外线来电的自动回复消息配置。
注： 此参数在 enb_missed_call_auto_reply 设置为 1 时必填。
enb_all_busy_mode_for_endpoints 否 Integer

注册了分机的其中一个终端在忙时，是否将新来电前转至“忙时”前转目的地。

取值范围：

  • 0：禁用
  • 1：启用
enb_all_reject_mode_for_endpoints 否 Integer 是否在注册了分机的其中一个终端上拒接来电后，停止响铃其他终端。

取值范围：

  • 0：禁用。在其中一个终端上拒接来电后，其他终端仍会响铃。
  • 1：启用。在其中一个终端上拒接来电后，其他终端停止响铃。
dtmf_mode 否 String DTMF 模式。

取值范围：

  • rfc4733：RFC4733 (RFC2833)
  • info：Info
  • inband：Inband
  • auto：Auto
transport 否 String 传输协议。

取值范围：

  • udp：UDP 协议
  • tcp：TCP 协议
  • tls：TLS 协议
注：
  • 使用半角逗号分隔多个协议，例如 udp,tcp,tls。
  • tcp 仅在 PBX 的 SIP TCP 端口启用时生效 (路径：PBX设置 > SIP设置 > 通用 > 基本)；而 tls 仅在 PBX 的 TLS 功能启用时生效 (路径：PBX设置 > SIP设置 > TLS)。
  • 当同时选中多种协议时，将应用以下优先级规则：
    • Linkus UC 客户端 / 自动配置 IP 话机：TLS > TCP > UDP
    • 手动注册分机的 IP 话机：若话机指定了传输协议，则使用话机指定的协议；若未指定，则遵循默认优先级 (TLS > TCP > UDP)。
enb_qualify 否 Integer 是否启用 Qualify 功能。
  • 0：禁用
  • 1：启用
enb_t38_support 否 Integer 是否启用 支持 T.38 功能。

取值范围：

  • 0：禁用
  • 1：启用
enb_srtp 否 Integer 是否启用 语音加密 (SRTP) 功能。

取值范围：

  • 0：禁用
  • 1：启用
enb_monitor_call_quality 否 Integer 是否启用通话质量监测。

取值范围：

  • 0：禁用
  • 1：启用
monitoring_end_timestamp 否 Integer

通话质量监测结束的时间戳。

注： 该参数在 enb_monitor_call_quality 设为 1 时必填。
disable_outb_call 否 Integer 是否允许拨打外线电话。

取值范围：

  • 0：允许拨打外线电话。
  • 1：禁止拨打外线电话。
disable_outb_call_outside_business_hours 否 Integer

是否允许非办公时间拨打外线电话。

取值范围：

  • 0：允许非办公时间拨打外线电话。
  • 1：禁止非办公时间拨打外线电话。
disable_international_call 否 Integer 是否允许拨打国际电话。

取值范围：

  • 0：允许拨打国际电话。
  • 1：禁止拨打国际电话。
max_outb_call_duration 否 Integer 指定分机发起的外线呼出的最大通话时长。

取值范围：

  • -1：跟随系统设置 (在 PBX设置 > 常规设置 > 最大通话时长 (秒) 中设置).
  • 0：无限制。
  • 其他值：最大通话时长 (1 - 9999999 秒).
outbound_route_permission 否 Array <Integer> 允许分机使用的呼出路由的唯一 ID。
注：
enb_internal_client 否 Integer 是否启用 Linkus 呼叫功能。
注：
  • 若启用，分机用户可以登录并使用 Linkus 手机端、桌面端、网页端和平板端 (SDK)。
  • 如需使用 Linkus 平板端 (SDK) ，你需要先集成 Linkus Android SDK 或 Linkus iOS SDK。

取值范围：

  • 0：禁用
  • 1：启用
linkus_mobile_codec 否 String 为 Linkus 手机端配置编解码。

取值范围：

  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
  • opus
client_conf_list 否 Array <Linkus_Clients_Setting> Linkus 客户端配置项。
moh 否 String

当通话被保持时，系统向呼叫者播放的音频。

取值范围：

  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 等待音乐 中设置)。
  • 空字符串：不播放等待音乐。

  • 其他值：等待音乐播放列表的名称。

    注： 可使用 查询等待音乐列表 接口查询等待音乐播放列表的名称。
call_forward_moh 否 String

当通话被转至其他目的地时，系统向呼叫者播放的音频。

取值范围：

  • follow_system：跟随系统设置 (在 PBX设置 > 提示音 > 提示音选项 > 呼叫前转等待音乐 中设置)。
  • 空字符串：不播放等待音乐。

  • 其他值：等待音乐播放列表的名称。

    注： 可使用 查询等待音乐列表 接口查询等待音乐播放列表的名称。
ringback_tone_moh 否 String

在分机用户接听来电之前，系统向呼叫者播放的提示音。

取值范围：

  • follow_system：跟随系统设置。
  • 空字符串：继续播放上一阶段的提示音；若无可用提示音，则播放主叫自定义铃声 (Beep 提示音)。

  • 其他值：自定义提示音的文件名 (如 demo.wav)

    注： 可使用 获取菜单选项 接口查询自定义提示音的文件名 ("menu":"custom_prompt")。
outbound_recording_prompt 否 String 在外线呼出通话开始录音前，向通话双方播放的录音提示音。

取值范围：

  • none：不播放提示音。
  • follow_system：跟随系统设置 (在 呼叫功能 > 录音 > 录音提示音 > 呼出通话录音提示音 中设置)。

  • 其他值：自定义提示音的文件名 (如 demo.wav)

    注： 可使用 获取菜单选项 接口查询自定义提示音的文件名 ("menu":"custom_prompt")。
vm_greeting 否 String

在呼叫者留言前，系统向其播放的默认问候语。

取值范围：

  • follow_system：跟随系统设置 (在 呼叫功能 > 语音信箱 > 语音信箱设置 > 问候语选项 > 全局留言问候语 中设置)。
  • no_greeting：不播放提示音。
  • 其他值：语音信箱问候语的文件名 (如 demo.wav)。
    注： 可使用 查询分机语音信箱问候语列表 接口查询语音信箱问候语的文件名。
Organization_Info
参数 是否必填 类型 说明
value 是 String 部门的唯一 ID。
注： 可使用 获取菜单选项 接口查询部门的 ID。
Presence_Setting
参数 是否必填 类型 说明
status 是 String 分机在线状态。

取值范围：

  • available：空闲
  • away：离开
  • business_trip：出差
  • do_not_disturb：免打扰 (DND)
  • lunch：午休
  • off_work：下班
enb_in_always_forward 否 Integer 是否将所有内部来电都转移到指定目的地 (总是 前转)。

取值范围：

  • 0：禁用
  • 1：启用
in_always_forward_dest 否 String 内部来电 总是 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
in_always_forward_prefix 否 String 此参数的设置取决于内部来电 总是 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
in_always_forward_value 否 String 内部来电 总是 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
in_always_forward_num 否 String 内部来电 总是 前转目的地 external_num 的外部号码。
in_always_forward_call_confirm 否 Integer 是否对 总是 条件下前转的内部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_in_no_answer_forward 否 Integer 是否在分机无应答时将内部来电转移到指定目的地 (无应答 前转)。

取值范围：

  • 0：禁用
  • 1：启用
in_no_answer_forward_dest 否 String 内部来电 无应答 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
in_no_answer_forward_prefix 否 String 此参数的设置取决于内部来电 无应答 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
in_no_answer_forward_value 否 String 内部来电 无应答 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
in_no_answer_forward_num 否 String 内部来电 无应答 前转目的地 external_num 的外部号码。
in_no_answer_forward_call_confirm 否 Integer 是否对 无应答 条件下前转的内部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_in_busy_forward 否 Integer 是否在分机忙时将内部来电转移到指定目的地 (忙时 前转)。

取值范围：

  • 0：禁用
  • 1：启用
in_busy_forward_dest 否 String 内部来电 忙时 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
in_busy_forward_prefix 否 String 此参数的设置取决于内部来电 忙时 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
in_busy_forward_value 否 String 内部来电 忙时 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
in_busy_forward_num 否 String 内部来电 忙时 前转目的地 external_num 的外部号码。
in_busy_forward_call_confirm 否 Integer 是否对 忙时 条件下前转的内部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_ex_always_forward 否 Integer 是否将所有外部来电都转移到指定目的地 (总是 前转)。

取值范围：

  • 0：禁用
  • 1：启用
ex_always_forward_dest 否 String 外部来电 总是 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
ex_always_forward_prefix 否 String 此参数的设置取决于外部来电 总是 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
ex_always_forward_value 否 String 外部来电 总是 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
ex_always_forward_num 否 String 外部来电 总是 前转目的地 external_num 的外部号码。
ex_always_forward_call_confirm 否 Integer 是否对 总是 条件下前转的外部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_ex_no_answer_forward 否 Integer 是否在分机无应答时将外部来电转移到指定目的地 (无应答 前转)。

取值范围：

  • 0：禁用
  • 1：启用
ex_no_answer_forward_dest 否 String 外部来电 无应答 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
ex_no_answer_forward_prefix 否 String 此参数的设置取决于外部来电 无应答 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
ex_no_answer_forward_value 否 String 外部来电 无应答 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
ex_no_answer_forward_num 否 String 外部来电 无应答 前转目的地 external_num 的外部号码。
ex_no_answer_forward_call_confirm 否 Integer 是否对 无应答 条件下前转的外部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_ex_busy_forward 否 Integer 是否在分机忙时将外部来电转移到指定目的地 (忙时 前转)。

取值范围：

  • 0：禁用
  • 1：启用
ex_busy_forward_dest 否 String 外部来电 忙时 前转的目的地类型。

取值范围：

  • extension：分机
  • ext_vm：分机语音信箱
  • ivr: IVR
  • call_flow：通话流程
  • ring_group：响铃组
  • queue：队列
  • group_vm：群语音信箱
  • mobile_number：手机号码
  • external_num：外部号码
  • play_greeting：播放问候语后挂断
  • end_call：挂断通话，并返回 SIP 480 响应。
  • send_busy：挂断通话，并返回 SIP 486 响应。
注： 当目的地类型为 ext_vm 或 mobile_number 时，系统会自动从分机信息中获取对应的目的地信息。
ex_busy_forward_prefix 否 String 此参数的设置取决于外部来电 忙时 前转的目的地类型。
  • 当目的地类型为 mobile_number 或 external_num 时，此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数用于指定问候语的播放次数，其取值范围为 1 - 5。
ex_busy_forward_value 否 String 外部来电 忙时 前转的目的地。

对于以下目的地类型，该参数 必填：

  • 当目的地类型为 play_greeting，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ivr、ring_group、queue 或 group_vm，此参数用于指定目的地的 ID。
    例如：目的地为分机 2002，则该参数需为分机 2002 的 ID 2。
    注：
ex_busy_forward_num 否 String 外部来电 忙时 前转目的地 external_num 的外部号码。
ex_busy_forward_call_confirm 否 Integer 是否对 忙时 条件下前转的外部来电启用呼叫确认。
注： 此设置仅在前转目的地设置为 mobile_number 或 external_num 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
ring_timeout 否 Integer 来电响铃超时时间 (单位：秒)。
enb_ring_mobile 否 Integer 分机响铃时，手机是否同时响铃。

取值范围：

  • 0：禁用
  • 1：启用
mobile_call_confirm 否 Integer 是否对同时响铃到分机手机号码的来电启用呼叫确认。
注： 此设置仅在 enb_ring_mobile 设为 1 时生效。
取值范围：
  • 0：禁用。
  • 1：启用。外部接听方需在通话接通前按键确认接听，防止来电被语音信箱或其他自动系统应答。
enb_accept_call_from_rg 否 Integer

当分机处于特定状态时，是否接受响铃组来电。

取值范围：

  • 0：禁用
  • 1：启用
vm_greeting 否 String

在呼叫者留言前，系统向其播放的默认问候语。

取值范围：

  • follow_system：跟随系统设置 (在 呼叫功能 > 语音信箱 > 语音信箱设置 > 问候语选项 > 全局留言问候语 中设置)。
  • no_greeting：不播放提示音。
  • 其他值：语音信箱问候语的文件名 (如 demo.wav)。
    注： 可使用 查询分机语音信箱问候语列表 接口查询语音信箱问候语的文件名。
Linkus_Clients_Setting
参数 是否必填 类型 说明
id 是 Integer Linkus 客户端 ID。
注： 可使用 查询单个分机信息 接口查询分机 Linkus 客户端的 ID。
client 是 String

指定为哪个 Linkus 客户端配置呼叫等待、自动应答广播组来电、自动应答非广播组来电等功能。

取值范围：

  • linkusmobile：Linkus 手机端
  • linkusdesktop：Linkus 桌面端
  • linkusweb：Linkus 网页端
enb_call_waiting 否 Integer 当分机正在通话时，是否允许接收第二通来电。

取值范围：

  • 0：禁用
  • 1：启用
enb_auto_answer 否 Integer

是否允许自动接听非广播组来电。

取值范围：

  • 0：禁用
  • 1：启用
auto_answer_delay_time 否 Integer

非广播组来电在分机自动接听前的等待时长。 (单位：秒)。

取值范围：0 - 60
注： 0 表示非广播组来电将立即被自动接听。
enb_auto_answer_tone 否 Integer

是否播放提示音提醒分机用户非广播组来电已被自动接听。

取值范围：

  • 0：禁用
  • 1：启用
enb_auto_answer_paging 否 Integer 是否允许自动接听广播组来电。

取值范围：

  • 0：禁用
  • 1：启用
enb_auto_answer_paging_barge 否 Integer 正在通话时，是否允许自动接听广播组来电。

取值范围：

  • 0：禁用
  • 1：启用
enb_auto_answer_paging_tone 否 Integer 是否播放提示音提醒分机用户广播组来电已被自动接听。

取值范围：

  • 0：禁用
  • 1：启用
max_clients 是 Integer 可同时登录分机的 Linkus 客户端的最大数量。
取值范围：
  • 1
  • 2
  • 3
Missed_Call_Auto_Reply
参数 是否必填 类型 说明
call_status_list 是 Array<String> 触发自动消息回复的未接来电状态。

取值范围：

  • caller_abort：在来电响铃期间，主叫主动挂断呼叫。
  • voicemail：呼叫被前转至分机语音信箱。
  • group_vm：呼叫被前转至群语音信箱。
  • play_greeting_hangup：系统向主叫播放问候语，然后挂断呼叫。
  • busy：分机忙碌。
  • hangup：分机用户挂断呼叫。
enb_send_sms 否 Integer 是否启用通过 SMS 渠道自动回复消息。
注： 此参数在 enb_send_whatsapp 未设置或设置为 0 时必填。

取值范围：

  • 0：禁用
  • 1：启用
enb_send_whatsapp 否 Integer 是否启用通过 WhatsApp 渠道自动回复消息。
注： 此参数在 enb_send_sms 未设置或设置为 0 时必填。

取值范围：

  • 0：禁用
  • 1：启用
sms_config No Object <SMS_Channel_Auto_Reply> 自动回复 SMS 消息的配置。
注： 此参数在 enb_send_sms 设置为 1 时必填。
whatsapp_config No Object <WhatsApp_Channel_Auto_Reply> 自动回复 WhatsApp 消息的配置。
注： 此参数在 enb_send_whatsapp 设置为 1 时必填。

SMS_Channel_Auto_Reply

参数 是否必填 类型 说明
content 是 String 要发送的内容。
注： 最大字符长度为 1600。
did_id 是 Integer SMS 消息渠道的 DID 号码。
注：
  • 可使用 获取菜单选项 接口查询 SMS 消息渠道可用的 DID 号码 ("menu":"message_channel")。
  • 此参数必须为允许该分机创建消息会话的渠道关联的 DID 号码。
msg_type 否 Integer SMS 消息的类型。

取值范围：

  • 1：文本。

WhatsApp_Channel_Auto_Reply

参数 是否必填 类型 说明
did_id 是 Integer WhatsApp 消息渠道的 DID 号码。
注：
  • 可使用 获取菜单选项 接口查询 WhatsApp 消息渠道可用的 DID 号码 ("menu":"message_channel")。
  • 此参数必须为允许该分机创建消息会话的渠道关联的 DID 号码。
template_params 是 String WhatsApp 消息模板的 JSON 内容。
注： 可使用 获取 WhatsApp 消息模板 接口查询完整的 JSON 内容。

响应参数

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

示例

请求示例

修改分机 2000 的呼出路由权限 (ID: "39")。

POST /openapi/v1.0/extension/update?access_token=5SwyByhbSfsNlpI1v4GtHxEDmKsZwzjQ HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "id":39,
    "outbound_route_permission":[69,70,73]
}

响应示例

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