查询外呼黑名单

场景描述

调用该接口查询指定VDN下的黑名单号码

使用说明

前提条件
- 已经申请了开发者账号。

接口方法

该接口仅支持POST方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/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	blocklist	List	False	查询黑名单号码列表，最多20条。号码最大长度为24个字符，有效字符为：0~9、*、# 注意：如果传了该字段，则响应只返回该列表的黑名单号码，即响应结果为请求传入的黑名单列表是否在黑名单中，如果在，则返回黑名单号码相关信息，如到期时间、有效时长。必须传递blocklist或limit/offset其中之一，并且blocklist与limit/offset是互斥的，传递blocklist时不能传递limit/offset。
2	blockClass	Int	False	黑名单类型。取值范围： 0：号码 1：客户id 不传值时默认为号码
3	relCategoryId	String	False	关联的黑名单分组id
4	typeId	String	False	关联的黑名单操作类型id
5	offset	int	False	offset用于确定查询的起始页。 offset取值为：offset=limit*(page-1) page为需要查询的起始页。注意：传递offset时必须一同传递limit。必须传递blocklist或limit/offset其中之一，并且blocklist与limit/offset是互斥的，传递limit/offset时不能传递blocklist。
6	limit	int	False	表示每页的查询数量。取值范围：1～100 注意：传递limit时必须一同传递offset。必须传递blocklist或limit/offset其中之一，并且blocklist与limit/offset是互斥的，传递limit/offset时不能传递blocklist。

响应说明

表4 消息体参数说明
序号	参数名	参数类型	说明
1	resultCode	String	原因码。0200000表示成功，其他表示失败。具体见错误结果码。
2	resultDesc	String	描述。
3	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见错误结果码。
4	returnDesc	String	描述。
5	totalCount	int	返回列表中结果总条数。
6	data	Object	参见表5。

表5 data参数说明
序号	参数名	参数类型	说明
1	validityExpirationTime	String	到期时间，使用租户对应的时区时间。
2	blockNum	String	黑名单号码
3	flag	Boolean	黑名单有效标识，true：有效；false：无效须知：入参传入了blocklist才会返回该参数
4	blockClass	Int	黑名单类型。取值范围： 0：号码 1：客户id 不传值时默认为号码
5	orgName	String	组织名称
6	relCategoryId	String	分组ID
7	relCategoryName	String	分组名称
8	typeId	String	关联黑名单操作类型ID
9	typeName	String	类型名称
10	remark	String	备注

触发事件

无

错误结果码

表6 错误原因码说明
序号	错误码	说明
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	参数个数不能大于规定个数
17	02000012	黑名单分组已经存在
18	02000013	无效的黑名单分组id
19	02000014	黑名单类型已经存在
20	02000015	无效的黑名单类型id

报文样例

该接口的请求消息体举例如下：
```
{"limit":10,"offset":0}
```

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

{
    "returnCode": "0200000",
    "data": [
        {
            "relCategoryId": "1784435836",
            "orgName": "",
            "flag": true,
            "validityExpirationTime": 1792836385000,
            "typeName": null,
            "blockNum": "222112312312",
            "typeId": null,
            "remark": null,
            "blockClass": 1,
            "orgId": null,
            "relCategoryName": "客户级分组02"
        }
    ],
    "resultCode": "0200000",
    "resultDesc": "query BlockList Success",
    "totalCount": 10,
    "returnDesc": "query BlockList Success"
}

父主题： 外呼黑名单管理接口

上一篇：删除所有外呼黑名单

下一篇：导入服务器黑名单数据文件