文档首页/ 云客服/ API参考/ 电销外呼/ 外呼黑名单管理接口/ 查询黑名单数据文件导入结果
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

查询黑名单数据文件导入结果

场景描述

调用该接口为查询导入的黑名单数据结果，包括本地导入和文件服务器导入。

使用说明

  • 前提条件
    • 已经申请了开发者账号。
    • 已存在有效的导入任务。

接口方法

该接口仅支持POST方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blackfile/queryDataImportTask

其中，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

offset

int

True

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

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

page为需要查询的起始页。

2

limit

int

True

表示每页的查询数量。

取值范围：1～100

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见表5。

2

resultDesc

String

描述。

3

result

List<DataImportTask>

当前外呼活动的文件导入任务集合

4

count

int

结果总数

5

returnCode

String

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

具体见表6

6

returnDesc

String

描述。
表5 文件导入任务集合参数说明

序号

参数名

参数类型

说明

1

id

String

文件导入任务ID

2

beginTime

String

导入起始时间

3

endTime

String

导入结束时间

4

status

String

任务状态 0：导入准备，1：执行中，2：导入完成，3：导入失败

5

succNum

int

成功记录数

6

repeatNum

int

重复记录数

7

failNum

int

失败记录数

8

errMsg

int

异常原因

触发事件

无

错误结果码

表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

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

报文样例

  • 该接口的请求消息体举例如下： 
    {
    "limit":10,
    "offset":0,
	  "importTaskIds":["164698362894300182038011895728"]
}
  • 该接口的响应消息体举例如下： 
    {
	"result": [
		{
			"succNum": 0,
			"failNum": 0,
			"errMsg": "",
			"id": "164698362894300182038011895728",
			"beginTime": "2022-03-11T07:27:09.000+00:00",
			"endTime": "2022-03-11T07:27:09.000+00:00",
			"repeatNum": 0,
			"status": "2"
		}
	],
	"returnCode": "0200000",
	"resultCode": "0200000",
	"resultDesc": "success",
	"returnDesc": "success"
}

相关文档