修改分机

修改分机的配置,如:分机名称、同时注册数、邮箱地址等。

请求地址

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

请求参数

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

取值范围

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

取值范围

  • on:开启。
  • off:关闭。
vmsecret Integer 语音信箱密码。
注:
  • 只允许输入数字。
  • 最大长度63位。
enablevmtoemail String 是否启用 发送语音留言到邮箱 功能。

取值范围

  • off:关闭。
  • on:开启。发送语音留言到分机用户邮箱。
  • custom:发送语音留言到自定义邮箱。
alwaysforward String 是否启用 总是呼叫转移 功能。

取值范围

  • on:开启。
  • off:关闭。
atransferto String alwaysforward 的目的地。

取值范围

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

取值范围

  • on:开启。
  • off:关闭。
ntransferto String noanswerforward 的目的地。

取值范围

  • Voicemail:语音信箱。
  • Extension:分机。
  • Mobile Number:用户手机。
  • Custom Number:自定义号码。
ntransferext Integer ntransfertoExtension 时,设置分机的号码。
ntransferprefix Integer ntransfertoMobile NumberCustom Number 时的呼出前缀。
注:
  • 只允许输入数字。
  • 最大长度7位。
ntransfernum Integer ntransfertoCustom Number 时,设置呼出号码。
注:
  • 只允许输入数字。
  • 最大长度15位。
busyforward String 是否启用 忙时呼叫转移 功能。

取值范围

  • on:开启。
  • off:关闭。
btransferto String busyforward 的目的地。

取值范围

  • Voicemail:语音信箱。
  • Extension:分机。
  • Mobile Number:用户手机。
  • Custom Number:自定义号码。
btransferext Integer btransfertoExtension 时,设置分机的号码。
btransferprefix Integer btransfertoMobile NumberCustom Number 时的呼出前缀。
注:
  • 只允许输入数字。
  • 最大长度7位。
btransfernum Integer btransfertoCustom Number 时,设置呼出号码。
注:
  • 只允许输入数字。
  • 最大长度15位。
allowbeingmonitored String 是否启用 允许被监听 功能。

取值范围

  • on:开启。
  • off:关闭。
monitormode String 监听模式。

取值范围

  • Disabled:禁用。
  • Extensive:通用模式。
  • Listen:普通监听。
  • Whisper:密语监听。
  • Barge-in:强插监听。
ringtimeout Integer 响铃超时时间。单位:秒。
maxduration String 最大通话时长。单位:秒。
dnd String 是否启用 免打扰 功能。

取值范围

  • on:开启。
  • off:关闭。
callrestriction String 是否启用 外呼限制 功能。

取值范围

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

响应参数

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

示例

请求示例

将分机1002的用户名修改为 Amy,其他信息不变。

POST /api/v2.0.0/extension/update?token=7afa377107feb9566654d5dd3a9a2a93
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "1002",
	"username": "Amy"
}
响应示例
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"
}