# 新增外呼黑名单 #### 场景描述 调用该接口为指定外呼活动批量新增外呼黑名单。 #### 使用说明 - 前提条件 - 已经申请了开发者账号。 - 使用限制 - 黑名单号码最大长度为24个字符。 - 黑名单号码有效字符为：0\~9、\*、#。 - 每次只能增加20条黑名单号码，否则提示"超过单次新增最大数量"，且不新增黑名单号码。 - 每次追加的黑名单号码不能有重复，否则提示"号码重复"，且不新增黑名单号码。 - 每次追加的黑名单号码中不能存在已有黑名单号码。 - 当同时传入有效时长和到期时间时，则以指定时间（validityexpirationtime）为准处理。 - 限制次数小于重试策略设置的试呼次数。 #### 接口方法 该接口仅支持POST方法。 #### 接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/add 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1URL中携带的参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | vdnId | int | True | 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 | #### 请求说明 表2请求消息头参数 | 序号 | 名称 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 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)。 | | 3 | locale | String | False | i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 | 表3请求消息体参数说明 | 序号 | 参数名 | 参数类型 | 是否必选 | 说明 | |:---|:---|:---|:---|:---| | 1 | blocklist | List | True | - 新增黑名单号码列表，最多20条。 - 当blockClass=0时，号码最大长度为24个字符，有效字符为：0\~9、\*、# - 当blockClass=1时，号码最大长度为32个字符，有效字符为：0\~9、\*、# | | 2 | blockClass | Int | False | 黑名单类型。 取值范围： - 0：号码 - 1：客户id - 不传值时默认为号码 | | 3 | validityExpirationTime | String | False | 到期时间。使用租户对应的时区时间。 | | 4 | validityTime | Int | False | 有效时长，取值范围1\~120。validityExpirationTime和validityTime，二者取其一，如果同时设置了两个时间，优先取validityExpirationTime。 | | 5 | validityTimeUnit | Int | False | 有效时长单位，取值范围： - 1：年 - 2：月 - 3：日 - 4：小时 默认值：4 | | 6 | relCategoryId | String | False | - 关联的黑名单分组id - 如果blockClass=1时，relCategoryId必填。 | | 7 | typeId | String | False | 关联黑名单操作类型id。 | | 8 | isCoverDupNo | Int | False | 是否覆盖重复号码，取值范围： - 0：不覆盖，跳过处理（默认值） - 1：覆盖，更新已有记录 默认值：0 | #### 响应说明 表4消息体参数说明 | 序号 | 参数名 | 参数类型 | 说明 | |:---|:---|:---|:---| | 1 | resultCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表5]。 | | 2 | resultDesc | String | 描述。 | | 3 | returnCode | String | 原因码。0200000表示成功，其他表示失败。 具体见[表5] | | 4 | returnDesc | String | 描述。 | #### 触发事件 无 #### 错误结果码 表5错误原因码说明 | 序号 | 错误码 | 说明 | |:---|:---|:---| | 1 | 0200001 | 参数异常，异常详情在resultDesc中描述。 | | 2 | 0200006 | 数据库操作异常。 | | 3 | 0200007 | 号码已存在黑名单中。 | | 4 | 0200018 | 存在重复的号码。 | | 5 | 0200029 | 超过了每次添加允许的最大值。 | | 6 | 02000001 | 参数值为空 | | 7 | 02000002 | 参数包含非法字符 | | 8 | 02000003 | 参数长度不能大于规定长度 | | 9 | 02000004 | 参数长度不能小于规定长度 | | 10 | 02000005 | 参数长度需要介于规定长度之间 | | 11 | 02000006 | 参数值类型不正确 | | 12 | 02000007 | 参数值大小不正确 | | 13 | 02000008 | 参数转换异常，请检查请求参数 | | 14 | 02000009 | 参数组合不正确，请检查请求参数 | | 15 | 02000010 | hour和minute必须同时存在 | | 16 | 02000011 | 参数个数不能大于规定个数 | | 17 | 02000012 | 黑名单分组已经存在 | | 18 | 02000013 | 无效的黑名单分组id | | 19 | 02000014 | 黑名单类型已经存在 | | 20 | 02000015 | 无效的黑名单类型id | #### 报文样例 - 该接口的请求消息体举例如下： ``` { "blocklist": [ "13100000000", "13100000001", "13100000002", "13100000003" ], "validityExpirationTime":"2020-12-31 10:06:25" } ``` - 该接口的响应消息体举例如下： ``` { "resultCode": "0200000", "resultDesc": "The blocklist is added successfully" } ```