获取VDN历史监控指标
场景描述
获取VDN维度的历史监控指标。
接口方法
设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。
请求URL
https://ip:port/rest/cmsapp/v1/openapi/hisindex/vdn
其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。
非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Content-Type |
String |
True |
固定填 application/json; charset=UTF-8。 |
2 |
Authorization |
String |
True |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
ccId |
int |
False |
呼叫中心编号
|
2 |
vdnIds |
array |
True |
虚拟呼叫中心编号的数组,数组长度最大100。虚拟呼叫中心编号为int型。 |
3 |
indexIds |
array |
True |
指标的数组。指标为string型。具体指标请参见表1 |
4 |
timeGrain |
String |
False |
该入参可按分钟粒度进行历史监控指标统计,可选值为("15MIN","30MIN","60MIN"),如果不传则统计当天时区(VDN所在时区)的数据。 |
5 |
anonyCall |
int |
False |
匿名呼叫标识(只有呼入才有这个字段), 其值为1标识匿名呼叫,0表示非匿名呼叫,不带该参数则查询结果为所有的匿名呼叫和非匿名呼叫。 |
6 |
calleeNo |
String |
False |
被叫号码。 |
7 |
mediaType |
int |
False |
呼叫媒体类型,具体请参见表1。 |
8 |
subMediaType |
int |
False |
子媒体类型,具体请参见表3。 |
9 |
enableOffset |
String |
False |
可选值为("Y","N"),传"Y"则查询前一天的数据,传"N"则查询当天的数据,不传默认为"N"。 |
响应消息
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
result |
String |
查询结果。取值如下:
失败的原因说明请参见错误码参考。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
2 |
resultCode |
String |
查询结果。取值如下:
失败的原因说明请参见错误码参考。 |
3 |
resultDatas |
List< JSONObject> |
查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表5。
说明:
当前字段为兼容8.13及其之前版本接口响应参数使用。 |
4 |
resultDesc |
List< JSONObject> |
查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表5。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
2.1 |
id |
String |
虚拟呼叫中心编号。 |
2.2 |
idxs |
List< JSONObject> |
指标结果集。 该对象的参数说明请参见表6。 |
样例报文
- 请求头:
Content-Type: application/json;charset=UTF-8 Authorization: ******************
- 请求参数:
{ "ccId":1, "vdnIds":[29,30], "indexIds":["IDX_COUNT_TOTAL_CALL","IDX_COUNT_CONNECTED_CALL"], "timeGrain":"15MIN", "anonyCall":1, "calleeNo":"640001", "mediaType":53, "subMediaType":3 }
- 响应参数:
{ "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "2", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "29" }, { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_TOTAL_CALL" }, { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_CONNECTED_CALL" } ], "id": "30" } ] }