主动呼叫设备
接口描述
坐席主动呼叫指定设备。接口返回 payload 后,由小程序调 wmpfVoip.callDevice 建房完成呼叫(完整流程参见小程序对讲开发指南)。
前置条件:坐席已上班;设备的「默认呼叫号码」授权本坐席或其所在呼叫中心。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 94 |
HTTPS |
POST |
/openapi/v1/voip/agent/call |
PATH参数
无
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
HTTP请求头
| 名称 |
必填 |
说明 |
| Content-Type |
是 |
application/json |
| X-Agent-Token |
是 |
坐席登录返回的 token |
请求参数
| 参数 |
类型 |
必填 |
说明 |
| device_sn |
string |
是 |
设备 SN |
请求示例
POST https://open.vzicloud.com/openapi/v1/voip/agent/call?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Content-Type: application/json
X-Agent-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.***
{
"device_sn": "12345678901234"
}
返回说明
返回参数
| 参数 |
类型 |
说明 |
| allowed |
bool |
是否允许呼叫(成功时为 true) |
| payload |
string |
透传给 wmpfVoip.callDevice 的 payload 参数(含环境前缀,原样使用,勿做任何修改) |
| device |
object |
被叫设备信息 |
| device.sn |
string |
设备 SN |
| device.display_name |
string |
设备显示名称 |
错误码
错误码定义参见错误码。本接口特有的业务错误:
| HTTP 状态 |
code |
说明 |
| 400 |
1005 |
请先上班;设备不存在;无权呼叫该设备(设备分机的默认呼叫号码未授权本坐席) |
返回示例
{
"allowed": true,
"payload": "vz***",
"device": {
"sn": "12345678901234",
"display_name": "门口机-1"
}
}