添加分机
添加并配置 SIP 分机。
请求 URL
POST {base_url}/{api_path}/extension/create?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
type | 是 | String | 分机类型。 取值范围: |
first_name | 否 | String | 名称。 |
last_name | 否 | String | 姓氏。 |
email_addr | 否 | String | 邮箱地址。 |
mobile_number | 否 | String | 手机号码。 |
user_password | 是 | String | 用户密码。 注:
|
role_id | 否 | Integer | 分机用户角色的唯一 ID。 注: 可使用 获取菜单选项 接口查询用户角色的
ID。 |
organization_list | 否 | Array <Organization_Info> | 分机所属部门。 注: 如果启用 部门管理
功能,此参数为必填项。
|
title | 否 | String | 分机用户的职位。 |
number | 是 | String | 分机号码。 注:
|
caller_id | 否 | String | 显示号码。 注:
|
reg_name | 是 | String | 认证名称。 注: 最大字符长度限制为 63。 |
reg_password | 是 | String | 注册密码。 注:
|
concurrent_registrations | 是 | Integer | IP 话机同时注册数。 取值范围:
|
presence_status | 是 | String | 分机当前的在线状态。 取值范围:
|
presence_list | 否 | Array <Presence_Setting> | 在线状态设置列表。 |
presence_mobile_prefix | 否 | String | “手机号码同时响铃” 功能的手机号码拨号前缀。 |
agent_id | 否 | String |
分机作为队列坐席接听来电后,系统向呼叫者播报的坐席工号。 默认播报分机号作为坐席的工号。 注: 在 PBX 网页上为队列启用
播报坐席工号 功能(路径: )后,才会播报队列坐席的工号。
|
enb_vm | 否 | Integer | 是否启用语音信箱。 取值范围:
|
enb_vm_pin | 否 | Integer | 是否启用语音信箱 PIN 码认证。 取值范围:
|
vm_pin | 否 | String | 用于访问语音信箱的 PIN 码。 |
vm_lang | 否 | String | 分机语音信箱使用的系统提示音语言。 取值范围: 注: 确保 PBX 上存在所需的语言 (路径: )。
|
new_vm_notification | 否 | String | 收到新语音留言时是否通知分机,以及如何通知。 取值范围:
|
vm_after_notification | 否 | String | 发送通知邮件后如何处理语音留言。 取值范围:
|
enb_all_reject_mode_for_endpoints | 否 | Integer | 是否在注册了分机的其中一个终端上拒接来电后,停止响铃其他终端。 取值范围:
|
dtmf_mode | 否 | String | DTMF 模式。 取值范围:
|
transport | 否 | String | 传输协议。 取值范围:
|
enb_qualify | 否 | Integer | 是否启用 Qualify 功能。
|
enb_t38_support | 否 | Integer | 是否启用 支持 T.38 功能。 取值范围:
|
enb_srtp | 否 | Integer | 是否启用 语音加密 (SRTP)
功能。 取值范围:
|
disable_outb_call | 否 | Integer | 是否允许拨打外线电话。 取值范围:
|
disable_outb_call_outside_business_hours | 否 | Integer |
是否允许非办公时间拨打外线电话。 取值范围:
|
disable_international_call | 否 | Integer | 是否允许拨打国际电话。 取值范围:
|
outbound_route_permission | 否 | Array <Integer> | 允许分机使用的呼出路由的唯一 ID。 注:
|
enb_internal_client | 否 | Integer | 是否启用 Linkus 呼叫功能。 注:
取值范围:
|
linkus_mobile_codec | 否 | String | 为 Linkus 手机端配置编解码。 取值范围:
|
client_conf_list | 否 | Array <Linkus_Clients_Setting> | Linkus 客户端配置项。 |
- 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
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
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
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
in_no_answer_forward_num 否 String 内部来电 无应答 前转目的地 external_num
的外部号码。enb_in_busy_forward 否 Integer 是否在分机忙时将内部来电转移到指定目的地 (忙时 前转)。 取值范围:
0
:禁用1
:启用
in_busy_forward_dest 否 String 内部来电 忙时 前转的目的地类型。 取值范围:
extension
:分机ext_vm
:分机语音信箱ivr
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
in_busy_forward_num 否 String 内部来电 忙时 前转目的地 external_num
的外部号码。enb_ex_always_forward 否 Integer 是否将所有外部来电都转移到指定目的地 (总是 前转)。 取值范围:
0
:禁用1
:启用
ex_always_forward_dest 否 String 外部来电 总是 前转的目的地类型。 取值范围:
extension
:分机ext_vm
:分机语音信箱ivr
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
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
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
ex_no_answer_forward_num 否 String 外部来电 无应答 前转目的地 external_num
的外部号码。enb_ex_busy_forward 否 Integer 是否在分机忙时将外部来电转移到指定目的地 (忙时 前转)。 取值范围:
0
:禁用1
:启用
ex_busy_forward_dest 否 String 外部来电 忙时 前转的目的地类型。 取值范围:
extension
:分机ext_vm
:分机语音信箱ivr
: IVRring_group
:响铃组queue
:队列group_vm
:群语音信箱mobile_number
:手机号码external_num
:外部号码play_greeting
:播放问候语后挂断end_call
:挂断
注: 当目的地类型为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。
ex_busy_forward_num 否 String 外部来电 忙时 前转目的地 external_num
的外部号码。ring_timeout 是 Integer 来电响铃超时时间 (单位:秒)。 取值范围: 5 - 300
enb_ring_mobile 否 Integer 分机响铃时,手机是否同时响铃。 取值范围:
0
:禁用1
:启用
- Linkus_Clients_Setting
-
参数 是否必填 类型 说明 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
:启用
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
id | Integer | 分机的唯一 ID。 |
示例
请求示例
POST /openapi/v1.0/extension/create?access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz
Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
"type": "SIP",
"first_name": "Terrell",
"last_name": "Smith",
"email_addr": "terrell@sample.com",
"mobile_number": "15880987652",
"user_password": "Userpwd1011",
"organization_list":[{"value":"1"},{"value":"2"}],
"role_id": 1,
"number": "1000",
"caller_id": "5503301",
"reg_name": "demo_ext",
"reg_password": "Regpwd1011",
"concurrent_registrations": 1,
"presence_status": "available",
"enb_all_reject_mode_for_endpoints":1,
"dtmf_mode": "rfc4733",
"transport": "udp",
"agent_id":"5630",
"enb_vm":1,
"enb_vm_pin":1,
"vm_pin":"8573",
"new_vm_notification":"with_attach",
"vm_after_notification":"delete",
"enb_all_reject_mode_for_endpoints":0,
"disable_international_call":1,
"disable_outb_call_outside_business_hours":1,
"disable_outb_call":0,
"outbound_route_permission":[69],
"enb_internal_client":1,
"linkus_mobile_codec": "g729",
"presence_mobile_prefix": "86",
"presence_list": [
{
"status": "available",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "external_num",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "123123",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ivr",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "1",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "end_call",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 1,
"ring_timeout": 30
},
{
"status": "away",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ring_group",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "1",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "queue",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "1",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "group_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "1",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "play_greeting",
"ex_busy_forward_prefix": "1",
"ex_busy_forward_value": "demo.wav",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30
},
{
"status": "business_trip",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "mobile_number",
"in_no_answer_forward_prefix": "123",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "external_num",
"in_busy_forward_prefix": "543",
"in_busy_forward_value": "",
"in_busy_forward_num": "5235235235",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "group_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "1",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30
},
{
"status": "do_not_disturb",
"enb_in_always_forward": 1,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 1,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30
},
{
"status": "lunch",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 1,
"ring_timeout": 30
},
{
"status": "off_work",
"enb_in_always_forward": 0,
"in_always_forward_dest": "ext_vm",
"in_always_forward_prefix": "",
"in_always_forward_value": "",
"in_always_forward_num": "",
"enb_in_no_answer_forward": 1,
"in_no_answer_forward_dest": "ext_vm",
"in_no_answer_forward_prefix": "",
"in_no_answer_forward_value": "",
"in_no_answer_forward_num": "",
"enb_in_busy_forward": 1,
"in_busy_forward_dest": "ext_vm",
"in_busy_forward_prefix": "",
"in_busy_forward_value": "",
"in_busy_forward_num": "",
"enb_ex_always_forward": 0,
"ex_always_forward_dest": "ext_vm",
"ex_always_forward_prefix": "",
"ex_always_forward_value": "",
"ex_always_forward_num": "",
"enb_ex_no_answer_forward": 1,
"ex_no_answer_forward_dest": "ext_vm",
"ex_no_answer_forward_prefix": "",
"ex_no_answer_forward_value": "",
"ex_no_answer_forward_num": "",
"enb_ex_busy_forward": 1,
"ex_busy_forward_dest": "ext_vm",
"ex_busy_forward_prefix": "",
"ex_busy_forward_value": "",
"ex_busy_forward_num": "",
"enb_ring_mobile": 0,
"ring_timeout": 30
}
],
"client_conf_list": [
{
"client": "linkusweb",
"enb_call_waiting": 1,
"enb_auto_answer": 0,
"enb_auto_answer_paging": 1,
"enb_auto_answer_paging_barge": 0,
"enb_auto_answer_paging_tone": 1
},
{
"client": "linkusdesktop",
"enb_call_waiting": 1,
"enb_auto_answer": 1,
"auto_answer_delay_time": 10,
"enb_auto_answer_tone": 1,
"enb_auto_answer_paging": 0,
"enb_auto_answer_paging_barge": 0,
"enb_auto_answer_paging_tone": 1
},
{
"client": "linkusmobile",
"enb_call_waiting": 0,
"enb_auto_answer": 1,
"auto_answer_delay_time": 5,
"enb_auto_answer_tone": 1,
"enb_auto_answer_paging": 1,
"enb_auto_answer_paging_barge": 1,
"enb_auto_answer_paging_tone": 1
}
]
}
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"id": 233
}