AI 助理
备案控制台
文档
输入文档关键字查找
首页 智能外呼机器人 开发参考 API参考 作业组管理 CreateJobGroup

CreateJobGroup

更新时间：
产品详情
我的收藏

创建作业组。

调试

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

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 CreateJobGroup

系统规定参数。取值：CreateJobGroup。
InstanceId String 是 174952ab-9825-4cc9-a5e2-de82d7fa4cdd

实例ID
JobGroupName String 是 第一个任务

任务名字。
JobGroupDescription String 否 任务描述

任务描述。
ScenarioId String 否 b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

旧画布业务场景。旧版画布参数，公共云客户场景使用ScriptId即可。
ScriptId String 否 b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

新画布话术场景ID。该参数不能和ScenarioId同时为空。
StrategyJson String 否 {"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"}

任务执行策略。

  • 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日，二月份不执行。
RecallStrategyJson String 否 {"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true}

重拨策略，JSON格式。

  • emptyNumberIgnore：空号不外呼。
  • inArrearsIgnore：欠费不外呼。
  • outOfServiceIgnore：停机不外呼。
CallingNumber.N String 否 4008013260

主叫号码。
RingingDuration Long 否 25

最优振铃时长。
Priority String 否 Daily

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

  • Urgent：紧急任务。
  • Daily：日常任务。
MinConcurrency Long 否 1

并发保障值。

  • 任务启动时，最低保障N个并发。
  • 同一优先级的任务并发保障值加和不能大于实例并发。
  • 若配置并发保障值为0，则依赖系统内空闲并发进行智能分配。
FlashSmsExtras String 否 {"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}

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

  • templateId: 闪信模板ID。
  • configId: 闪信配置ID。
RecallCallingNumber.N String 否 ["4008013260"]

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

返回数据

名称

类型

示例值

描述
HttpStatusCode Integer 200

HTTP返回码。
Code String OK

响应码。
Message String Success

提示信息。
RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求ID。
Success Boolean true

是否成功。
JobGroup Object

任务信息。
Status String Scheduling

任务状态。
ScenarioId String 6cea9bed-63e6-439e-ae4c-b3333efff53d

场景ID。
JobGroupId String c62e6789-28a8-41db-941e-171a01d3b3b9

任务ID。
CreationTime Long 1578550074361

创建时间。
JobGroupName String 第一个作业组

任务名称。
JobFilePath String UPLOADED/JOB/b3865dc3-40fa-4afd-9fe4-dc7cda305a24/229eac13-379d-4abe-96e0-8cf026b56c0b_template (1).xlsx

任务文件OSS路径。
JobGroupDescription String 第一个的作业组

任务描述。
JobDataParsingTaskId String 744ff448-2b4c-40d4-94ca-51f246905b0f

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

话术场景名称。
ScriptVersion String 1628425608429

话术场景版本。
ModifyTime String 1628425608429

修改时间。
CallingNumbers Array of 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 cc9a436e-03b0-4ada-8364-77ec2290aa39

策略ID。
RoutingStrategy String LocalFirst

号码策略。

  • None：无特殊规则。
  • LocalFirst：本市号码优先。
  • LocalProvinceFirst：本省号码优先。
MinAttemptInterval Integer 3

拨打间隔时间
StrategyDescription String 催收策略

策略描述
RepeatBy String Once

重复执行方式，once不重复，day每天重复，week每周重复，month每月重复
WorkingTime Array of TimeFrame

策略执行时间窗口
EndTime String 12:00:00

窗口开始时间
BeginTime String 09:00:00

窗口结束时间
RepeatDays Array of String [1,2,3,4,5]

重复的执行天
RecallStrategy Object

重拨策略。
EmptyNumberIgnore Boolean true

空号不再外呼
InArrearsIgnore Boolean true

欠费不再外呼
OutOfServiceIgnore Boolean true

停机不再外呼
RingingDuration Long 30

振铃时长
Priority String Daily

作业组优先级，取值范围

  • Urgent：紧急任务。
  • Daily：日常任务。
MinConcurrency Long 1

并发保障值

任务启动时，最低保障N个并发；

同一优先级的任务并发保障值加和不能大于实例并发；

若配置并发保障值为0，则依赖系统内空闲并发进行智能分配。
RecallCallingNumbers Array of String ["4008013260"]

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

示例

请求示例

http(s)://[Endpoint]/?Action=CreateJobGroup
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&JobGroupName=第一个作业组
&JobGroupDescription=描述
&ScenarioId=c6a668d1-3145-4048-9101-cb3678bb8884
&ScriptId=b9ff4e88-65f9-4eb3-987c-11ba51f3f24d
&StrategyJson={\"maxAttemptsPerDay\":1,\"name\":\"fa16dc2e-f778-44ab-8f25-54b7901df82a\",\"startTime\":1640157314127,\"endTime\":1640160914127,\"minAttemptInterval\":10}
&RecallStrategyJson={\"emptyNumberIgnore\":true,\"inArrearsIgnore\":true,\"outOfServiceIgnore\":true}
&CallingNumber=["[\"4008013260\"]"]
&RingingDuration=25
&Priority=Daily
&MinConcurrency=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : [ ]
  }
}

错误码

HttpCode

错误码

错误信息

描述
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. 内部错误。建议重试，如果多次重试报错请提交工单。

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

上一篇：作业组管理下一篇：DeleteJobGroup
文档推荐