查询分机详情

查询单个分机、多个分机或所有分机的详细配置。

请求地址

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

请求参数

参数 是否必选 类型 描述
number 是 String 分机号码。
取值范围：
  • 单个分机号码：查询指定分机。

    例如："number":"1000"

  • 多个分机号码：查询多个分机。多个分机号码用半角逗号（,）隔开。

    例如："number":"1000,1001"

  • all：查询所有分机。

    例如："number":"all"

响应参数

参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。
extinfos Array<ExtensionInfo> 分机信息。
ExtensionInfo
参数 类型 描述
number String 分机号码。
username String 用户名。
status String 分机当前状态。
  • Unavailable：不可用。
  • Registered：已注册。
  • Ringing：响铃。
  • Busy：忙线。
  • Hold：通话保持。
  • Malfunction：故障。
  • Idle：空闲。
  • Fxsnoport
type String 分机类型。
port String FXS 分机端口号。
callerid String 来电显示号码。
registername String 注册名称。
registerpassword String 注册密码。
maxregistrations Integer 同时注册数。
loginpassword String 用户密码。
email String 邮箱地址。
mobile Integer 手机号码。
language String 提示音语言。
hasvoicemail String 是否启用 启用语音邮箱 功能。
  • on：开启。
  • off：关闭。
enablevmtoemail String 是否启用 发送语音留言到邮箱 功能。
  • off：关闭。
  • on：开启。发送语音留言到分机用户邮箱。
  • custom：发送语音留言到自定义邮箱。
vmsecret Integer 语音信箱密码。
alwaysforward String 是否启用 总是呼叫转移 功能。
  • on：开启。
  • off：关闭。
atransferto String alwaysforward 的目的地。
  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。
atransferext Integer atransferto 为 Extension 时，设置分机的号码。
atransferprefix Integer atransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
atransfernum String atransferto 为 Custom Number 时，设置呼出号码。
noanswerforward String 是否启用 无应答呼叫转移 功能。
  • on：开启。
  • off：关闭。
ntransferto String noanswerforward 的目的地。
  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。
ntransferext Integer ntransferto 为 Extension 时，设置分机的号码。
ntransferprefix String ntransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
ntransfernum String ntransferto 为 Custom Number 时，设置呼出号码。
busyforward String 是否启用 忙时呼叫转移 功能。
  • on：开启。
  • off：关闭。
btransferto String busyforward 的目的地。
  • Voicemail：语音信箱。
  • Extension：分机。
  • Mobile Number：用户手机。
  • Custom Number：自定义号码。
btransferext Integer btransferto 为 Extension 时，设置分机的号码。
btransferprefix String btransferto 为 Mobile Number 或 Custom Number 时的呼出前缀。
btransfernum String btransferto 为 Custom Number 时，设置呼出号码。
ringsimultaneous String 是否启用 同时响铃 功能。
  • on：开启。
  • off：关闭。
enablemobile String 是否启用 启用移动分机 功能。
  • on：开启。
  • off：关闭。
mobileprefix Integer 移动分机呼出前缀。
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。
unselectoutroute String 分机不可用的呼出路由。
selectoutroute String 分机可用的呼出路由。

示例

请求示例

查询分机1001的详细配置。

POST /api/v2.0.0/extension/query?token=309bcf2d729fc93e20eafc803a23b76d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "number": "1001" 
}
响应示例
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",
	"extinfos": [
		{
			"number": "1001",
			"username": "1001",
			"status": "Registered",
			"type": "SIP",
			"callerid": "1001",
			"registername": "1001",
			"registerpassword": "f2844e41123368345574515f8eaf6595a0a05e50c9d7d16690622ed2ea6965f0",
			"maxregistrations": "1",
			"loginpassword": "81d3f187d07d54e2e48b217b62e8436a36d1eb75c5845d4509ac2d14bdeebd97107ab5bbd60c3d8cbfbd0f205b4b655a",
			"email": "ann@yeastar.com",
			"moblie": "18508937881",
			"language": "System Default",
			"hasvoicemail": "on",
			"enablevmtoemail": "off",
			"vmsecret": "1001",
			"alwaysforward": "off",
			"noanswerforward": "on",
			"ntransferto": "Voicemail",
			"ntransferprefix": "9",
			"busyforward": "on",
			"btransferto": "Voicemail",
			"btransferprefix": "9",
			"ringsimultaneous": "off",
			"mobileprefix": "9",
			"enablemobile": "off",
			"allowbeingmonitored": "off",
			"monitormode": "Disabled",
			"ringtimeout": "30",
			"maxduration": "Follow System",
			"dnd": "off",
			"callrestriction": "off",
			"agentid": "none",
			"unselectoutroute": "local_calls",
			"selectoutroute": "routeout"
		}
	]
}