ModifyJobGroup

修改智能外呼任务。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ModifyJobGroup

系统规定参数。取值:ModifyJobGroup

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

实例ID。

JobGroupId String 3edc0260-6f7c-4de4-8535-09372240618b

任务ID。

Name String 修改后的作业组

任务名字。

ScenarioId String c6a668d1-3145-4048-9101-cb3678bb8884

场景ID。(历史参数,后续使用ScriptId)

Description String 修改后的作业组

任务描述。

StrategyJson String {\"maxAttemptsPerDay\":\"0\",\"minAttemptInterval\":\"5\",\"Id\":\"689fc584-7f9f-4dc2-933d-8711beef7b15\"}

作业组执行策略

name:策略名称

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

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

startTime:开始时间戳

endTime:结束时间戳

workingTime:可呼出的时间窗口,24小时制

id:策略ID,对于该接口为必填

RecallStrategyJson String {\"emptyNumberIgnore\":false,\"inArrearsIgnore\":false,\"outOfServiceIgnore\":false}

重拨策略JSON

ScriptId String 5a3940ce-a12f-4222-9f0f-605a9b89ea7c

场景话术ID。

CallingNumber.N String ["4008013260"]

主叫号码。

JobGroupStatus String Draft

任务状态,取值范围:

  • Draft:草稿。
  • Scheduling:调度中。
  • Executing:执行中。
  • Completed:已完成。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Initializing:初始化。
RingingDuration Long 25

最优振铃时长。

MinConcurrency Long 1

并发保障值

任务启动时,最低保障N个并发;

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

若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。

Priority String Daily

作业组优先级,取值范围

  • Urgent:紧急任务。
  • Daily:日常任务。
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/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx

任务文件OSS存储路径。

JobGroupDescription String 催收的作业组

任务描述。

JobDataParsingTaskId String e37d28cb-0413-4816-85ed-fd354d025ea3

解析外呼任务文件对应的解析任务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 f718798d-96be-40e4-bef6-317b54855708

策略ID。

RoutingStrategy String LocalFirst

号码路由策略。

MinAttemptInterval Integer 10

失败后重复拨打的间隔时间。

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 false

空号不再外呼。

InArrearsIgnore Boolean false

欠费不再外呼。

OutOfServiceIgnore Boolean false

停机不再外呼。

RingingDuration Long 25

振铃时长。

Priority String Daily

作业组优先级,取值范围

Urgent:紧急任务。

Daily:日常任务。

MinConcurrency Long 1

并发保障值

任务启动时,最低保障N个并发;

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

若配置并发保障值为0,则依赖系统内空闲并发进行智能分配。

FlashSmsExtras String {"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"}

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

templateId: 闪信模板ID。

configId: 闪信配置ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyJobGroup
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&JobGroupId=3edc0260-6f7c-4de4-8535-09372240618b
&Name=修改后的作业组
&ScenarioId=c6a668d1-3145-4048-9101-cb3678bb8884
&Description=修改后的作业组
&StrategyJson={\"maxAttemptsPerDay\":\"0\",\"minAttemptInterval\":\"5\",\"Id\":\"689fc584-7f9f-4dc2-933d-8711beef7b15\"}
&RecallStrategyJson={\"emptyNumberIgnore\":false,\"inArrearsIgnore\":false,\"outOfServiceIgnore\":false}
&ScriptId=5a3940ce-a12f-4222-9f0f-605a9b89ea7c
&CallingNumber=["[\"4008013260\"]"]
&JobGroupStatus=Draft
&RingingDuration=25
&MinConcurrency=1
&Priority=Daily
&FlashSmsExtras={"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"}

&RecallCallingNumber=["[\"4008013260\"]"]
&公共请求参数

正常返回示例

XML格式

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

<ModifyJobGroupResponse>
    <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/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx</JobFilePath>
        <JobGroupDescription>催收的作业组</JobGroupDescription>
        <JobDataParsingTaskId>e37d28cb-0413-4816-85ed-fd354d025ea3</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>f718798d-96be-40e4-bef6-317b54855708</StrategyId>
            <RoutingStrategy>LocalFirst</RoutingStrategy>
            <MinAttemptInterval>10</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>false</EmptyNumberIgnore>
            <InArrearsIgnore>false</InArrearsIgnore>
            <OutOfServiceIgnore>false</OutOfServiceIgnore>
        </RecallStrategy>
        <RingingDuration>25</RingingDuration>
        <Priority>Daily</Priority>
        <MinConcurrency>1</MinConcurrency>
        <FlashSmsExtras>{"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"}</FlashSmsExtras>
    </JobGroup>
</ModifyJobGroupResponse>

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/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx",
    "JobGroupDescription" : "催收的作业组",
    "JobDataParsingTaskId" : "e37d28cb-0413-4816-85ed-fd354d025ea3",
    "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" : "f718798d-96be-40e4-bef6-317b54855708",
      "RoutingStrategy" : "LocalFirst",
      "MinAttemptInterval" : 10,
      "StrategyDescription" : "催收作业执行策略",
      "RepeatBy" : "Once",
      "WorkingTime" : [ {
        "EndTime" : "12:00:00",
        "BeginTime" : "09:00:00"
      } ],
      "RepeatDays" : [ "[1,2,3,4,5]" ]
    },
    "RecallStrategy" : {
      "EmptyNumberIgnore" : false,
      "InArrearsIgnore" : false,
      "OutOfServiceIgnore" : false
    },
    "RingingDuration" : 25,
    "Priority" : "Daily",
    "MinConcurrency" : 1,
    "FlashSmsExtras" : "{\"configId\":\"3157b3c8-3a3e-4ea9-894b-9c8a6\", \"templateId\":\"1234\"}"
  }
}

错误码

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

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