CreateJobGroup - 创建外呼任务组_智能外呼机器人(Outbound Bot)-阿里云帮助中心

创建作业组。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:CreateJobGroup	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID	174952ab-9825-4cc9-a5e2-de82d7fa4cdd
JobGroupName	string	是	任务名字。	第一个任务
JobGroupDescription	string	否	任务描述。	任务描述
ScenarioId	string	否	已废弃	b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
ScriptId	string	是	场景 ID。	b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
StrategyJson	string	否	任务执行策略。 repeatBy 重复类型。Once（不重复），Week（按周重复），Month（按月重复）； startTime 按时间执行时的策略开始时间。 endTime 按时间执行的策略结束时间。说明执行方式分为不填写策略开始与结束时间时，执行方式为立即执行。当填入策略时间后，表示按时间执行，同时需要选择重复类型 repeatBy。 workingTime 可外呼时间段。 maxAttemptsPerDay 每天该任务下号码最大可尝试呼叫次数。 minAttemptInterval 号码重试呼叫时间间隔，单位分钟。 routingStrategy 号码策略，None（不指定），LocalFirst（本市号码优先）， - LocalProvinceFirst（本省号码优先）。 repeatDays 对应重复类型下的执行日期。若重复类型 RepeatBy 为周，0 表示周日，1-6 分别表示周一至周六；若重复周期 RepeatBy 为月，1-31 分别表示 1 至 31 日，没有该指定日期的月份不执行，如：若选定 30 日，二月份不执行。 repeatable 是否开启循环任务，true/false	{"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"}
RecallStrategyJson	string	否	重拨策略，JSON 格式，json 中参数值默认为 false。 emptyNumberIgnore：空号不外呼。 inArrearsIgnore：欠费不外呼。 outOfServiceIgnore：停机不外呼。	{"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}
CallingNumber	array	否	主叫号码列表。若不填写，则默认全选该实例下绑定的号码
	string	否	主叫号码。	4008013260
RingingDuration	long	否	最优振铃时长。默认为 25	25
Priority	string	否	作业组优先级，取值范围如下 Urgent：紧急任务。 Daily：日常任务。	Daily
MinConcurrency	long	否	并发保障值。任务启动时，最低保障 N 个并发。同一优先级的任务并发保障值加和不能大于实例并发。若配置并发保障值为 0，则依赖系统内空闲并发进行智能分配。	1
FlashSmsExtras	string	否	闪信推送的配置参数，JSON 格式，包含第三方闪信的配置信息。 templateId: 闪信模板 ID。 configId: 闪信配置 ID。	{"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}
RecallCallingNumber	array	否	重呼主叫号码列表
	string	否	重呼主叫号码列表，指第一次没打通。重呼时使用的主叫，不指定的话，默认和主叫列表一致。	["4008013260"]

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 返回码。	200
Code	string	响应码。	OK
Message	string	提示信息。	Success
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功。	true
JobGroup	object	任务信息。
Status	string	任务状态。	Scheduling
ScenarioId	string	场景 ID。	6cea9bed-63e6-439e-ae4c-b3333efff53d
JobGroupId	string	任务 ID。	c62e6789-28a8-41db-941e-171a01d3b3b9
CreationTime	long	创建时间。	1578550074361
JobGroupName	string	任务名称。	第一个作业组
JobFilePath	string	任务文件 OSS 路径。说明无值，不做返回	UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx
JobGroupDescription	string	任务描述。	第一个的作业组
JobDataParsingTaskId	string	上传的任务文件对应后台异步解析操作的 ID. 说明无值，不做返回	744ff448-2b4c-40d4-94ca-51f246905b0f
ScriptName	string	话术场景名称。	话术
ScriptVersion	string	话术场景版本。	1628425608429
ModifyTime	string	修改时间。	1628425608429
CallingNumbers	array	主叫号码列表。
String	string	主叫号码。	["4008013260"]
ExportProgress	object	导出进度。说明该字段在当前参数已废弃
Status	string	任务导出状态。【已废弃】	FINISHED
FileHttpUrl	string	文件地址。【已废弃】	https://***.oss-cn-shanghai.aliyuncs.com/sample
Progress	string	进度。【已废弃】	1
Strategy	object	任务调度策略。
Type	string	策略类型。	Repeatable
StrategyName	string	策略名字。	催收策略
MaxAttemptsPerDay	integer	任务中电话未能接通时每天的最多尝试次数。	3
FollowUpStrategy	string	执行周期结束后的后续处理方式（该字段不再使用）。	CONTINUE
EndTime	long	结束时间	2209702074000
Customized	string	策略自定义数据	{}
IsTemplate	boolean	是否是模板	false
StartTime	long	开始时间。	1578550074000
StrategyId	string	策略 ID。	cc9a436e-03b0-4ada-8364-77ec2290aa39
RoutingStrategy	string	号码策略。 None：无特殊规则。 LocalFirst：本市号码优先。 LocalProvinceFirst：本省号码优先。	LocalFirst
MinAttemptInterval	integer	拨打间隔时间	3
StrategyDescription	string	策略描述	催收策略
RepeatBy	string	重复执行方式，once 不重复，day 每天重复，week 每周重复，month 每月重复	Once
WorkingTime	array<object>	策略执行时间窗口
TimeFrame	object	策略执行时间窗口
EndTime	string	窗口开始时间	12:00:00
BeginTime	string	窗口结束时间	09:00:00
RepeatDays	array	重复的执行天。若重复周期 RepeatBy 为周，0 表示周日，1-6 分别表示周一至周六若重复周期 RepeatBy 为月，1-31 分别表示 1 至 31 日，没有该指定日期的月份不执行，如：若选定 30 日，二月份不执行
Integer	string	重复的执行天	[1,2,3,4,5]
RecallStrategy	object	重拨策略。
EmptyNumberIgnore	boolean	空号不再外呼	true
InArrearsIgnore	boolean	欠费不再外呼	true
OutOfServiceIgnore	boolean	停机不再外呼	true
RingingDuration	long	振铃时长	30
Priority	string	作业组优先级，取值范围 Urgent：紧急任务。 Daily：日常任务。	Daily
MinConcurrency	long	并发保障值任务启动时，最低保障 N 个并发；同一优先级的任务并发保障值加和不能大于实例并发；若配置并发保障值为 0，则依赖系统内空闲并发进行智能分配。	1
RecallCallingNumbers	array	重呼主叫号码列表
String	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	错误码	错误信息	描述
404	NotExist.Instance	The specified Instance does not exist.	指定的实例不存在。
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

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

变更历史

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