创建外呼作业组（不包含外呼任务）

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 CreateJobGroup

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

实例id
JobGroupName String 是 第一个作业组

作业组名字
JobGroupDescription String 否 描述

作业组描述
ScenarioId String 否 c6a668d1-3145-4048-9101-cb3678bb8884

场景id，为了兼容旧版外呼功能。可不填。
ScriptId String 否 b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

话术id，必填。
StrategyJson String 否 {"maxAttemptsPerDay":1,"name":"策略名字","startTime":1631503815256,"workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"14:00:00","endTime":"16:00:00"}],"endTime":1631521815256,"minAttemptInterval":1}

作业组执行策略

name：策略名称

maxAttemptsPerDay：号码每天最大呼叫次数

minAttemptInterval：未接通情况下的重试时间间隔，单位为分钟

startTime：开始时间戳

endTime：结束时间戳

workingTime：时间窗口，24小时制
CallingNumber.N RepeatList 否 ["95187"]

主叫号码列表

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码
HttpStatusCode Integer 200

http 状态码
JobGroup Struct

作业组信息
CallingNumbers List ["95187"]

主叫号码列表
CreationTime Long 1578550074361

创建时间
ExportProgress Struct

导出进度
FileHttpUrl String https://***.oss-cn-shanghai.aliyuncs.com/sample

文件地址
Progress String 1

进度
Status String FINISHED

状态
JobDataParsingTaskId String da37319b-6c83-4268-9f19-814aed62e401/0cc1b8f0-2f2f-4815-ad23-696d2de9c0d1_cdecew1.xlsx

解析上传的任务信息的ID
JobFilePath String da37319b-6c83-4268-9f19-814aed62e401/0cc1b8f0-2f2f-4815-ad23-696d2de9c0d1_cdecew1.xlsx

上传后的excel 文件key
JobGroupDescription String 第一个的作业组

作业组描述
JobGroupId String c62e6789-28a8-41db-941e-171a01d3b3b9

作业组id
JobGroupName String 第一个作业组

作业组名字
ModifyTime String 1628425608429

修改时间
ScenarioId String 6cea9bed-63e6-439e-ae4c-b3333efff53d

场景id
ScriptName String 话术

话术名称
ScriptVersion String 1628425608429

话术版本
Status String Scheduling

状态
Strategy Struct

作业组调度策略
Customized String {}

策略自定义信息
EndTime Long 2209702074000

结束时间
FollowUpStrategy String CONTINUE

执行周期结束后的后续处理方式
IsTemplate Boolean false

是否是模板
MaxAttemptsPerDay Integer 3

拨打失败后的最大重新拨打次数
MinAttemptInterval Integer 10

重新拨打的间隔时间
RepeatBy String Once

重复执行方式，Once 不重复，Day 每天重复，Week 每周重复，Month 每月重复
RepeatDays List [1,2,3,4,5]

重复的执行天
RoutingStrategy String LocalFirst

号码路由策略
StartTime Long 1578550074000

开始时间
StrategyDescription String 催收作业执行策略

策略描述
StrategyId String f718798d-96be-40e4-bef6-317b54855708

策略id
StrategyName String 催收策略

策略名字
Type String Repeatable

策略类型
WorkingTime Array of TimeFrame

策略执行时间段
BeginTime String 09:00:00

时间开始时间
EndTime String 12:00:00

时间结束时间
Message String Success

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

请求id
Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=CreateJobGroup
&<公共请求参数>
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&ScriptId=63cc3b45-feb2-4676-a7d7-f717001fa1e1
&JobGroupName=第一个作业组
&CallingNumbers=["95187"]
&StrategyJson={"maxAttemptsPerDay":2,"name":"策略名字","workingTime":[{"beginTime":"09:00:00","endTime":"12:00:00"},{"beginTime":"13:00:00","endTime":"18:30:00"}],"minAttemptInterval":60}

正常返回示例

XML格式 

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<JobGroup>
    <CallingNumbers>95187</CallingNumbers>
    <JobGroupName>第一个作业组</JobGroupName>
    <ScriptId>63cc3b45-feb2-4676-a7d7-f717001fa1e1</ScriptId>
    <Strategy>
        <MaxAttemptsPerDay>2</MaxAttemptsPerDay>
        <MinAttemptInterval>60</MinAttemptInterval>
        <StrategyName>策略名字</StrategyName>
        <WorkingTime>
            <BeginTime>09:00:00</BeginTime>
            <EndTime>12:00:00</EndTime>
        </WorkingTime>
        <WorkingTime>
            <BeginTime>13:00:00</BeginTime>
            <EndTime>18:30:00</EndTime>
        </WorkingTime>
    </Strategy>
</JobGroup>
<Success>true</Success>

JSON格式 

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "JobGroup": {
        "CallingNumbers": 95187,
        "JobGroupName": "第一个作业组",
        "ScriptId": "63cc3b45-feb2-4676-a7d7-f717001fa1e1",
        "Strategy": {
            "MaxAttemptsPerDay": 2,
            "MinAttemptInterval": 60,
            "StrategyName": "策略名字",
            "WorkingTime": [
                {
                    "BeginTime": "09:00:00",
                    "EndTime": "12:00:00"
                },
                {
                    "BeginTime": "13:00:00",
                    "EndTime": "18:30:00"
                }
            ]
        }
    },
    "Success": true
}

错误码

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

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