文档

CreateJobGroup - 创建外呼任务

更新时间:

创建作业组。

调试

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

授权信息

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

请求参数

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

实例 ID

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

任务名字。

第一个任务
JobGroupDescriptionstring

任务描述。

任务描述
ScenarioIdstring

业务场景。旧版画布参数,公共云客户场景使用 ScriptId 即可。

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

话术场景 ID。该参数不能和 ScenarioId 同时为空。

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

任务执行策略。

  • RepeatBy 重复类型。Once(不重复),Day(按天重复),Week(按周重复),Month(按月重复);
  • StartTime 策略开始时间。
  • EndTime 策略结束时间。
  • WorkingTime 可外呼时间段。
  • MaxAttemptsPerDay 每天该任务下号码最大可尝试呼叫次数。
  • MinAttemptInterval 号码重试呼叫时间间隔,单位分钟。
  • RoutingStrategy 号码策略,None(不指定),LocalFirst(本市号码优先), LocalProvinceFirst(本省号码优先)。
  • RepeatDays 对应重复类型下的执行日期。若重复类型 RepeatBy 为周,0 表示周日,1-6 分别表示周一至周六;若重复周期 RepeatBy 为月,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行。
{"maxAttemptsPerDay":"3","minAttemptInterval":"10","routingStrategy":"LocalProvinceFirst","repeatDays":["1","2","3"],"workingTime":[{"beginTime":"10:00:00","endTime":"11:00:00"},{"beginTime":"14:00:00","endTime":"15:00:00"}],"repeatable":true,"endTime":1707494400000,"startTime":1706976000000,"repeatBy":"Week"}
RecallStrategyJsonstring

重拨策略,JSON 格式。

  • emptyNumberIgnore:空号不外呼。
  • inArrearsIgnore:欠费不外呼。
  • outOfServiceIgnore:停机不外呼。
{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}
CallingNumberarray

主叫号码列表。

string

主叫号码。

["4008013260"]
RingingDurationlong

最优振铃时长。

25
Prioritystring

作业组优先级,取值范围如下

  • Urgent:紧急任务。
  • Daily:日常任务。
Daily
MinConcurrencylong

并发保障值。

  • 任务启动时,最低保障 N 个并发。
  • 同一优先级的任务并发保障值加和不能大于实例并发。
  • 若配置并发保障值为 0,则依赖系统内空闲并发进行智能分配。
1
FlashSmsExtrasstring

闪信推送的配置参数,JSON 格式,包含第三方闪信的配置信息。

  • templateId: 闪信模板 ID。
  • configId: 闪信配置 ID。
{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}
RecallCallingNumberarray
string

重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。

["4008013260"]

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 返回码。

200
Codestring

响应码。

OK
Messagestring

提示信息。

Success
RequestIdstring

请求 ID。

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

是否成功。

true
JobGroupobject

任务信息。

Statusstring

任务状态。

Scheduling
ScenarioIdstring

场景 ID。

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

任务 ID。

c62e6789-28a8-41db-941e-171a01d3b3b9
CreationTimelong

创建时间。

1578550074361
JobGroupNamestring

任务名称。

第一个作业组
JobFilePathstring

任务文件 OSS 路径。

UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx
JobGroupDescriptionstring

任务描述。

第一个的作业组
JobDataParsingTaskIdstring

上传的任务文件对应后台异步解析操作的 ID.

744ff448-2b4c-40d4-94ca-51f246905b0f
ScriptNamestring

话术场景名称。

话术
ScriptVersionstring

话术场景版本。

1628425608429
ModifyTimestring

修改时间。

1628425608429
CallingNumbersarray

主叫号码列表。

string

主叫号码。

["4008013260"]
ExportProgressobject

导出进度。(该字段在当前接口已删除)

Statusstring

任务导出状态。

FINISHED
FileHttpUrlstring

文件地址。

https://***.oss-cn-shanghai.aliyuncs.com/sample
Progressstring

进度。

1
Strategyobject

任务调度策略。

Typestring

策略类型。

Repeatable
StrategyNamestring

策略名字。

催收策略
MaxAttemptsPerDayinteger

任务中电话未能接通时每天的最多尝试次数。

3
FollowUpStrategystring

执行周期结束后的后续处理方式(该字段不再使用)。

CONTINUE
EndTimelong

结束时间

2209702074000
Customizedstring

策略自定义数据

{}
IsTemplateboolean

是否是模板

false
StartTimelong

开始时间。

1578550074000
StrategyIdstring

策略 ID。

cc9a436e-03b0-4ada-8364-77ec2290aa39
RoutingStrategystring

号码策略。

  • None:无特殊规则。
  • LocalFirst:本市号码优先。
  • LocalProvinceFirst:本省号码优先。
LocalFirst
MinAttemptIntervalinteger

拨打间隔时间

3
StrategyDescriptionstring

策略描述

催收策略
RepeatBystring

重复执行方式,once 不重复,day 每天重复,week 每周重复,month 每月重复

Once
WorkingTimearray<object>

策略执行时间窗口

object

策略执行时间窗口

EndTimestring

窗口开始时间

12:00:00
BeginTimestring

窗口结束时间

09:00:00
RepeatDaysarray

重复的执行天。

  • 若重复周期 RepeatBy,0 表示周日,1-6 分别表示周一至周六
  • 若重复周期 RepeatBy,1-31 分别表示 1 至 31 日,没有该指定日期的月份不执行,如:若选定 30 日,二月份不执行
string

重复的执行天

[1,2,3,4,5]
RecallStrategyobject

重拨策略。

EmptyNumberIgnoreboolean

空号不再外呼

true
InArrearsIgnoreboolean

欠费不再外呼

true
OutOfServiceIgnoreboolean

停机不再外呼

true
RingingDurationlong

振铃时长

30
Prioritystring

作业组优先级,取值范围

  • Urgent:紧急任务。
  • Daily:日常任务。
Daily
MinConcurrencylong

并发保障值 任务启动时,最低保障 N 个并发; 同一优先级的任务并发保障值加和不能大于实例并发; 若配置并发保障值为 0,则依赖系统内空闲并发进行智能分配。

1
RecallCallingNumbersarray
string

重呼主叫号码列表,指第一次没打通。重呼时使用的主叫,不指定的话,默认和主叫列表一致。

["4008013260"]

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "JobGroup": {
    "Status": "Scheduling",
    "ScenarioId": "6cea9bed-63e6-439e-ae4c-b3333efff53d",
    "JobGroupId": "c62e6789-28a8-41db-941e-171a01d3b3b9",
    "CreationTime": 1578550074361,
    "JobGroupName": "第一个作业组",
    "JobFilePath": "UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx",
    "JobGroupDescription": "第一个的作业组",
    "JobDataParsingTaskId": "744ff448-2b4c-40d4-94ca-51f246905b0f",
    "ScriptName": "话术",
    "ScriptVersion": "1628425608429",
    "ModifyTime": "1628425608429",
    "CallingNumbers": [
      "[\"4008013260\"]"
    ],
    "ExportProgress": {
      "Status": "FINISHED",
      "FileHttpUrl": "https://***.oss-cn-shanghai.aliyuncs.com/sample",
      "Progress": "1"
    },
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "催收策略",
      "MaxAttemptsPerDay": 3,
      "FollowUpStrategy": "CONTINUE",
      "EndTime": 2209702074000,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578550074000,
      "StrategyId": "cc9a436e-03b0-4ada-8364-77ec2290aa39",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 3,
      "StrategyDescription": "催收策略",
      "RepeatBy": "Once",
      "WorkingTime": [
        {
          "EndTime": "12:00:00",
          "BeginTime": "09:00:00"
        }
      ],
      "RepeatDays": [
        "[1,2,3,4,5]"
      ]
    },
    "RecallStrategy": {
      "EmptyNumberIgnore": true,
      "InArrearsIgnore": true,
      "OutOfServiceIgnore": true
    },
    "RingingDuration": 30,
    "Priority": "Daily",
    "MinConcurrency": 1,
    "RecallCallingNumbers": [
      "[\"4008013260\"]"
    ]
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-06-24OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2024-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情