编辑分机设置

更改分机的配置,如:分机号、分机名、同时注册数、邮箱、移动分机等。

Endpoint

POST /api/v1.1.0/extension/update?token={token}

请求参数

名称 是否必需 类型 描述
extid Int 要修改配置的分机号。
extnumber Int 修改后的分机号。
username String 用户名。
callerid String 分机来电显示名称。
registername String 注册名称。
registerpassword String 注册密码。
maxregistrations Int 同时注册数。
loginpassword String 用户密码。
email String 邮件地址。
mobile String 电话号码。
hasvoicemail String 语音邮箱功能。
  • on:开启 。
  • off:关闭。
vmsecret Int 语音邮箱密码。
enablevmtoemail String 是否发送语音邮件到邮箱。
  • on:开启 。
  • off:关闭。
alwaysforward String 总是转移。
  • on:开启 。
  • off:关闭。
atransferto String 总是转移目的地。
  • Voicemail:语音信箱。
  • Extension:分机。
  • Mobile Number:用户手机。
  • Custom Number:自定义号码。
atransferext String 目的地为分机时的分机号。
atransferprefix String 目的地为自定义号码或用户手机时的呼出前缀。
限制: 数字,最大7位。
atransfernum String 目的地为自定义号码或用户手机时的呼出号码。
限制: 数字,最大15位,转移目的地 Custom Number 不为空。
noanswerforward String 无应答转移。
  • on:开启。
  • off:关闭。
ntransferto String 无应答转移目的地。
  • Voicemail:语音信箱。
  • Extension:分机。
  • Mobile Number:用户手机。
  • Custom Number:自定义号码。
ntransferext String 目的地为分机时的分机号。
ntransferprefix String 目的地为自定义号码或用户手机时的呼出前缀。
ntransfernum String 目的地为自定义号码或用户手机时的号码。
busyforward String 忙时转移。
  • on:开启。
  • off:关闭。
btransferto String 忙时转移目的地。
  • Voicemail:语音信箱。
  • Extension:分机。
  • Mobile Number:用户手机。
  • Custom Number:自定义号码。
btransferext String 目的地为分机时的分机号。
btransferprefix String 目的地为自定义号码或用户手机时的呼出前缀。
限制: 数字,最大7位。
btransfernum String 目的地为自定义号码或用户手机时的呼出号码。
限制: 数字,最大15位,转移目的地Custom Number不为空。
allowbeingmonitored String 允许被监听。
  • on:开启。
  • off:关闭。
monitormode String 监听模式。
  • Disabled:禁用。
  • Extensive:通用模式。
  • Listen:普通监听。
  • Whisper:密语监听。
  • Barge-in:强插监听。
ringtimeout String 响铃超时。
  • 15
  • 30
  • 60
  • 120
  • 300
maxduration String 最大通话时长。
  • Follow System:系统默认值。
  • Unlimited:无限制。
  • 60
  • 300
  • 600
  • 900
  • 1800
  • 3600
  • 6000
dnd String 免打扰功能。
  • on:开启。
  • off:关闭。
callrestriction String 外呼限制。
  • on:开启。
  • off:关闭。
agentid String 报工号时要播报的号码。此参数默认为空,表示播报分机号。
selectoutroute String 选择分机的呼出路由。从 unselectoutroute 中选择一个呼出路由。selectoutroute 最多支持4096个字符。

实际示例

请求示例

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

POST /api/v1.1.0/extension/update?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "extid": "1002",
    "username": "Amy"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}