# 获取IVR历史监控指标 #### 场景描述 获取IVR维度的历史监控指标，默认从5min结算表中获取数据，不查实时缓存数据，如果要查询实时缓存数据，可以修改数据库中如下表字段(t_cms_sysparam表中history_monitor_indicator/history_monitor_indicator_agent)的值修改为：true，由于接口结算实时缓存数据有一定的性能瓶颈，打开前请和维护人员如实评估。 #### 接口方法 设置成"POST"。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。 #### 请求URL https://ip:port/rest/cmsapp/v1/openapi/hisindex/ivr 其中，公有云环境请联系管理员获取，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 监控/系统外呼/话单/知识库类接口鉴权方式](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0003.html#ZH-CN_TOPIC_0000002481273406)。 | 表2请求消息体参数说明 | 参数名 | 数据类型 | 是否必选 | 说明 | |:---|:---|:---|:---| | ccId | int | False | 呼叫中心编号 - 集成环境，默认值为系统管理员登录AICC系统后，通过"配置中心 \> 系统管理 \> CMS系统配置"查看的呼叫中心编号。若该配置为空，取值数据库t_cms_sysparam表中的sys_key="default_cc_id",sys_type="cms_system_config"对应的数据。 - 独立部署环境，默认值为系统管理员登录AICC系统后，通过"配置中心 \> 系统管理 \> 参数配置"查看"默认呼叫中心标识"的值。 | | vdn | int | True | 虚拟呼叫中心编号 | | serviceNos | array | True | 业务类型编号的数组，数组长度最大500。业务类型为int型。 公有云模式下， 业务类型编号默认为1，如需修改，请联系系统管理员。 独立部署模式下，业务类型编码由VDN管理员登录WAS配置台，在"Web配置台 \> VDN\*的配置 \> 流程 \> 流程"中查看对应IVR流程的"流程业务类型"，例如"1 Voice"表示该IVR对应的业务类型编码为"1"。 说明： 当前参数无实际业务含义，请勿使用。 | | indexIds | array | True | 指标的数组。指标为string型，具体指标请参见[表1](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0695.html#ZH-CN_TOPIC_0000002481113862__zh-cn_topic_0000002509989769_zh-cn_topic_0291831128_table13911374911) | | timeGrain | String | True/False | 当[表1](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0694.html#ZH-CN_TOPIC_0000002513233711__zh-cn_topic_0000002510109739_zh-cn_topic_0291831127_table13911374911)中要求带上timeGrain参数时，当前参数为必填项。 该入参可按分钟粒度进行历史监控指标统计，可选值为（"15MIN"，"30MIN"，"60MIN"），如果不传则统计当天时区（租户所在时区）的数据。 | | mediaType | int | False | 呼叫媒体类型，具体请参见[表1](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0698.html#ZH-CN_TOPIC_0000002513233715__zh-cn_topic_0000002510109741_zh-cn_topic_0000001843009401_zh-cn_topic_0000001451970565_zh-cn_topic_0240433933_table13565990)。 | | subMediaType | int | False | 子媒体类型，具体请参见[表3](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0644.html#ZH-CN_TOPIC_0000002481273790__zh-cn_topic_0000002478109764_zh-cn_topic_0284486991_table1124114435517)。 | | enableOffset | String | False | 可选值为（"Y"，"N"）,传"Y"则查询前一天的数据，传"N"则查询当天的数据，不传默认为"N"。 | #### 响应消息 表3响应消息体参数说明 | 参数名 | 数据类型 | 说明 | |:---|:---|:---| | result | String | 查询结果。取值如下： - 0：成功 - 其他：失败 失败的原因说明请参见[错误码参考](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0696.html#ZH-CN_TOPIC_0000002481273824)。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 | | resultCode | String | 查询结果。取值如下： - "0100000"：成功 - 其他：失败 失败的原因说明请参见[错误码参考](https://support.huaweicloud.com/api-ccfs-cec/cec_07_0696.html#ZH-CN_TOPIC_0000002481273824)。 | | resultDatas | List\< JSONObject\> | 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见[表4]。 说明： 当前字段为兼容8.13及其之前版本接口响应参数使用。 | | resultDesc | List\< JSONObject\> | 查询成功后，返回结果信息的对象数组。 该数组中对象的参数说明请参见[表4] | 表4resultDesc/resultDatas对象参数说明 | 参数名 | 数据类型 | 说明 | |:---|:---|:---| | id | String | 业务类型编号。 | | idxs | List\< JSONObject\> | 指标结果集。 该对象的参数说明请参见[表5]。 | 表5idx对象参数说明 | 参数名 | 数据类型 | 说明 | |:---|:---|:---| | id | String | 指标ID。 | | val | Object | 按分钟粒度统计的指标结果，时间为零时区时间。 参数格式为"*时间* ":"*指标结果*"，表示当前时间起一段时间间隔中统计的指标结果数量，时间间隔长度由请求参数中的timeGrain参数决定。 例如"2020-11-11 09:15:00.0": "1"，表示09:15\~09:30时指标结果为1，此时请求参数中timeGrain的值为15。 | #### 样例报文 - 请求头： ``` Content-Type: application/json;charset=UTF-8 Authorization: ****************** ``` - 请求参数： ``` { "ccId":1, "vdn":170, "timeGrain":"15MIN", "serviceNos":[3,2], "indexIds":["IDX_COUNT_IVR_INBOUND_CALL"], "mediaType":53, "subMediaType":3 } ``` - 响应参数： ``` { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-11-11 09:15:00.0": "1", "2020-11-11 10:15:00.0": "1" }, "id": "IDX_COUNT_IVR_INBOUND_CALL" } ], "id": "3" } ] } ```