坐席上下班
接口描述
坐席上班/下班。上线状态由云端维系，小程序切后台或被回收不影响在线状态；设备来电只分配给已上班的坐席。
请求说明
| 接口ID |
协议 |
方法 |
PATH |
| 92 |
HTTPS |
PUT |
/openapi/v1/voip/agent/status |
PATH参数
无
URL参数
| 参数 |
类型 |
必填 |
说明 |
| accesskey_id |
string |
是 |
参见签名认证 |
| expires |
int |
是 |
参见签名认证 |
| signature |
string |
是 |
参见签名认证 |
HTTP请求头
| 名称 |
必填 |
说明 |
| Content-Type |
是 |
application/json |
| X-Agent-Token |
是 |
坐席登录返回的 token |
请求参数
| 参数 |
类型 |
必填 |
说明 |
| online |
boolean |
是 |
true 上班，false 下班 |
请求示例
PUT https://open.vzicloud.com/openapi/v1/voip/agent/status?accesskey_id=8d9EsDAD2115Q5PM8tuP6g1IdAglkayp&expires=1619022787&signature=G29eTBjMm0gZF7cpXNLX7Hrn0yM%3D HTTP/1.1
Content-Type: application/json
X-Agent-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.***
{
"online": true
}
返回说明
返回参数
| 参数 |
类型 |
说明 |
| online |
bool |
当前在线状态 |
| sip_registered |
bool |
SIP 是否已注册 |
| sip_status |
string |
SIP 状态：offline / registering / registered |
| sip_error |
string |
SIP 注册失败时给出原因（仅失败时返回） |
错误码
错误码定义参见错误码。本接口特有的业务错误（上班时的拒绝场景）：
| HTTP 状态 |
code |
说明 |
| 400 |
1005 |
未绑定微信，无法上班；通话中，请先挂断；账号已禁用 |
返回示例
{
"online": true,
"sip_registered": true,
"sip_status": "registered"
}