查询坐席状态
接口描述
查询当前坐席（由 X-Agent-Token 指定）的在线与通话状态。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 91 |
HTTPS |
GET |
/openapi/v1/voip/agent/status |
PATH参数
无
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
HTTP请求头
| 名称 |
必填 |
说明 |
| X-Agent-Token |
是 |
坐席登录返回的 token |
请求示例
GET https://open.vzicloud.com/openapi/v1/voip/agent/status?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
X-Agent-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.***
返回说明
返回参数
| 参数 |
类型 |
说明 |
| online |
bool |
是否已上班 |
| sip_registered |
bool |
SIP 是否已注册 |
| sip_status |
string |
SIP 状态：offline / registering / registered |
| in_call |
bool |
是否通话中 |
返回示例
{
"online": true,
"sip_registered": true,
"sip_status": "registered",
"in_call": false
}