批量创建外呼作业

调试

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

请求参数

名称 类型 是否必选 示例值 描述
BatchJobName String 第一个催收作业组

批量作业名字

InstanceId String 174952ab-9825-4cc9-a5e2-de82d7fa4cdd

实例id

Submitted Boolean false

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

BatchJobDescription String 描述

批量作业名字

ScenarioId String c6a668d1-3145-4048-9101-cb3678bb8884

场景id

ScriptId String b9ff4e88-65f9-4eb3-987c-11ba51f3f24d

话术id

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

作业执行策略json

CallingNumber.N RepeatList ["95187"]

主叫号码

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

下载批量作业excel的地址

返回数据

名称 类型 示例值 描述
RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

一下请求的id

Success Boolean true

是否成功

Code String OK

错误码

Message String Success

提示信息

HttpStatusCode Integer 200

http 错误码

BatchJob Struct

作业组信息

BatchJobId String 5a7e8b09-baf9-4cab-b540-c971f47a7146

作业组id

JobGroupName String 批量作业01

作业组名字

JobGroupDescription String 第一个批量作业

作业组描述

ScenarioId String 6cea9bed-63e6-439e-ae4c-b3333efff53d

作业组场景id

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

上传的excel 文件key

CreationTime Long 1579068424000

作业组创建时间

CallingNumbers List ["95187"]

主叫号码列表

Strategy Struct

作业执行策略

StrategyId String f718798d-96be-40e4-bef6-317b54855708

策略id

StrategyName String 催收策略

策略名字

StrategyDescription String 催收作业执行策略

策略描述

Type String Repeatable
StartTime Long 1578550074000

作业组开始执行时间

EndTime Long 2209702074000

调度策略总的结束时间

RepeatBy String Once

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

MaxAttemptsPerDay Integer 3

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

MinAttemptInterval Integer 10

重新拨打间隔时间

Customized String {}

策略自定义信息

RoutingStrategy String LocalFirst

主叫号码录音策略

FollowUpStrategy String CONTINUE

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

IsTemplate Boolean false

是否是模板

WorkingTime Array

作业一天中的执行时间段

BeginTime String 09:00:00

开始时间

EndTime String 12:00:00

结束时间

RepeatDays List [1,2,3,4,5]

重复执行天

示例

请求示例

http(s)://[Endpoint]/?Action=CreateBatchJobs
&BatchJobName=第一个催收作业组
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&Submitted=false
&<公共请求参数>

正常返回示例

XML 格式

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<BatchJob>
    <CallingNumbers>95187</CallingNumbers>
    <BatchJobName>第一个催收作业组</BatchJobName>
    <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>
</BatchJob>
<Success>true</Success>

JSON 格式

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "BatchJob": {
        "CallingNumbers": ["95187"],
        "BatchJobName": "第一个催收作业组",
        "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. 指定的实例不存在。
404 NotExist.Script The specified Script does not exist. 指定的话术不存在。

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