文档首页/ 云客服/ API参考/ 外呼类接口参考/ 外呼黑名单管理接口/ 查询黑名单分组
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询黑名单分组

场景描述

调用该接口查询指定VDN下的黑名单分组。

使用说明

  • 前提条件
    • 已经申请了开发者账号。
    • 已创建黑名单分组。

接口方法

该接口仅支持POST方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackCategory/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

name

String

False

黑名单分组名称，支持模糊查询

2

offset

int

True

offset用于确定查询的起始页。

offset取值为：offset=limit*(page-1)

page为需要查询的起始页。

3

limit

int

True

表示每页的查询数量。

取值范围：1～100

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见错误结果码。

2

resultDesc

String

描述。

3

totalCount

int

返回列表中结果总条数。

4

data

Object

参见表5。

5

returnCode

String

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

具体见表6

6

returnDesc

String

描述。
表5 data参数说明

序号

参数名

参数类型

说明

1

id

String

黑名单分组ID

2

name

String

黑名单分组名称

3

description

String

黑名单分组描述

4

orgName

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

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

14

02000012

黑名单分组已经存在

15

02000013

无效的黑名单分组id

16

02000014

黑名单类型已经存在

17

02000015

无效的黑名单类型id

报文样例

  • 该接口的请求消息体举例如下： 
    {
   "name":"test",
   "offset":1,
   "limit":"1"
}
  • 该接口的响应消息体举例如下： 
    {
{
    "resultCode": "0200000",
    "resultDesc": "success",
    "returnCode": "0200000",
    "returnDesc": "success",
    "totalCount": 3,
    "data": [
        {
            "id": "1160220832",
            "name": "1223",
            "description": "21",
                       "orgName": ""
        },
        {
            "id": "1585609218",
            "name": "1",
            "description": null,
            "orgName": ""
        },
        {
            "id": "1108975895",
            "name": "112",
            "description": null,
             "orgName": ""
        }
    ]
}
}

相关文档