创建任务
更新时间:2024-05-27
URL
https://aiob-open.baidu.com/api/v3/console/apitask/create
https://aicc.bce.baidu.com/api/v3/console/apitask/create(即将下架)
HTTP Method
POST
请求参数
Header
参数名称 | 是否必须 | 说明 | 示例 |
---|---|---|---|
Content-Type | 是 | application/json | application/json |
Authorization | 是 | 参考「生成认证Token」文档 | cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33 |
参数名称 | 类型 | 是否必须 | 说明 | 示例 |
---|---|---|---|---|
taskName | string | 是 | 任务名称 | "呼叫任务123_测试" |
robotId | string | 是 | 外呼机器人唯一标识 | "90132624528086591" |
dialStartDate | string | 是 | 任务呼叫开始日期 | "2020-10-12" |
dialEndDate | string | 否 | 任务呼叫结束日期,如:XXXXX,默认为空,表示不限制终止时间 | "2020-10-12" |
dialStartTime | string | 是 | 呼叫开始时间,时间范围为【09:00,21:00】 | "09:00" |
dialEndTime | string | 是 | 呼叫结束时间,时间范围为【09:00,21:00】 | "21:00" |
forbidDialDate | array | 否 | 禁呼日期, 99-节假日;1-周一;2-周二;3-周三;4-周四;5-周五;6-周六;0-周日,默认为空,表示不限制禁呼日期 | [99,6,0] |
forbidDialTime | array | 否 | 禁呼时间,默认为空,表示不限制禁呼时间 | [{"forbidDialStartTime":"12:00","forbidDialEndTime":"13:00"},{"forbidDialStartTime":"14:00","forbidDialEndTime":"15:00"}] |
callerNums | array | 否 | 主叫号码,默认为空,表示将随机获取可用号码进行外呼 | ["07567171348","07567171349"] |
lastCallerNums | array | 否 | 保底主叫号码,默认为空,非空则开启了归属地匹配且在指定主叫中没找到匹配号码则默认用此外呼 | ["07567171346","07567171347"] |
blackListStrategy | int | 否 | 1-触发黑名单后该号码组不再拨打;2-触发黑名单后该号码不再拨打;默认为空,即不过滤黑名单 | 1 |
finalStrategy | int | 否 | 终态策略,0-存在接通 1-全部接通 2-存在完成 3-全部完成,默认为0,即存在接通 | 1 |
callStrategy | int | 否 | 拨打策略:0-批量 1-逐个/轮流 2-逐个/顺序,默认为0,即批量 | 1 |
retryTimes | int | 否 | 重试次数,整数,且 N ≤ 3,默认为空,表示不重试 | 3 |
retryInterval | int | 否 | 重试间隔时间,单位min,0≤ N ≤720 | 20 |
isSetCapacity | int | 否 | 0:空闲通路弹性调节;1:最低保障通路数;2:固定通路数,默认为0 | 0 |
taskCapacity | int | 否 | 设置通路数大小,N为 整数,且 N ≤ 任务可用通路数和,默认为0,即空闲通路弹性调节 | 5 |
isOpenEmptyNum | boolean | 是 | 是否开启24小时空号检测 | false |
isOpenPhoneDown | boolean | 是 | 是否开启12小时内停机检测 | false |
isOpenRepeatFilter | boolean | 否 | 是否开启重复号码过滤,true为开启,false为关闭 | false |
numTypeFilterList | array | 否 | 号码类型过滤 1-400号码;2-800号码;3-手机号码;4-固话;5-95号码;6-96号码;7-其他 | [1,2,3] |
smsStrategyV1 | array | 否 | 发送短信策略集合,smsAutographId为短信签名ID,smsTemplateId为短信模板ID,smsStrategy为短信触发策略,1-接通后挂机触发;2-未接通后挂机触发 | [{ “smsAutographId”: 3, “smsTemplateId”: 6,“smsStrategy”:1 }] |
taskDataCallback | bool | 否 | 默认false 是否开启任务回调 | true |
callBackUrl | String | 否 | 任务级回调地址设置 | http://xxxxxxx.yyy.zzz/aaa |
callFinishTaskEnd | int | 否 | 任务拨号完成后是否进入完成状态 | 0/1 0:拨号完成后任务不结束 1:拨号完成后任务结束 默认值为1 |
注:任务名称不可重复,格式:支持中英文、数字以及下划线,且不能以下划线开头,不超过40字
响应参数
名称 | 类型 | 备注 |
---|---|---|
code | int | http响应码,比如200 |
msg | string | 响应信息,成功为success,失败时为具体原因 |
data | obj | 成功时为任务ID |
data数据
名称 | 类型 | 备注 |
---|---|---|
taskId | string | 任务唯一标识,如:"731346584781056" |
请求示例
{
"taskName":"", //任务名称,必填
"robotId":"", //机器人唯一标识,必填
"dialStartDate":"", //任务呼叫开始日期,必填
"dialEndDate":"", //任务呼叫结束日期,非必填,未填写时表示不限制终止时间
"dialStartTime":"", //呼叫开始时间,必填
"dialEndTime":"", //呼叫结束时间,必填
"forbidDialDate":[], //禁呼日期, 99-节假日;1-周一;2-周二;3-周三;4-周四;5-周五;6-周六;0-周日,非必填
"forbidDialTime":[
{
"forbidDialStartTime":"12:00", //禁呼开始时间
"forbidDialEndTime":"14:00" // 禁呼结束时间
}
], //禁呼时间,非必填
"callerNums":[
"07567171348"
], //主叫号码,非必填,不填写时将随机获取可用号码进行外呼
"blackListStrategy":1, //1-触发黑名单后该号码组不再拨打;2-触发黑名单后该号码不再拨打;默认为空,即不过滤黑名单
"finalStrategy":0, //终态策略 0-存在接通 1-全部接通
"callStrategy":0, //拨打策略 0-批量 1-逐个/轮流 2-逐个/顺序
"retryTimes":3, //重试次数
"retryInterval":5, //重试间隔,单位min,0< N ≤720
"taskCapacity":1, //设置通路数大小,填写0时,系统根据可用的通路数实时调节
"isOpenEmptyNum":false, //是否开启空号校验,必填
"isOpenPhoneDown":false, //是否开启停机校验,必填
"isOpenRepeatFilter": true,//是否开启重复号码过滤,true为开启,false为关闭
"numTypeFilterList": [1,2,3,4],//1-400号码;2-800号码;3-手机号码;4-固话;5-95号码;6-96号码;7-其他
"smsStrategyV1": //短信策略集合
[
{
"smsAutographId": 3, // 短信签名id
"smsTemplateId": 6,//短信模板id
"smsStrategy": [1,2]//短信触发策略 1-接通后挂机触发;2-未接通后挂机触发
},
{
"smsAutographId": 3, // 短信签名id
"smsTemplateId": 5,//短信模板id
"smsStrategy": [1,2] //短信触发策略 1-接通后挂机触发;2-未接通后挂机触发
}
],
"callFinishTaskEnd":1
}
返回结果
{
"code": 200,
"msg": "success",
"data": {
"taskId": "731346584781056" //任务ID,必填
}
}