自动外呼接口

该接口文档用于【创建任务外呼任务、IVR流程、导入号码数据】等操作。 具体IVR流程配置无法用接口完成,需要登录极简云后台配置

自动外呼任务创建接口

  • 请求方式:POST
  • 请求地址:/openapi/call/web/v1/autoCallTask/createIntelligentCall
  • 请求时请进行接口鉴权

请求体字段解说明

字段类型是否必须备注
createUserString创建人坐席工号
nameString智能外呼名称
descriptionString智能外呼描述
callStrategyobject呼叫策略
->concurrentTypeString并发类型,stable固定并发 dynamic动态并发
->concurrentint条件并发数,固定并发是必填
->maxConcurrentint条件最大并发数,动态并发必填
->freeAgentCountint条件动态并发倍率,动态并发必填
priorityint任务优先级
startTypeString启动方式 manual手动启动 timing定时启动
timingStartTimeString条件定时启动时间,定时启动必填,yyyy-MM-dd HH:mm:ss
timeConditionNameString运行时间
ivrNameString语音导航(需要后台配置)
numberTypeString号码类型 number外显号码 group号码组
numberListList<String>条件号码列表,选外显号码时必填
numberGroupString条件号码组,选号码组时必填
timeOutint振铃时间 秒

请求体

{ "name":"test112", "description":"123", "callStrategy":{"concurrentType":"stable","concurrent":1}, "priority":1, "startType":"manual", "timeConditionName":"2024", "ivrName":"ssss1", "numberType":"number", "numberList":["02862280304"], "timeOut":20 }

返回参数

字段名称字段类型字段描述
successboolean请求是否成功
_idString唯一标识
messageString响应结果

返回示例

{ "success": true, "message": "200 ok!", "code": "200", "data": { "_id": "ec731c0d-14c6-46b1-a23c-2401665ece7e", "accountId": "1019", "name": "zxcs", "description": "zhangxuan", "priority": 1, "actualConcurrent": 0, "accountMaxConcurrent": 0, "callStrategy": { "concurrentType": "stable", "concurrent": 1, "magnification": null, "maxConcurrent": null, "freeAgentCount": 0 }, "timeConditionId": "2bbc588d-081c-4b8e-bbad-3f024fbc4f1d", "ivrId": "975196973752930304", "ivrType": null, "dynamicDisplayNumId": null, "timeOut": 20, "startType": "manual", "timingStartTime": null, "openRepeatCall": false, "repeatCallConfig": { "callResult": [], "repeatCount": 0, "repeatIntervalType": "afterNumber", "interval": null, "frequencyConfig": [] }, "status": "notTurnedOn", "callout": 0, "total": 0, "dealing": 0, "called": 0, "createTime": "2025-09-05T07:44:39.250+00:00", "updateTime": "2025-09-05T07:44:39.250+00:00", "createUser": "openapi", "updateUser": null, "executeTime": "2025-09-05T07:44:39.250+00:00", "isManualPause": false, "isTimerStart": false, "repeatCallComplete": null, "taskNumberDialComplete": null, "isControllerTimerStart": null, "isControllerTimerStop": null, "numberType": "number", "numberList": [ "02823034031" ], "numberGroup": null, "order": 4, "callStatus": { "call_limit": 0, "black_list": 0, "ivr": 0, "queue_abandon": 0, "voicemail": 0, "answer": 0, "agent_no_answer": 0, "customer_no_answer": 0, "call_transfer": 0, "call_threeway": 0, "call_consult": 0, "call_consult_transfer": 0, "risk": 0 }, "init": false }, "traceId": "2b870adb5944445881330096c2319ea3" }

自动外呼导入数据接口

  • 请求方式:POST
  • 请求地址:/openapi/call/web/v1/autoCallTask/insertOutboundTaskData
  • 请求时请进行接口鉴权

请求体字段解说明

字段类型是否必须备注
taskIdString任务ID
duplicateCheckTypeString号码去重方式:1:账户内所用任务去重,2:当前任务内去重,3:不检测
createUserString操作人
numbersarray导入的数据,此值类型为数组
->phoneString手机号
->extrasString额外参数,传参需要是jsonString格式,该参数可以用在ivr中,且extras参数会在通话事件推送中同步推送给用户的接口。

请求示例请求体

{ "duplicateCheckType" : "3", "taskId" : "e8b0b776-5d9d-47a9-b84f-2b024f058c75", "numbers" : [{"phone":"13778220778","extras" :"{\"vo\":\"测试测试\",\"id\":\"1234531\"}"}, {"phone":"17854110073","extras" :"{\"vo\":\"测试测试\",\"id\":\"1234531\"}"}] }

返回参数

字段名称字段类型字段描述
successboolean请求是否成功
codeString响应码
messageString响应结果

返回示例

{ "success": true, "code": 200, "message": "200 OK" }
2026-09-14