更新时间:2023-09-27 GMT+08:00

删除外呼黑名单

前置条件

已经申请了开发者账号。

场景描述

调用该接口删除指定的黑名单号码。

接口方法

该接口仅支持POST方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/delete

其中,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 请求消息体参数说明

序号

参数名

参数类型

是否必选

说明

1

blocklistNo

String

True

需要删除的黑名单号码。最大长度为24个字符,有效字符为:0~9、*、#

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

原因码。0200000表示成功,其他表示失败。

具体见表5

2

resultDesc

String

描述。

3

returnCode

String

原因码。0200000表示成功,其他表示失败。

具体见表5

4

returnDesc

String

描述。

触发事件

错误结果码

表5 错误原因码说明

序号

错误码

说明

1

0200001

参数异常,异常详情在resultDesc中描述。

2

0200006

数据库操作异常。

3

02000001

参数值为空

4

02000002

参数包含非法字符

5

02000003

参数长度不能大于规定长度

6

02000004

参数长度不能小于规定长度

7

02000005

参数长度需要介于规定长度之间

8

02000006

参数值类型不正确

9

02000007

参数值大小不正确

10

02000008

参数转换异常,请检查请求参数

11

02000009

参数组合不正确,请检查请求参数

12

02000010

hour和minute必须同时存在

13

02000011

参数个数不能大于规定个数

报文样例

  • 该接口的请求消息体举例如下:
    {
        "blocklistNo":"13100000000"
    }
  • 该接口的响应消息体举例如下:
    {
        "resultCode": "0200000",
        "resultDesc": ""
    }