首页 帮助中心 API

创建AI外呼任务

说明： 创建AI外呼任务。

请求参数说明：

参数 说明 是否必填 类型

appId

应用id

是

String

name

任务名称

是

String

dialogFlowId

话术id

是

Int

mode

任务启动方式，共有两种方式，
MANUAL为手动启动，需要调用启动任务接口或者在界面上手动启动任务，
AUTO为自动启动，需要在建立任务时设定任务开始时间（startTime）以自动启动。

是

String

startDateTime

任务自动启动日期，该字段仅在任务启动方式(mode)为自动启动(AUTO)时必传，其他时候非必传且无效。
如:"2021-12-22 00:00:00"

否

String

dailyStartDateTime

可拨打开始时间，如"09:00"，默认不可以早于9点

是

String

dailyEndDateTime

可拨打结束时间，如"20:00"，默认不可以晚于20点

是

String

robotCount

任务使用的AI并发数

是

Int

jobPhoneNumberId

线路id

是

Int

endDateTime

外呼结束时间，如 "2022-02-07 10:00:00"

否

String

inactiveTimeList

不可拨打时间段，每日该时间段内任务会被挂起，最多可以设置三个不可拨打时间段，如:
[{"startTime":"12:00", "endTime":"13:00"},{"startTime":"14:00", "endTime":"15:00"},{"startTime":"16:00", "endTime":"17:00"}]

否

Array

inactiveDateList

不可拨打日期,最多可以设置三个不可拨打日期段，如:
[{"startDate":"2022-02-05","endDate":"2022-02-07"},{"startDate":"2022-02-08","endDate":"2022-02-09"},{"startDate":"2022-02-10","endDate":"2022-02-11"}]

否

Array

daysOfWeek

周可拨打时间段，如["MONDAY","TUESDAY"]

否

Array

redial

是否重播

是

Boolean

redialCondition

重播规则。此参数用于设定自动重播同时规定自动重播条件，仅符合此条件的客户会进行自动重播，可重播条件分为：
( CALL_LOSS,“呼损客户” )，
( NO_ANSWER,“无应答” )，
( BUSY,“忙线中” )，
( REFUSED,“拒接” )，
( POWER_OFF,“关机” )，
( OUT_OF_SERVICE,“停机” )，
( CAN_NOT_CONNECT,“无法接通“ )，
( FROM_PHONE_ERROR,“主叫欠费” )，
( SYSTEM_ERROR,“外呼失败” )，
( VACANT_NUMBER, “空号” )。
例如:["CALL_LOSS","NO_ANSWER"]

否

Array

redialInterval

重播间隔，单位分钟，最大值为1440

否

Int

redialTimes

重播次数（1~3）区间

否

Int

请求URL：

                      
                        https://api.onbuka.com/v3/AiVoice/taskAdd

请求示例：

                                                
                                                Request URL:
                                                    https://api.onbuka.com/v3/AiVoice/taskAdd
                                                Request Method:
                                                    POST
                                                Request Headers:
                                                    Content-Type: application/json;charset=UTF-8
                                                    Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                                                    Timestamp: 1630468800
                                                    Api-Key: bDqJFiq9
                                                Request Body:
                                                {
                                                    "appId": "epp4kNge",
                                                    "name": "11112",
                                                    "dialogFlowId": 8663,
                                                    "mode": "AUTO",
                                                    "dailyStartDateTime": "09:00",
                                                    "dailyEndDateTime": "20:00",
                                                    "robotCount": 1,
                                                    "jobPhoneNumberId": 2959,
                                                    "redial": false,
                                                    "startDateTime": "2023-09-16 00:00:00",
                                                    "endDateTime": "2022-02-07 10:00:00",
                                                    "inactiveTimeList": [{
                                                        "startTime": "12:00",
                                                        "endTime": "13:00"
                                                    }, {
                                                        "startTime": "14:00",
                                                        "endTime": "15:00"
                                                    }, {
                                                        "startTime": "16:00",
                                                        "endTime": "17:00"
                                                    }],
                                                    "inactiveDateList": [{
                                                        "startDate": "2022-02-05",
                                                        "endDate": "2022-02-07"
                                                    }, {
                                                        "startDate": "2022-02-08",
                                                        "endDate": "2022-02-09"
                                                    }, {
                                                        "startDate": "2022-02-10",
                                                        "endDate": "2022-02-11"
                                                    }],
                                                    "daysOfWeek": ["MONDAY"]
                                                }

响应参数说明：

参数 说明 类型

status

状态码，0成功，其他失败参见状态码说明

String

reason

失败原因说明

String

data

创建的任务ID

Long

响应示例：

                                                
                                                    {
                                                        "status": "0",
                                                        "reason": "success",
                                                        "data": 10912
                                                    }
 

意见反馈

0/500
✖
工单服务
1. 需求类型
2. 需求描述
3. 邮箱