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

查询UAP终端设备统计接口

前置条件

该接口仅支持全局AK/SK鉴权调用。

注意:本接口仅支持独立部署环境。

场景描述

查询UAP终端设备统计信息。

接口方法

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

请求URL

https://ip:port/rest/cmsapp/v1/openapi/uap/terminalindex

其中,公有云环境请联系管理员获取,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 请求消息体参数说明

参数名

数据类型

是否必选

说明

ccId

int

False

呼叫中心编号

  • 独立部署环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > 参数配置查看“默认呼叫中心标识”的值。

uapIP

String

False

虚拟呼叫中心编号数组,数组长度最大100

beginDate

String

True

查询起始时间,零时区时间,开始时间和结束时间间隔不超过31天(取整)

endDate

String

True

查询结束时间,零时区时间

limit

int

False

选填,默认为100

offset

int

False

选填,默认为0

响应消息

表3 响应消息体参数说明

参数名

数据类型

说明

resultCode

String

查询结果。取值如下:

  • "0100000":成功
  • 其他:失败
  • 失败的原因说明请参见错误码参考

resultDesc

List

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

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

表4 resultDesc对象参数说明

参数名

数据类型

说明

beginTime

String

统计开始时间,毫秒级时间戳(五分钟统计区间开始时间)

ccId

int

呼叫中心编号

uapIp

String

UAP的IP

agentOnlineCount

int

软终端注册数

样例报文

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数:
    {
        "ccId":1,
        "uapIP":"1.1.1.1",
        "beginDate":"2021-09-09 00:00:00",
        "endDate":"2021-09-11 23:00:00",
        "limit":"100",
        "offset":"0"
    }
  • 响应参数:
    {
        "resultCode": 0,
        "resultDesc": {
        "data": [
        {
            "beginTime": "1631594100000",
    	"ccId": 1,
    	"uapIp": "1.1.1.1",
    	"agentOnlineCount": 1
        }
        ],
            "count": 1
        }
    }