编辑分机

编辑分机配置。

请求 URL

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

请求参数

1.
参数 是否必填 类型 说明
id Integer 分机的唯一 ID。
注: 可使用 搜索特定分机 接口搜索分机 ID。
first_name String 名称。
last_name String 姓氏。
email_addr String 邮箱地址。
mobile_number String 手机号码。
user_password String 用户密码。
注:
  • 必须包含数字、大写字母和小写字母。
  • 最小字符长度要求 10;最大字符长度限制为 63。
role_id Integer 分机用户角色 ID。
注: 可使用 获取菜单选项 接口查询用户角色的 ID。
organization_list Array <Organization_Info> 分机所属部门。
注: 如果启用 部门管理 功能,此参数为必填项。
title String 分机用户的职位。
caller_id String 显示号码。
注:
  • 允许填写数字、字母和符号 ( ) . - + * #
  • 最大字符长度限制为 31。
reg_name String 认证名称。
注: 最大字符长度限制为 63。
reg_password String 注册密码。
注: 最小字符长度要求 8;最大字符长度限制为 63。
concurrent_registrations Integer IP 话机同时注册数。

取值范围

  • 1 (默认)
  • 2
  • 3
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_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 协议
enb_qualify Integer 是否启用 Qualify 功能。
  • 0:禁用
  • 1:启用
enb_t38_support Integer 是否启用 支持 T.38 功能。

取值范围

  • 0:禁用
  • 1:启用
enb_nat Integer 是否启用 NAT 功能。

取值范围

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

取值范围

  • 0:禁用
  • 1:启用
allow_reg_remotely Integer 是否启用 允许远程注册

取值范围

  • 0:禁用
  • 1:启用
disable_outb_call Integer 是否允许拨打外线电话。

取值范围

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

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

取值范围

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

取值范围

  • 0:允许拨打国际电话。
  • 1:禁止拨打国际电话。
outbound_route_permission Array <Integer> 允许分机使用的呼出路由的唯一 ID。
注:
enb_internal_client Integer 是否启用 Linkus 呼叫功能。
注: 若启用,分机用户可以登录并使用 Linkus 手机端、桌面端和网页端。

取值范围

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

取值范围

  • ulaw
  • alaw
  • ilbc
  • g722
  • g729
enb_ice No String

是否为 Linkus 手机端启用 ICE (Interactive Connectivity Establishment, 交互式连接创建) 功能。

取值范围

  • yes:启用 ICE。
  • no:禁用 ICE。
Organization_Info
2.
参数 是否必填 类型 说明
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
  • ring_group:响铃组
  • queue:队列
  • group_vm:群语音信箱
  • mobile_number:手机号码
  • external_num:外部号码
  • play_greeting:播放问候语后挂断
  • end_call:挂断
注: 当目的地类型为 ext_vmmobile_number 时,系统会自动从分机信息中获取对应的目的地信息。
in_always_forward_prefix String 此参数的设置取决于内部来电 总是 前转的目的地类型。
  • 当目的地类型为 mobile_numberexternal_num 时,此参数用于指定外部目的地号码的拨号前缀。
  • 当目的地类型为 play_greeting 时,此参数用于指定问候语的播放次数,其取值范围为 1 - 5。
in_always_forward_value String 内部来电 总是 前转的目的地。

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
in_always_forward_num String 内部来电 总是 前转目的地 external_num 的外部号码。
enb_in_no_answer_forward Integer 是否在分机无应答时将内部来电转移到指定目的地 (无应答 前转)。

取值范围

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

取值范围

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

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
in_no_answer_forward_num String 内部来电 无应答 前转目的地 external_num 的外部号码。
enb_in_busy_forward Integer 是否在分机忙时将内部来电转移到指定目的地 (忙时 前转)。

取值范围

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

取值范围

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

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
in_busy_forward_num String 内部来电 忙时 前转目的地 external_num 的外部号码。
enb_ex_always_forward Integer 是否将所有外部来电都转移到指定目的地 (总是 前转)。

取值范围

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

取值范围

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

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
ex_always_forward_num String 外部来电 总是 前转目的地 external_num 的外部号码。
enb_ex_no_answer_forward Integer 是否在分机无应答时将外部来电转移到指定目的地 (无应答 前转)。

取值范围

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

取值范围

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

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
ex_no_answer_forward_num String 外部来电 无应答 前转目的地 external_num 的外部号码。
enb_ex_busy_forward Integer 是否在分机忙时将外部来电转移到指定目的地 (忙时 前转)。

取值范围

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

取值范围

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

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

  • 当目的地类型为 play_greeting,此参数用于指定自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionivrring_groupqueuegroup_vm,此参数用于指定目的地的 ID。
    例如:目的地为分机 2002,则该参数需为分机 2002 的 ID 2
    注:
ex_busy_forward_num String 外部来电 忙时 前转目的地 external_num 的外部号码。
ring_timeout Integer 来电响铃超时时间 (单位:秒)。
enb_ring_mobile Integer 分机响铃时,手机是否同时响铃。

取值范围

  • 0:禁用
  • 1:启用

响应参数

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

示例

请求示例

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

POST /openapi/v1.0/extension/update?access_token=5SwyByhbSfsNlpI1v4GtHxEDmKsZwzjQ HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "id":39,
    "outbound_route_permission":[69,70,73]
}

响应示例

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