更新指定号码当前的呼叫次数
场景描述
可以由外部系统调用该接口更新该号码的呼叫次数,开启呼叫限制时,用于业务系统发起的手动呼叫更新呼叫次数。
使用说明
- 前提条件
- 有对应的Ak/Sk鉴权权限。
- 已经申请了开发者账号。
- 开启呼叫频次限制。
接口方法
该接口仅支持POST方法。
接口URL
https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callCount/update
其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。
| 序号 | 参数名 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | vdnId | int | True | 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 |
请求说明
| 序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 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。 |
| 序号 | 参数名 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | phoneList | Array | True | 待更新的号码呼叫次数的号码列表。 |
| 序号 | 参数名 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
| 1 | phone | String | True | 最大长度为24个字符,有效字符为:0~9 |
| 2 | callCount | Number | False | 默认1次 |
| 3 | lastCallTime | Number | False | 最后一次呼叫时间,未设置时取系统时间,时间戳,UTC时间。 |
响应说明
| 序号 | 参数名 | 参数类型 | 说明 |
|---|---|---|---|
| 1 | resultCode | String | 原因码。0200000表示成功,其他表示失败。 具体见表6 错误原因码说明错误原因码说明 |
| 2 | resultDesc | String | 描述。 |
| 3 | returnCode | String | 原因码。0200000表示成功,其他表示失败。 具体见表6。 |
| 4 | returnDesc | String | 描述。 |
错误结果码
报文样例
- 该接口的请求消息体举例如下:
{"phoneList":[{"phone":"12345","callCount":"10","lastCallTime":"1753838738959"},{"phone":"67890"}]} - 该接口的响应消息体举例如下:
{ "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "update CallCount Success", "returnDesc": "update CallCount Success" }