批量添加号码 (兼容2.0任务批量增加号码)
请求接口
agent-api/user/{user_id}/task/{task_id}/number
请求方式
POST
请求说明
此接口表示同步接口
写入任务的号码会先写入公海中,所以此接口会先导入CRM公海,然后再导入对应任务中
components中的id为组件的id,value为对应的值,id的值可以去创建公海模板的接口中获取
每次最多导入100条数据
不可导入重复号码
路由参数
参数
类型
示例
解释
是否必填
user_id
string
4d99d91c-f5d9-49da-88da-758977cc58a9
用户id
是
task_id
string
b15b7392-a83f-4e0e-9570-31dd2ec8f85c
任务id
是
注意:如果使用2.0 任务id ,需暂停任务才可以导入号码 否则 会出现以下报错
{
"code": 6007,
"status": "error",
"message": "2.0任务启动中,请先停止任务",
"data": []
}
2
3
4
5
6
请求参数
参数
类型
示例
解释
是否必填
ignore_crm
bool
true
号码是否进入客户公海(true代表不进入客户公海,false代表进入客户公海,默认不传则进入客户公海)
否
skip_error
bool
true
该值表示是否跳过验证错误(true表示在验证数据出现错误时跳过错误号码,继续添加,false表示出现错误验证会终止请求,返回错误信息。默认为false)
否
name
string
联系人1
联系人名称
否
phone
string
13012121211
号码 可开启加密
是
email
string
邮箱
否
company
string
xxx公司
公司 可开启加密
否
sex
int
0
姓名(0:未知,1:男,2:女)
否
sort
int
0
排序
是
source_id
int
0
信息来源ID
否
industry_id
int
0
信息行业ID
否
grade_id
int
0
客户等级ID
否
components
array
[]
组件数据
否
extra
string
0c51fc89-f6cf-405b-bb36-2c06900c3b5e
额外数据,可用于标识第三方数据,可以不携带
否
sub_user_id
string
91f9254f-ca58-49af-be34-8370d7549d73
子账户id(传递此参数则是对子账户操作)
否
encryption
bool
false
是否加密号码和公司(开启接口加密后有效)
否
请求数据案例
{
"ignore_crm": true, //默认可不传
"encryption": false,
"skip_error": true,
"sub_user_id":"91f9254f-ca58-49af-be34-8370d7549d73",
"data": [
{
"name": "联系人1",
"phone": "13012121211", // 手机号码
"email": "12345@qq.com", // 邮箱
"company": "xxx公司", // 公司
"sex": 0,
"sort": 0, // 排序,暂无用处,都传0,
"source_id": 1,
"industry_id": 2,
"grade_id": 1,
"extra": "0c51fc89-f6cf-405b-bb36-2c06900c3b5e", //额外数据,可用于标识第三方数据,可以不携带
"components": [
{
"id": "2a87347c-6dd5-4e22-97fe-9b8001dbcd17", // 自定义组件id
"value": "小牛" // 自定义组件要传入的值
},
{
"id": "3535fa11-d1fc-468b-943c-8850c4e5514e",
"value": "17"
}
]
},
{
"phone": "13012121212",
"sort": 0,
"components": [
{
"id": "2a87347c-6dd5-4e22-97fe-9b8001dbcd17",
"value": "小张"
}
]
},
{
"phone": "13012121213",
"sort": 0
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
返回示例
{
"code": 200,
"status": "success",
"message": "号码导入任务成功",
"data": {
"taskNumberCount": 1,
"crmCustomerCount": 1,
"fail_datas": [{ //此值为skip_error为true的情况下会出现
"fail_data": "911***8179",
"fail_cause": "格式不正确。"
},
{
"fail_data": "280f5b43-0777-479d-b735-7270790aee921",
"fail_cause": "组件不存在"
}
]
}
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
taskNumberCount 表示成功写入任务的号码数量,如果任务中号码已存在,则此处不会写入
crmCustomerCount 表示成功写入CRM公海的号码数量,如果公海中号码已存在,则此处不会写入