查询坐席接口说明

1.接口简介

查询坐席的相关信息。可以查询指定坐席工号的坐席信息,也可以查询账号下所有坐席的信息

2.接口请求

  • HTTP请求方式:POST

  • 请求地址:{HOST}/v20160818/account/getCCAgentsByAcc/ACCOUNTID?sig=sig

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

  • 请求频次限制:20次/分钟

  • 鉴权文档:接口鉴权

3.接口参数如下:

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

请求体示例

{
    "Exten":"8000"
}

4.系统返回

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

data:

_id 座席的ID
displayName 座席姓名
exten 座席工号
loginName 座席登陆呼叫中心用户名,都与工号一致
password 座席登陆呼叫中心密码
pbx 座席所属的pbx
mobile 座席绑定的手机
email 座席绑定的邮箱
status 座席状态,启用或者停用(enable/disable)
uversion 座席版本,标准版/外呼版/监控版(enterprise/outcall/monitor)
callerIDNum 座席外呼透传号,如果此字段没有,此座席外呼时使用,账号总透传号。可以用此字段关联座席与服务号关系
role 此座席拥有的角色
parentId 座席的上级座席ID
AutoBusyTime 后处理时长
type 是否为监控座席(agent/manager)

code:

代码 含义
200 请求成功
400 请求体参数错误
402 参数错误
403 接口访问频次达到上限或者鉴权失败
500 服务器错误

返回200示例

{
    "code": 200,
    "message": "account get information success!",
    "data": [
        {
            "_id": "09cebc40-e694-11e5-9cab-27f6bff0482a",
            "pbx": "1.1.1.101",
            "type": "manager",
            "mobile": "18516967734",
            "email": "",
            "status": "enable",
            "uversion": "enterprise",
            "role": [
                "dddd3170-e693-11e5-9eaf-3967ec5e59d3",
                "dddd3171-e693-11e5-9eaf-3967ec5e59d3"
            ],
            "callerIDNum": "18516967734",
            "exten": "8000",
            "password": "8000",
            "displayName": "8000",
            "loginName": "8000",
            "AutoBusyTime": "0",
            "parentId": ""
        }
    ]
}

返回400示例:

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

返回402示例:

{
    "code": 402,
    "message": 'Accountisnull'
}

返回403示例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

返回500示例:

{
    "code": 500,
    "message": "find account agents err"
}