查询坐席状态接口说明

1.接口简介

查询某个指定坐席的通话状态,登录状态和自定义状态

2.接口请求

  • HTTP请求方式:POST

  • 请求链接:{HOST}/v20160818/user/queryUserState/ACCOUNTID?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

  • 频次限制:100次/分钟

3.接口参数如下

字段 类型 是否必须 备注
exten String 坐席号,一般为8000,8001,8002等

请求体示例

{
    "exten":"8000"
}

4.系统返回

字段 含义
code 响应码
message 响应信息
data 返回数据,JSON格式

data:

flag 状态标记值
signout:签出
Reserve:离线接听
signoutcalling:正在通话且坐席是签出状态
0:空闲
1:忙碌
2:小休
99:正在通话
3-9:自定义状态
state 状态

code:

代码 含义
200 请求成功
210 坐席不存在
400 请求体参数错误
403 鉴权参数错误
500 服务器错误

返回200示例

{
    "code": 200,
    "data": {
        "flag": "signout",
        "state": "签出"
    }
}

返回210示例:

{
    "code": 210,
    "message": "user not exist"
}

返回400示例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回403示例:

{
    "code": 403,
    "message": "Forbidden"
}

返回500示例:

{
    "code": 500,
    "message": "Internal Server Error"
}