异步导入客户到外呼任务接口
# 1、接口描述
功能说明:
- 通过此接口可以异步向指定的任务导入客户信息,用于拨打电话。(单次导入客户数量不能大于10000)
- 此接口是公网服务,所有客户共用,为保证接口响应速度和吞吐量,并控制服务器压力,将单次导入个数定位最多10000个。数据量大时可以多并发调用此接口来实现。
- 如果被导入账户支持虚拟号外呼(需要业务侧沟通),可以按照:11位手机号+1-4位分机号的模式导入号码。
- 此接口为异步接口,只返回请求批次号,不返回客户导入结果。获取客户导入结果,可订阅 API导入外呼任务结果通知 回调事件
请求地址:
https://open-api.soboten.com/apiOpen/v1/job/importCustomerAsync请求方法: POST
# 2、请求头
请求头参数获取详见权限认证
| 参数名 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| appkey | String | 是 | ISV账号信息里获取 |
| timestamp | Long | 是 | 生成验签字段时使用的时间戳 |
| signature | String | 是 | 验签字段,获取方法详见权限认证 |
# 3、输入参数
| 参数名 | 类型 | 是否必须 | 描述 | 示例 |
|---|---|---|---|---|
| robotCallJobId | Long | 是 | 任务Id | 1024 |
| batchId | String | 否 | 请求批次号,用于调用方匹配此次请求与回调结果。此参数非必填,若传入此参数,返回参数会将传入值返回。若不传此参数,接口生成后返回。 | 0600db3c5d758b26 412d5f89b903f402 |
| customerPersons | JsonArray | 是 | 导入的客户信息列表 | |
| +phoneNumber | String | 是 | 客户电话,如果是加密场景传加密id即可,长度不超过32个字符,如果是虚拟号场景传:手机号-分机号 | 13998987676 |
| +properties | Map | 否(若话术或者短信中存在变量则必填,获取任务中的变量接口) | 自定义变量,(可以在此处加上调用方的业务信息,在回调时会完整回传) | { "会员等级": "level1" } |
| +customerAttr | Map > | 否 | 客户自定义属性字段。自定义属性需要根据各企业在会员中心客户属性管理模块的设置进行赋值,如果自定义属性有字段设置为必填,那么客户必须携带该自定义属性,否则会失败 | {"用户行为":["购买"]} |
| +name | String | 否 | 客户名称 | 张三 |
| +gender | String | 否 | 性别:男,女 | 男 |
| +alternatePhoneNumbers | Array[String] | 否 | 副号码 | ["13000000001"] |
| +addWechatAccountName | String | 否 | 微信昵称。加微推送中,选择指定账号模式下,给每个导入的客户添加指定加微账号,若指定账号不存在或者不可用时,该客户会进入到过滤列表,事后可以重新发起外呼 | Hello世界 |
# 4、输出参数
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | Integer | 响应码 | 200 |
| data | Object | 返回的数据 | |
| +batchId | String | 请求批次号,用于调用方匹配此次请求与回调结果。若传入此参数,返回参数会将传入值返回。若不传此参数,接口生成后返回。 | 0600db3c5d758b26412d5f89b903f402 |
| requestId | String | 请求Id | 3FuKmI6B |
| resultMsg | String | 响应说明 | 执行成功 |
| host | String | 业务主机名 | prod-web-7 |
| errorStackTrace | String | 异常堆栈 | null |
# 5、示例
输入示例:
{
"robotCallJobId": 1024,
"batchId": "0600db3c5d758b26412d5f89b903f402",
"customerPersons": [
{
"phoneNumber": "13000000000",
"properties": {
"会员等级": "level1"
},
"name": "小明",
"gender": "男",
"customerAttr": {
"用户行为": ["购买"]
},
"alternatePhoneNumbers":["13000000001"],
"addWechatAccountName":"Hello世界"
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
输出示例:
{
"code": 200,
"data": {
"batchId": "0600db3c5d758b26412d5f89b903f402"
},
"requestId": "3FuKmI6B",
"resultMsg": "执行成功",
"host": "prod-web-qc-001",
"errorStackTrace": null
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
上次更新: 2026/8/4 16:21:54