返回一个作业组的数据

调试

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

请求参数

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

系统规定参数。取值:DescribeJobGroup。

InstanceId String af81a389-91f0-4157-8d82-720edd02b66a

实例id

JobGroupId String 46a9ad0c-3e11-44da-a9a7-2c21bf5ce185

作业组id

BriefTypes.N RepeatList 回访成功

过滤条件,业务结果

返回数据

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

接口状态码

HttpStatusCode Integer 200

http 状态码

JobGroup Struct

返回的作业组信息

CallingNumbers List ["10086"]

主叫号码列表

CreationTime Long 1578881227404

创建时间

JobFilePath String da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx

作业文件上传后的文件key

JobGroupDescription String 催收作业组

作业组描述

JobGroupId String fce6c599-8ede-40e3-9f78-0928eda7b4e8

作业组id

JobGroupName String 催收作业组

作业组名字

Progress Struct

作业组的统计信息

Briefs Array

业务结果信息

Key String score

业务结果名字

Value String 5

业务结果值

Cancelled Integer 0

作业组中作业取消的数量

Categories Array

key vaule 形式的统计信息

Key String success

自定义的统计信息字段名字

Value String 10

自定义的统计信息值

Duration Integer 1000

作业组执行执行时间

Executing Integer 2

执行中的作业数量

Failed Integer 0

失败的作业数量

Paused Integer 0

暂停的作业数量

Scheduling Integer 5

调度中 作业数量

StartTime Long 1578881227404

开始执行的时间

Status String Executing

作业组状态

TotalCompleted Integer 2

总计完成的数量

TotalJobs Integer 10

总计的作业数量

TotalNotAnswered Integer 1

总计未接通的作业数量

ScenarioId String fce6c599-8ede-40e3-9f78-0928eda7b4e8

场景id

ScriptId String 49f00b0d-78ac-4d51-91de-a9e8e92b8470

话术id

ScriptName String 催收话术

话术名字

Strategy Struct

作业的执行策略

Customized String {}

策略自定义数据

EndTime Long 1579881227404

调度策略总的结束时间

FollowUpStrategy String NONE

执行周期结束后的处理方式

IsTemplate Boolean false

是否是模板

MaxAttemptsPerDay Integer 2

失败一天内最大重新拨打次数

MinAttemptInterval Integer 10

重新拨打间隔时间

RepeatBy String Once

作业重复方式

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

重复执行的天

RoutingStrategy String LocalFirst

号码路由策略

StartTime Long 1578881227404

策略总的开始时间

StrategyDescription String 催收策略

策略描述

StrategyId String a2bff22c-2604-4df2-83d6-5952e2438c5a

策略id

StrategyName String 催收策略名字

策略名字

Type String Repeatable

策略类型

WorkingTime Array

工作时间段

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=DescribeJobGroup
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&JobGroupId=46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<JobGroup>
    <Status>Completed</Status>
    <Progress>
        <Status>3</Status>
        <Categories>
            <Value>0</Value>
            <Key>Executing</Key>
        </Categories>
        <Categories>
            <Value>0</Value>
            <Key>Succeeded</Key>
        </Categories>
        <TotalCompleted>0</TotalCompleted>
        <TotalJobs>0</TotalJobs>
    </Progress>
    <ScenarioId>01f7774a-2074-44a3-97cb-195a3f94a288</ScenarioId>
    <ScriptName>已删除话术</ScriptName>
    <CreationTime>1539657116000</CreationTime>
    <JobFilePath>af81a389-91f0-4157-8d82-720edd02b66a/c94a7013-d73e-4c3b-8bf8-d5691c57c2e4_广发外呼模板.xlsx</JobFilePath>
    <Strategy>
        <IsTemplate>false</IsTemplate>
        <StrategyType>Repeatable</StrategyType>
        <MinAttemptInterval>10</MinAttemptInterval>
        <DerivativeStartTime>1578882420000</DerivativeStartTime>
        <MaxAttemptsPerDay>3</MaxAttemptsPerDay>
        <RoutingStrategy>LocalFirst</RoutingStrategy>
        <StrategyId>8fed1c42-4c92-4357-ad46-e98558b06d38</StrategyId>
        <FollowUpStrategy>NONE</FollowUpStrategy>
        <StrategyName>dc74f975-8bcc-48b4-a841-0ff7fa93ee56</StrategyName>
    </Strategy>
    <JobGroupId>247d1da4-fcc4-41af-8b1d-7fe9b65c170d</JobGroupId>
    <CallingNumbers>057126883106</CallingNumbers>
    <JobGroupName>test</JobGroupName>
</JobGroup>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>

JSON 格式

{
    "RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
   "JobGroup":{
		"Status":"Completed",
		"Progress":{
			"Status":"3",
			"Categories":[
				{
					"Value":"0",
					"Key":"Executing"
				},
				{
					"Value":"0",
					"Key":"Succeeded"
				}
			],
			"TotalCompleted":0,
			"TotalJobs":0
		},
		"ScenarioId":"01f7774a-2074-44a3-97cb-195a3f94a288",
		"ScriptName":"已删除话术",
		"CreationTime":1539657116000,
		"JobFilePath":"af81a389-91f0-4157-8d82-720edd02b66a/c94a7013-d73e-4c3b-8bf8-d5691c57c2e4_广发外呼模板.xlsx",
		"Strategy":{
			"IsTemplate":false,
			"StrategyType":"Repeatable",
			"MinAttemptInterval":10,
			"DerivativeStartTime":1578882420000,
			"MaxAttemptsPerDay":3,
			"RoutingStrategy":"LocalFirst",
			"StrategyId":"8fed1c42-4c92-4357-ad46-e98558b06d38",
			"FollowUpStrategy":"NONE",
			"StrategyName":"dc74f975-8bcc-48b4-a841-0ff7fa93ee56"
		},
		"JobGroupId":"247d1da4-fcc4-41af-8b1d-7fe9b65c170d",
		"CallingNumbers":[
			"057126883106"
		],
		"JobGroupName":"test"
	},
    "HttpStatusCode":200,
    "Code":"OK",
    "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.JobGroup The specified JobGroup does not exist. 指定的任务组不存在。

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