删除外呼号码
场景描述
调用该接口删除指定外呼活动下的外呼号码。
使用说明
- 前提条件
- 已经申请了开发者账号。
- 已经获取到需要的外呼活动的ID。
- 使用限制
- 正在呼出的外呼号码不允许删除。
- 已完成呼叫的外呼号码不允许删除。
- 执行中的任务不允许删除该任务下的外呼号码。
接口方法
该接口仅支持POST方法。
接口URL
https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete
其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。
序号 | 参数名 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
1 | vdnId | int | True | 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 |
2 | campaignId | int | True | 外呼活动的ID。 |
请求说明
序号 | 名称 | 参数类型 | 是否必选 | 说明 |
|---|---|---|---|---|
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 | sessionId | String | False | 标识用户的ID,外呼结果中会回传用户。 最大长度为32个字符。 |
2 | called | String | False | 被叫号码。 最大长度为24个字符,有效字符为:0~9、*、#。 |
3 | customField | String | False | 用户自定义字段,删除时可根据该字段批量删除,最大长度为200个字符。 |
4 | recycleTime | String | False | 回收时间,格式为yyyy-mm-dd hh:mm:ss。 |
5 | recycleType | String | False | 回收类型。只在传入recycleTime的同时传入,该参数有效。 取值范围: |
6 | archiveHistory | int | False | 是否移历史表。 取值范围:0,1。 0:不移历史表,直接删除。1:移入历史表。默认为0。 |
响应说明
触发事件
无
错误结果码
序号 | 错误码 | 说明 |
|---|---|---|
1 | 0200001 | 参数异常,异常详情在resultDesc中描述。 |
2 | 0200006 | 数据库操作异常。 |
3 | 0200007 | 外呼活动不存在。 |
4 | 0200028 | 当前状态不允许删除号码。 |
5 | 0200030 | 时间格式不正确。 |
6 | 02000001 | 参数值为空 |
7 | 02000002 | 参数包含非法字符 |
8 | 02000003 | 参数长度不能大于规定长度 |
9 | 02000004 | 参数长度不能小于规定长度 |
10 | 02000005 | 参数长度需要介于规定长度之间 |
11 | 02000006 | 参数值类型不正确 |
12 | 02000007 | 参数值大小不正确 |
13 | 02000008 | 参数转换异常,请检查请求参数 |
14 | 02000009 | 参数组合不正确,请检查请求参数 |
15 | 02000010 | hour和minute必须同时存在 |
16 | 02000011 | 参数个数不能大于规定个数 |
报文样例
- 该接口的请求消息体举例如下:
{ "sessionId":"1" } - 该接口的响应消息体举例如下:
{ "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "successCount": 1 }

