查询任务配置
更新时间:2024-05-27
URL
https://aiob-open.baidu.com/api/v3/console/apitask/gettask
https://aicc.bce.baidu.com/api/v3/console/apitask/gettask(即将下架)
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 |
Body
名称 | 类型 | 是否必须 | 说明 | 示例 |
---|---|---|---|---|
taskId | string | 是 | 需要查询的任务唯一标识,创建任务时产生 | "731346584781056" |
响应参数
名称 | 类型 | 备注 |
---|---|---|
code | int | http响应码,比如200 |
msg | string | 响应信息,成功为success,失败时为具体原因 |
data | obj | 成功时为任务的具体配置 |
data数据
名称 | 类型 | 备注 |
---|---|---|
tenantId | long | 租户ID,租户唯一标识 |
userId | long | 任务创建人ID |
lastEditUserId | long | 任务最后修改人ID |
taskId | long | 任务ID,任务唯一标识 |
taskName | string | 任务名称 |
robotId | string | 外呼机器人唯一标识 |
robotName | string | 机器人名称 |
status | int | 任务状态,1-待启动;2-执行中;3-已暂停;4-已完成 |
callerNums | array | 主叫号码,默认为空,表示将随机获取可用号码进行外呼 |
dialStartDate | string | 任务呼叫开始日期 |
dialEndDate | string | 任务呼叫结束日期,返回为空,表示不限制终止时间 |
dialStartTime | string | 呼叫开始时间 |
dialEndTime | string | 呼叫结束时间 |
forbidDialDate | array | 禁呼日期, 99-节假日;1-周一;2-周二;3-周三;4-周四;5-周五;6-周六;0-周日,为空时表示无禁呼日期 |
forbidDialTimeIsEmpty | int | 是否设置禁呼时间,0:启用,1:未启用 |
forbidDialTime | array | 禁呼时间,为空时表示无禁呼时间 |
isSetCapacity | int | 是否设置通路数,0-未设置,即空闲通路弹性调节;1-设置弹性通路数 |
taskCapacity | int | 设置通路数大小,为0表示空闲通路弹性调节 |
retryTimes | int | 重试次数 |
retryInterval | int | 重试间隔时间,min |
blackListStrategy | int | 1-触发黑名单后该号码组不再拨打;2-触发黑名单后该号码不再拨打;为空时表示不过滤黑名单 |
finalStrategy | int | 终态策略,0-存在接通 1-全部接通,2-存在完成,3-全部完成 |
callStrategy | int | 拨打策略:0-批量 1-逐个/轮流 2-逐个/顺序 |
isOpenRepeatFilter | boolean | 号码重复过滤:true为开启,false为关闭 |
isOpenBlackList | boolean | 是否开启过滤黑名单:true为开启,false为关闭 |
blackListStrategy | int | 过滤黑名单策略:1-触发后号码组不再拨打 2-触发后该号码不再拨打 |
isOpenEmptyNum | boolean | 是否开启24小时空号检测,true为开启,false为关闭 |
isOpenPhoneDown | boolean | 是否开启12小时内停机检测,true为开启,false为关闭 |
isOpenNumTypeFilter | boolean | 是否开启号码类型过滤,true为开启,false为关闭 |
numTypeFilterList | array | 号码类型数组, 1-400号码;2-800号码;3-手机号码;4-固话;5-95号码;6-96号码;7-其他 |
isShortMessageSend | boolean | 是否发送短信,true为=开启,false为关闭 |
smsStrategyV1 | array | 短信策略数组,smsAutographId为短信签名ID,smsTemplateId为短信模板ID,smsStrategy为短信触发策略 |
taskDataCallback | bool | 是否开启任务回调 |
callBackUrl | string | 任务回调地址 |
callFinishTaskEnd | int | 0/1 0:拨号完成后任务不结束 1:拨号完成后任务结束 |
请求示例
{
"taskId":"731346584781056" //任务ID
}
返回示例
{
"code": 200,
"msg": "success",
"data": {
"tenantId": 10363, //租户ID
"taskId": 731346584781056, //任务ID
"taskName": "test_zjq_zpi_001", //任务名称
"robotId": "2765019f-bef5-4f67-a3ac-1bd48db42e10", //机器人ID
"robotName": "", //机器人名称
"status": 1, //任务状态
"callerNums": [
"07567171348"
],//主叫号码
"dialStartDate": "2021-05-31",//任务呼叫开始日期
"dialEndDate": "2021-05-31",//任务呼叫开始日期
"dialStartTime": "09:00",//任务呼叫开始时间
"dialEndTime": "21:00",//任务呼叫结束时间
"forbidDialDate": [
6,
0
],//禁呼日期, 99-节假日;1-周一;2-周二;3-周三;4-周四;5-周五;6-周六;0-周日,为空时表示无禁呼日期
"forbidDialTimeIsEmpty": 0, //是否启用禁呼时间 0:启用,1:未启用
"forbidDialTime": [
{
"forbidDialStartTime": "12:00",
"forbidDialEndTime": "14:00"
}
],//禁呼时间
"taskCapacity": 0,//设置的通路数大小,填写0时,系统根据可用的通路数实时调节
"retryTimes": 3,//重试次数
"retryInterval": 5,//重试间隔,单位分钟
"finalStrategy": 0,//终态策略 0-存在接通 1-全部接通
"callStrategy": 1,//拨打策略 0-批量 1-逐个/轮流 2-逐个/顺序
"blackListStrategy": 1,//1-触发黑名单后该号码组不再拨打;2-触发黑名单后该号码不再拨打;默认为空,即不过滤黑名单
"isOpenBlackList": false,
"blackListStrategy": null,
"isOpenEmptyNum": true,//是否开启空号校验,true为开启,false为关闭
"isOpenPhoneDown": true//是否开启关机校验,true为开启,false为关闭
"isOpenNumTypeFilter": true,// 是否开启号码类型过滤,true为开启,false为关闭
"numTypeFilterList": [1,2,3,4],//1-400号码;2-800号码;3-手机号码;4-固话;5-95号码;6-96号码;7-其他
"isShortMessageSend": true,//是否发送短信,true为=开启,false为关闭
"smsStrategyV1": //短信策略集合
[
{
"smsAutographId": 3, // 短信签名id
"smsTemplateId": 6, //短信模板id
"smsStrategy": [ 1 ] //短信触发策略 1-接通后挂机触发;2-未接通后挂机触发
},
{
"smsAutographId": 3, // 短信签名id
"smsTemplateId": 6,//短信模板id
"smsStrategy": [ 2 ]
}
],
"taskDataCallback":false,
"callBackUrl":"http://www.url.com/path",
"callFinishTaskEnd":1
}
}