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

获取VDN实时监控指标

场景描述

获取VDN维度的实时监控指标。(CTI3.6版本不可用)

接口方法

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

内部封装接口

BMS接口:

  • /ccbms/ws/monitor/rindexSkill
  • /ccbms/ws/monitor/queryivrInfo
  • /ccbms/ws/monitor/queryivrdevicestatus
  • /ccbms/ws/monitor/teamagentstatusinfobyvdns

请求URL

https://ip:port/rest/cmsapp/v1/openapi/rindex/vdn

其中,公有云环境请联系管理员获取,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

False

呼叫中心编号

  • 集成环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > CMS系统配置查看的呼叫中心编号。若该配置为空,取值数据库t_cms_sysparam表中的sys_key="default_cc_id",sys_type="cms_system_config"对应的数据。
  • 独立部署环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > 参数配置查看“默认呼叫中心标识”的值。

2

vdnIds

array

True

虚拟呼叫中心编号的数组,数组长度最大100。虚拟呼叫中心编号为int型。

其中vdn取值:1~5000

3

indexIds

array

True

vdn维度实时监控指标的数组。指标为string型,

具体指标请参见表2

响应消息

表3 响应消息体参数说明

序号

名称

参数类型

说明

1

result

String

查询结果。取值如下:

  • 0:成功
  • 其他:失败

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

说明:

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

2

resultCode

String

查询结果。取值如下:

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

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

3

resultDatas

array

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

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

说明:

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

4

resultDesc

array

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

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

表4 resultDesc/resultDatas对象参数说明

序号

名称

参数类型

说明

2.1

id

String

虚拟呼叫中心编号。

2.2

idxs

List< JSONObject>

指标结果集。

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

表5 idx对象参数说明

序号

名称

参数类型

说明

2.2.1

id

String

指标ID。

2.2.2

val

Object

指标结果。

样例报文

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数:
     {
               "ccId":1,
               "vdnIds":[170,185],
               "indexIds":["IDX_COUNT_REAL_VDN_CONNECT","IDX_COUNT_REAL_VDN_CALL"]
      }
  • 响应参数:
    {
        "result": "0",
        "resultCode": "0100000",
        "resultDatas": [
            {
                "idxs": [
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id": "170"
            },
            {
                "idxs": [
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id": "185"
            }
        ],
        "resultDesc": [
            {
                "idxs": [
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id": "170"
            },
            {
                "idxs": [
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CONNECT"
                    },
                    {
                        "val": 0,
                        "id": "IDX_COUNT_REAL_VDN_CALL"
                    }
                ],
                "id": "185"
            }
        ]
    }