导入服务器外呼数据文件

场景描述

调用该接口为通过服务器导入外呼数据文件。

外呼数据导入模板

请参考表1创建Excel模板文件。

表1 外呼数据模板
sessionId(非必填)	called必填	caller(非必填)	callData(非必填)	customField（非必填）	recycleTime(非必填)	priority(非必填)
-	[{'calledNo':1234566}]	-	-	-	-	-

表2 外呼数据模板参数说明
序号	参数名	参数类型	是否必选	说明
1.1	sessionId	String	False	标识用户的ID，外呼结果中会回传用户。最大长度为32个字符。
1.2	called	String	True	JSON数组客户号码信息。
1.3	caller	String	False	主叫号码。最大长度为24个字符。
1.4	customField	String	False	用户自定义字段，最大长度200。
1.5	recycleTime	String	False	回收时间，格式为yyyy-mm-dd hh:mm:ss。
1.6	callData	String	False	随路数据，最大长度1024，建议JSON格式。注意：当自动外呼涉及到智能IVR流程时，该参数格式只支持JSON格式。智能IVR流程使用JSON格式调用图元对JSON格式的随路数据进行解析和赋值操作，图元的具体实现和使用方式请参见JSON数据调用图元。 JSON格式请参照如下，其中斜体部分可自定义，其余参数和格式请保持固定： "callData":"{\\\"fullName\\\":\\\"林子航\\\",\\\"date\\\":\\\"二零二二年三月三十一日\\\",\\\"riskName\\\":\\\"交强险\\\"}"
1.7	priority	String	False	支持设置优先级，优先级值范围为1-5，默认值为3，其中数字1优先级最高，数字5优先级最低。执行外呼任务提取外呼数据时，按照优先级提取外呼数据。

表3 called参数说明
序号	参数名	参数类型	是否必选	说明
1.2.1	calledNo	String	True	客户被叫号码。最大长度为24个字符，有效字符为：0~9、*、#。
1.2.2	delayTime	String	False	客户每个号码呼叫的间隔时间，单位秒，范围0~7200，默认值0。
1.2.3	type	String	False	客户号码类型。

使用说明

前提条件
- 已经申请了开发者账号。
- 外呼活动已创建。
- 存在可用的文件服务器，且文件服务器支持sftp
使用限制
- 文件中每次最多导入500000条。

接口方法

该接口仅支持POST方法。

接口URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldatafile/uploadFileServer/{campaignId}

其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。

表4 URL中携带的参数说明
序号	参数名	参数类型	是否必选	说明
1	vdnId	int	True	虚拟呼叫中心ID。取值的类型为整数，取值范围为1～9999。
2	campaignId	String	True	外呼任务ID

请求说明

表5 请求消息头参数
序号	名称	参数类型	是否必选	说明
1	Content-Type	String	True	固定填 application/json; charset=UTF-8。
2	Authorization	String	True	生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。

表6 请求消息体参数说明
序号	参数名	参数类型	是否必选	说明
1	serverId	String	True	文件服务器ID，来源新增文件服务器接口。
2	filePath	String	False	文件存放路径。非必填，外呼文件放在外呼文件器默认路径下可不填；如果放在文件服务器默认路径下的文件夹里，须填写相对于文件服务器默认路径的相对路径示例：/isales/20220310
3	fileName	String	True	文件名示例：demo.xlsx
4	hour	String	False	小时，定时任务导入必传，0<=hour<=23，注：minute存在时，hour必传，24h制
5	minute	String	False	分钟，定时任务导入必传，00，30，注：hour存在时，minute必传

响应说明

表7 消息体参数说明
序号	参数名	参数类型	说明
1	resultCode	String	原因码。0200000表示成功，其他表示失败。具体见表5。
2	resultDesc	String	描述。
3	importTaskId	String	文件导入任务ID
4	returnCode	String	原因码。0200000表示成功，其他表示失败。具体见表8
5	returnDesc	String	描述。

触发事件

无

错误结果码

表8 错误原因码说明
序号	错误码	说明
1	0200001	参数异常，异常详情在resultDesc中描述。
2	02000001	参数值为空
3	02000002	参数包含非法字符
4	02000003	参数长度不能大于规定长度
5	02000004	参数长度不能小于规定长度
6	02000005	参数长度需要介于规定长度之间
7	02000006	参数值类型不正确
8	02000007	参数值大小不正确
9	02000008	参数转换异常，请检查请求参数
10	02000009	参数组合不正确，请检查请求参数
11	02000010	hour和minute必须同时存在
12	02000011	参数个数不能大于规定个数

报文样例

该接口的请求消息体举例如下：

{
    "serverId":"164690088271159234793429225848",
    "filePath":"/isales/upload",
    "fileName":"demogl50w.xlsx"
}

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

{
	"returnCode": "0200000",
	"importTaskId": "164870990605164487770867067540",
	"resultCode": "0200000",
	"resultDesc": "数据导入中，请通过“导入结果”查看详细信息。",
	"returnDesc": "数据导入中，请通过“导入结果”查看详细信息。"
}

父主题： 外呼数据接口

上一篇：统计当日外呼数据

下一篇：查询外呼数据文件导入结果