ModifyJobGroup
修改智能外呼任務。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ModifyJobGroup | 系統(tǒng)規(guī)定參數(shù)。取值:ModifyJobGroup。 |
InstanceId | String | 是 | 174952ab-9825-4cc9-a5e2-de82d7fa4cdd | 實例ID。 |
JobGroupId | String | 是 | 3edc0260-6f7c-4de4-8535-09372240618b | 任務ID。 |
Name | String | 是 | 修改后的作業(yè)組 | 任務名字。 |
ScenarioId | String | 是 | c6a668d1-3145-4048-9101-cb3678bb8884 | 場景ID。(歷史參數(shù),后續(xù)使用ScriptId) |
Description | String | 否 | 修改后的作業(yè)組 | 任務描述。 |
StrategyJson | String | 否 | {\"maxAttemptsPerDay\":\"0\",\"minAttemptInterval\":\"5\",\"Id\":\"689fc584-7f9f-4dc2-933d-8711beef7b15\"} | 作業(yè)組執(zhí)行策略 name:策略名稱 maxAttemptsPerDay:號碼每天最大呼叫次數(shù) 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 | 任務狀態(tài),取值范圍:
|
RingingDuration | Long | 否 | 25 | 最優(yōu)振鈴時長。 |
MinConcurrency | Long | 否 | 1 | 并發(fā)保障值 任務啟動時,最低保障N個并發(fā); 同一優(yōu)先級的任務并發(fā)保障值加和不能大于實例并發(fā); 若配置并發(fā)保障值為0,則依賴系統(tǒng)內空閑并發(fā)進行智能分配。 |
Priority | String | 否 | Daily | 作業(yè)組優(yōu)先級,取值范圍
|
FlashSmsExtras | String | 否 | {"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"} | 閃信推送的配置參數(shù),JSON格式,包含第三方閃信的配置信息。 templateId:閃信模板ID。 configId:閃信配置ID。 |
RecallCallingNumber.N | String | 否 | ["4008013260"] | 重呼主叫號碼列表 |
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP狀態(tài)碼。 |
Code | String | OK | 接口狀態(tài)碼。 |
Message | String | Success | 接口提示消息。 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 請求ID。 |
Success | Boolean | true | 是否成功。 |
JobGroup | Object | 任務信息。 |
|
Status | String | Scheduling | 狀態(tài)。 |
ScenarioId | String | 6cea9bed-63e6-439e-ae4c-b3333efff53d | 場景ID。 |
JobGroupId | String | c62e6789-28a8-41db-941e-171a01d3b3b9 | 任務ID。 |
CreationTime | Long | 1578550074361 | 創(chuàng)建時間。 |
JobGroupName | String | 第一個催收 | 任務名字。 |
JobFilePath | String | UPLOADED/JOB/d481cebe-0bb6-4d13-9649-42ce5074fb75/6c7d9132-98e1-4f08-8a76-8a266c7532fd_job_template - 副本.xlsx | 任務文件OSS存儲路徑。 |
JobGroupDescription | String | 催收的作業(yè)組 | 任務描述。 |
JobDataParsingTaskId | String | e37d28cb-0413-4816-85ed-fd354d025ea3 | 解析外呼任務文件對應的解析任務ID。 |
ScriptName | String | 話術 | 話術名稱。 |
ScriptVersion | String | 1628425608429 | 話術版本。 |
ModifyTime | String | 1628425608429 | 修改時間。 |
CallingNumbers | Array of String | ["4008013260"] | 主叫號碼列表。 |
ExportProgress | Object | 導出信息(歷史參數(shù),不再使用)。 |
|
Status | String | FINISHED | 狀態(tài) |
FileHttpUrl | String | https://***.oss-cn-shanghai.aliyuncs.com/sample | 文件地址 |
Progress | String | 1 | 進度 |
Strategy | Object | 外呼策略。 |
|
Type | String | Repeatable | 策略類型。 |
StrategyName | String | 催收策略 | 策略名稱。 |
MaxAttemptsPerDay | Integer | 3 | 最大嘗試次數(shù)。 |
FollowUpStrategy | String | CONTINUE | 執(zhí)行周期結束后的處理方式(歷史參數(shù),不再使用)。 |
EndTime | Long | 2209702074000 | 結束時間。 |
Customized | String | {} | 自定義策略數(shù)據(jù)(歷史參數(shù),不再使用)。 |
IsTemplate | Boolean | false | 是否是模板(歷史參數(shù),不再使用)。 |
StartTime | Long | 1578550074000 | 開始時間。 |
StrategyId | String | f718798d-96be-40e4-bef6-317b54855708 | 策略ID。 |
RoutingStrategy | String | LocalFirst | 號碼路由策略。 |
MinAttemptInterval | Integer | 10 | 失敗后重復撥打的間隔時間。 |
StrategyDescription | String | 催收作業(yè)執(zhí)行策略 | 策略描述。 |
RepeatBy | String | Once | 重復執(zhí)行方式,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] | 重復執(zhí)行的天。 |
RecallStrategy | Object | 重呼策略 |
|
EmptyNumberIgnore | Boolean | false | 空號不再外呼。 |
InArrearsIgnore | Boolean | false | 欠費不再外呼。 |
OutOfServiceIgnore | Boolean | false | 停機不再外呼。 |
RingingDuration | Long | 25 | 振鈴時長。 |
Priority | String | Daily | 作業(yè)組優(yōu)先級,取值范圍 Urgent:緊急任務。 Daily:日常任務。 |
MinConcurrency | Long | 1 | 并發(fā)保障值 任務啟動時,最低保障N個并發(fā); 同一優(yōu)先級的任務并發(fā)保障值加和不能大于實例并發(fā); 若配置并發(fā)保障值為0,則依賴系統(tǒng)內空閑并發(fā)進行智能分配。 |
FlashSmsExtras | String | {"configId":"3157b3c8-3a3e-4ea9-894b-9c8a6", "templateId":"1234"} | 閃信推送的配置參數(shù),JSON格式,包含第三方閃信的配置信息。 templateId: 閃信模板ID。 configId: 閃信配置ID。 |
示例
請求示例
http(s)://[Endpoint]/?Action=ModifyJobGroup
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&JobGroupId=3edc0260-6f7c-4de4-8535-09372240618b
&Name=修改后的作業(yè)組
&ScenarioId=c6a668d1-3145-4048-9101-cb3678bb8884
&Description=修改后的作業(yè)組
&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\"]"]
&公共請求參數(shù)
正常返回示例
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>催收的作業(yè)組</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>催收作業(yè)執(zhí)行策略</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" : "催收的作業(yè)組",
"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" : "催收作業(yè)執(zhí)行策略",
"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. | 內部錯誤。建議重試,如果多次重試報錯請?zhí)峤还巍?/td> |
訪問錯誤中心查看更多錯誤碼。