更新时间:2023-12-19 GMT+08:00

查询座席维度系统状态信息

场景描述

查询座席维度系统状态信息。

接口方法

设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELTE等方法。

内部封装接口

BMS接口:/ccbms/ws/monitor/teamagentstatusinfo

请求URL

https://ip:port/rest/cmsapp/v1/openapi/agentgroup/systemstate

其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

表2 消息体参数说明

序号

名称

参数类型

是否必选

说明

1

ccId

int

True

呼叫中心编。

取值范围:1~65535

2

vdn

int

True

虚拟呼叫中心编号。

取值范围:1~5000

3

offset

int

True

offset用于确定查询的起始页。

offset取值公式为:offset=limit*(page-1),取值范围:>=0。

page为需要查询的起始页。

4

limit

int

True

表示每页的查询数量。

取值范围:1~100

响应消息

表3 消息体参数说明

序号

名称

参数类型

说明

1

result

String

查询结果。取值如下:

  • 0:成功
  • 其他:失败

失败的原因说明请参见错误码参考

说明:

当前字段为兼容8.13及其之前版本接口响应参数使用。

2

resultCode

string

查询结果。取值如下:

  • "0100000":成功
  • 其他:失败

失败的原因说明请参见错误码参考

3

resultDatas

Object

查询成功后,返回结果信息的对象。

该数组中对象的参数说明请参见表4

说明:

当前字段为兼容8.13及其之前版本接口响应参数使用。

4

resultDesc

Object

查询成功后,返回结果信息的对象。

该对象的参数说明请参见表4

表4 resultDesc/resultDatas对象参数说明

序号

名称

参数类型

说明

2.1

busyAgent

int

忙碌态座席数。

2.2

talkingNum

int

通话态座席数。

2.3

idleAgent

int

空闲态座席数。

2.4

totalLoginAgent

int

签入座席数。

说明:

当前响应结果为limit和offset分页入参条件下获取的座席系统状态信息

例如:limit:10 ,offset:10 表示入参获取第二页(10个/页)的10个座席,再统计这十个座席中的系统状态信息

样例报文

  • 消息体

    该接口的请求消息体举例如下:

    {
        "queryParam":
        {
            "ccId":1, 
            "vdn":1,
            "offset":0,
            "limit":100
        }
    }
  • 该接口的响应消息体举例如下:
    {
        "result": "0",
        "resultCode": "0100000",
        "resultDatas": {
            "busyAgent": 0,
            "talkingNum": 0,
            "idleAgent": 0,
            "totalLoginAgent": 0
        },
        "resultDesc": {
            "busyAgent": 0,
            "talkingNum": 0,
            "idleAgent": 0,
            "totalLoginAgent": 0
        }
    }