文档

CreateBatchJobs - 批量创建外呼作业

更新时间:

批量创建外呼作业。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

174952ab-9825-4cc9-a5e2-de82d7fa4cdd
BatchJobNamestring

批量作业名字

第一个作业组
BatchJobDescriptionstring

批量作业名字

描述
ScenarioIdstring

场景 ID

c6a668d1-3145-4048-9101-cb3678bb8884
ScriptIdstring

话术 ID

b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
StrategyJsonstring

作业执行策略 JSON

{"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60}
JobFilePathstring

下载批量作 Excel 的地址

52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx
Submittedboolean

是否提交,false 提交,true 草稿状态

false
CallingNumberarray

主叫号码列表。

string

主叫号码。

["4008013260"]

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 错误码

200
Codestring

错误码

OK
Messagestring

提示信息

Success
RequestIdstring

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Successboolean

是否成功

true
BatchJobobject

作业组信息

CreationTimelong

作业组创建时间

1579068424000
ScenarioIdstring

作业组场景 ID

6cea9bed-63e6-439e-ae4c-b3333efff53d
JobGroupNamestring

作业组名字

批量作业01
BatchJobIdstring

作业组 ID

5a7e8b09-baf9-4cab-b540-c971f47a7146
JobFilePathstring

上传 Excel 文件 key

52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx
JobGroupDescriptionstring

作业组描述

第一个批量作业
CallingNumbersarray
string

主叫号码列表

["4008013260 "]
Strategyobject

作业执行策略

Typestring

策略类型

Repeatable
StrategyNamestring

策略名字

策略
MaxAttemptsPerDayinteger

拨打失败后最多重新拨打次数

3
FollowUpStrategystring

前周期未完成外呼业务的后续处理方案。

CONTINUE
EndTimelong

调度策略总的结束时间

2209702074000
Customizedstring

策略自定义信息

{}
IsTemplateboolean

是否是模板

false
StartTimelong

作业组开始执行时间

1578550074000
StrategyIdstring

策略 ID

f718798d-96be-40e4-bef6-317b54855708
RoutingStrategystring

主叫号码录音策略

LocalFirst
MinAttemptIntervalinteger

重新拨打间隔时间

10
StrategyDescriptionstring

策略描述

作业执行策略
RepeatBystring

重复执行方式,Once 不重复, Day 没人重复, Week 每周重复,Month 每月重复

Once
WorkingTimearray<object>

作业一天中的执行时间段

object
EndTimestring

结束时间

12:00:00
BeginTimestring

开始时间

09:00:00
RepeatDaysarray

重复执行的天列表。

string

重复执行天

[1,2,3,4,5]

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "BatchJob": {
    "CreationTime": 1579068424000,
    "ScenarioId": "6cea9bed-63e6-439e-ae4c-b3333efff53d",
    "JobGroupName": "批量作业01",
    "BatchJobId": "5a7e8b09-baf9-4cab-b540-c971f47a7146",
    "JobFilePath": "52e80b02-0126-4556-a1e6-ef5b3747ed53/a9a3ddc7-d7d7-48cd-82b5-b31bb5510e71_2a66f8ad-dfbb-4980-9b84-439171295a11.xlsx",
    "JobGroupDescription": "第一个批量作业",
    "CallingNumbers": [
      "[\"4008013260 \"]"
    ],
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "策略",
      "MaxAttemptsPerDay": 3,
      "FollowUpStrategy": "CONTINUE",
      "EndTime": 2209702074000,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578550074000,
      "StrategyId": "f718798d-96be-40e4-bef6-317b54855708",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 10,
      "StrategyDescription": "作业执行策略",
      "RepeatBy": "Once",
      "WorkingTime": [
        {
          "EndTime": "12:00:00",
          "BeginTime": "09:00:00"
        }
      ],
      "RepeatDays": [
        "[1,2,3,4,5]"
      ]
    }
  }
}

错误码

HTTP status code错误码错误信息描述
404NotExist.InstanceThe specified Instance does not exist.指定的实例不存在。
404NotExist.ScriptThe specified Script does not exist.指定的话术不存在。
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史