切换主题
客户导入
该接口用于导入客户到任务中并开始进行外呼。使用该接口前需要先在系统中创建任务,再根据查询任务列表获取到任务ID。
POSThttps://dashboard.avavox.com/open/api/task/import
请求头
Authorization string
必填
鉴权使用,格式为 Authorization: Bearer <Key>
,key从系统中获取
请求体参数
taskId string
必填
任务ID,指定客户导入到对应的任务,该ID可以从获取任务列表接口中获取
customers array
必填
需要导入的客户列表,每次最大值为2000条,客户列表数据,结构如下:
点击展开字段说明
phoneNumber string
必填
客户联系方式,同一个任务中不允许存在重复号码,如果导入重复号码,后面的号码会被直接忽略,可以为标准手机号码,也支持固话,支持以下格式固话:
(010)xxxxxxxx
括号是英文半角括号010-xxxxxxxx
010xxxxxxxx
variableMap object
可选
变量,当机器人中配置了变量时,可以通过该参数关联变量和客户,格式为 {"变量名": "值"}
响应数据
code int
状态码,200 为成功,其他状态均为失败。
success boolean
是否成功,true
表示成功,false
表示失败。
message string
描述信息
data object
data默认为null
请求示例
shell
curl -X POST --location 'https://dashboard.avavox.com/open/api/task/import' \
--header 'Authorization: Bearer $Key' \
--header 'Content-Type: application/json' \
--data '{
"taskId": "xxx",
"customers": [
{
"phoneNumber": "10086",
"variables": {
"客户姓名": "张三",
"手机尾号": "0086"
}
}
]
}'
响应示例
json
{
"code": 200,
"message": "操作成功",
"success": true,
"data": null
}