創建作業組。
調試
您可以在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"} | 任務執行策略。
|
RecallStrategyJson | String | 否 | {"emptyNumberIgnore":true,"inArrearsIgnore":true,"outOfServiceIgnore":true} | 重撥策略,JSON格式。
|
CallingNumber.N | String | 否 | 4008013260 | 主叫號碼。 |
RingingDuration | Long | 否 | 25 | 最優振鈴時長。 |
Priority | String | 否 | Daily | 作業組優先級,取值范圍如下
|
MinConcurrency | Long | 否 | 1 | 并發保障值。
|
FlashSmsExtras | String | 否 | {"templateId":"10471","configId":"8037f524-6ff2-4dbe-bb28-f59234ea7a64"} | 閃信推送的配置參數,JSON格式,包含第三方閃信的配置信息。
|
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 | 號碼策略。
|
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 | 作業組優先級,取值范圍
|
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. | 內部錯誤。建議重試,如果多次重試報錯請提交工單。 |
訪問錯誤中心查看更多錯誤碼。