添加分机

添加并设置分机。

请求地址

{base_url}/{api_path}/extension/add?token={token}

请求参数

参数 是否必选 类型 描述
number 是 String 分机号码。
注：
  • 只允许输入数字。
  • 最大长度为7位。
username 是 String 显示名称。
注： 不允许输入以下字符：! % . @ : ; & " ' \ < >` $
registername 是 String 注册名称。
注：
  • 只允许输入字母、数字。
  • 最大长度为31位。
registerpassword 是 String 注册密码。
注： 只允许输入字母、数字和以下字符：~ ^ * - _ ?
默认使用强密码。
  • 必须包含数字（非连续）、大小写字母等。
  • 密码长度大于16位。
  • 不得包含该分机的“分机号码”、“显示名称”。
callerid 否 String 显示号码。
注：
  • 只允许输入字母、数字。
  • 最大长度31位。

默认值：同分机号码。
maxregistrations 否 Integer 同时注册数。

取值范围：1~5

默认值：1
loginpassword 否 String 用户密码。
注： 只允许输入字母、数字和以下字符：~ ^ * - _ ?
默认使用强密码。
  • 必须包含数字（非连续）、大小写字母等。
  • 密码长度大于10位。
  • 不得包含该分机的“分机号码”、“显示名称”。
email 否 String 邮箱地址。
注：
  • 须符合邮箱地址格式。
  • 不允许输入空格和以下字符：# ; , [ ] = & " ' \ <> ` $
mobile 否 Integer 手机号码。
注：
  • 启用 启用移动分机 功能或设置呼叫转移目的地为 用户手机 时，此项不为空。
  • 只允许输入数字。
  • 最大长度31位。
hasvoicemail 否 String 是否启用 启用语音邮箱 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：on。
vmsecret 否 Integer 语音信箱密码。
注：
  • 只允许输入数字。
  • 最大长度63位。

默认值：同分机号码。
enablevmtoemail 否 String 是否启用 发送语音留言到邮箱 功能。

取值范围：

  • off：关闭。
  • on：开启。发送语音留言到分机用户邮箱。
  • custom：发送语音留言到自定义邮箱。

默认值：off。
alwaysforward 否 String 是否启用 总是呼叫转移 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
atransferto 否 String alwaysforward 的目的地。

取值范围：

  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。
atransferext 否 Integer atransferto 为 Extension 时，设置分机的号码。
atransferprefix 否 Integer atransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
注：
  • 只允许输入数字。
  • 最大长度7位。
atransfernum 否 Integer atransferto 为 Custom Number 时，设置呼出号码。
注：
  • 只允许输入数字。
  • 最大长度15位。
noanswerforward 否 String 是否启用 无应答呼叫转移 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：on。
ntransferto 否 String noanswerforward 的目的地。

取值范围：

  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。

默认值：Voicemail。
ntransferext 否 Integer ntransferto 为 Extension 时，设置分机的号码。
ntransferprefix 否 Integer ntransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
注：
  • 只允许输入数字。
  • 最大长度7位。
ntransfernum 否 Integer ntransferto 为 Custom Number 时，设置呼出号码。
注：
  • 只允许输入数字。
  • 最大长度15位。
busyforward 否 String 是否启用 忙时呼叫转移 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：on。
btransferto 否 String busyforward 的目的地。

取值范围：

  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。

默认值：Voicemail。
btransferext 否 Integer btransferto 为 Extension 时，设置分机的号码。
btransferprefix 否 Integer btransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
注：
  • 只允许输入数字。
  • 最大长度7位。
btransfernum 否 Integer btransferto 为 Custom Number 时，设置呼出号码。
注：
  • 只允许输入数字。
  • 最大长度15位。
ringsimultaneous 否 String 是否启用 同时响铃 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
enablemobile 否 String 是否启用 启用移动分机 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
mobileprefix 否 Integer 移动分机呼出前缀。
allowbeingmonitored 否 String 是否启用 允许被监听 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
monitormode 否 String 监听模式。

取值范围：

  • Disabled：禁用。
  • Extensive：通用模式。
  • Listen：普通监听。
  • Whisper：密语监听。
  • Barge-in：强插监听。

默认值：Disabled。
ringtimeout 否 Integer 响铃超时时间。单位：秒。

默认值：30。
maxduration 否 String 最大通话时长。单位：秒。

默认值：Follow System。
dnd 否 String 是否启用 免打扰 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
callrestriction 否 String 是否启用 外呼限制 功能。

取值范围：

  • on：开启。
  • off：关闭。

默认值：off。
agentid 否 String 用户呼入队列后，系统播报的坐席工号。此参数默认为空，表示播报分机号作为坐席的工号。
提示： 调用 extension/update 接口可以编辑分机的 agentid。
selectoutroute 否 String 选择分机可用的呼出路由。

响应参数

参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。

示例

请求示例

添加分机5000。

POST /api/v2.0.0/extension/add?token=721eebe15cb3c27b60daeb1f120f0c05
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "5000",
	"username": "5000",
	"registername": "5000",
	"registerpassword": "v0S*ZrB6Y3g~1-oe"
}
响应示例
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}