查询指定号码当天的呼叫次数

场景描述

可以查询指定的某个号码当天的呼叫次数，未开启呼叫限制时，不支持查询。

使用说明

前提条件
- 有对应的Ak/Sk鉴权权限。
- 已经申请了开发者账号。
- 开启呼叫频次限制。
- 当天根据租户对应时区时间计算而来。

接口方法

该接口支持GET方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callCount/query

其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。

表1 URL中携带的参数说明
序号	参数名	参数类型	是否必选	说明
1	vdnId	int	True	虚拟呼叫中心ID。取值的类型为整数，取值范围为1～9999。

请求说明

表2 请求消息头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	String	True	固定填 application/json;charset=UTF-8。
2	Authorization	String	True	生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
3	locale	String	False	i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。

表3 请求消息体参数说明
序号	参数名	参数类型	是否必选	说明
1	phoneList	Array	True	待查询的号码列表，最大支持200个，最少1个。

响应说明

表4 消息体参数说明
序号	参数名	参数类型	说明
1	resultCode	String	原因码。0200000表示成功，其他表示失败。具体见下表6
2	resultDesc	String	描述。
3	data	List	被查询号码集合。
4	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表5 错误原因码说明。
5	returnDesc	String	描述。

表5 data参数说明
序号	参数名	参数类型	说明
1	phone	String	号码。
2	callCount	String	呼叫次数。
3	maxCallCount	int	可呼叫总次数.
4	isInTrustlist	boolean	是否在信任列表中，在信任列表中的号码不限制呼叫次数.
5	lastCallTime	Number	最后一次呼叫时间，UTC时间。

错误结果码

表6 错误原因码说明
序号	错误码	说明
1	0200001	参数异常，异常详情在resultDesc中描述。
2	02000001	参数值为空
3	02000002	参数包含非法字符
4	02000007	参数值大小不正确
5	05000001	未开启呼叫次数限制

报文样例

该接口的请求消息体举例如下：
```
{"phoneList":["12345","67890"]}
```

该接口的响应消息体举例如下：

{
    "returnCode": "0200000",
    "data": [
        {
            "phone": "12345",
            "callCount": 15,
            "lastCallTime": 1753838739000,
            "maxCallCount": 23,
            "isInTrustList": false
        },
        {
            "phone": "67890",
            "callCount": 0,
            "lastCallTime": null,
            "maxCallCount": 1,
            "isInTrustList": false
        }
    ],
    "resultCode": "0200000",
    "resultDesc": "query CallCount Success",
    "returnDesc": "query CallCount Success"
}

父主题： 限呼管理接口

上一篇：限呼管理接口

下一篇：更新指定号码当前的呼叫次数