返回一个作业组的数据

调试

您可以在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

创建时间
ExportProgress Struct

导出进展
FileHttpUrl String https://oss-cn-shanghai.aliyuncs.com/xx.zip

文件地址
Progress String 1

导出进展
Status String FINISHED

导出状态
JobDataParsingTaskId String da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx

解析外呼数据任务id
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 催收作业组

作业组名字
MinConcurrency Long 1

最低保障并发
ModifyTime String 1578881227404

修改时间
Priority String Daily

Daily：日常，Urgent：紧急
Progress Struct

作业组的统计信息
Briefs Array of KeyValuePair

业务结果信息
Key String score

业务结果名字
Value String 5

业务结果值
Cancelled Integer 0

作业组中作业取消的数量
Categories Array of KeyValuePair

key value 形式的统计信息
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

总计未接通的作业数量
RecallStrategy Struct

重复策略
EmptyNumberIgnore Boolean true

空号不再外呼
InArrearsIgnore Boolean true

欠费不再外呼
OutOfServiceIgnore Boolean true

停服不再外呼
Result Struct

作业效果状况
ClientHangupNum Integer 1

客户挂机数量
FinishedNum Integer 1

完成数量
NoInteractNum Integer 1

没有交互数量
TimeoutHangupNum Integer 1

超时挂机数量
UnrecognizedNum Integer 1

拒识数量
RingingDuration Long 10

最长振铃音
ScenarioId String fce6c599-8ede-40e3-9f78-0928eda7b4e8

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

话术id
ScriptName String 催收话术

话术名字
ScriptVersion String 49f00b0d-78ac-4d51-91de-a9e8e92b8470

话术版本
Status String Completed

任务组状态
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 of TimeFrame

工作时间段
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格式

<JobGroup>
    <Status>Completed</Status>
    <ModifyTime>1578881227404</ModifyTime>
    <JobDataParsingTaskId>da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx</JobDataParsingTaskId>
    <ScenarioId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</ScenarioId>
    <Priority>Daily</Priority>
    <ScriptVersion>49f00b0d-78ac-4d51-91de-a9e8e92b8470</ScriptVersion>
    <JobGroupName>催收作业组</JobGroupName>
    <ScriptId>49f00b0d-78ac-4d51-91de-a9e8e92b8470</ScriptId>
    <JobGroupDescription>催收作业组</JobGroupDescription>
    <MinConcurrency>1</MinConcurrency>
    <RingingDuration>10</RingingDuration>
    <JobGroupId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</JobGroupId>
    <ScriptName>催收话术</ScriptName>
    <CreationTime>1578881227404</CreationTime>
    <JobFilePath>da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx</JobFilePath>
    <CallingNumbers>["10086"]</CallingNumbers>
    <ExportProgress>
        <Status>FINISHED</Status>
        <Progress>1</Progress>
        <FileHttpUrl>https://oss-cn-shanghai.aliyuncs.com/xx.zip</FileHttpUrl>
    </ExportProgress>
    <Progress>
        <Status>Executing</Status>
        <Failed>0</Failed>
        <StartTime>1578881227404</StartTime>
        <Executing>2</Executing>
        <Scheduling>5</Scheduling>
        <Duration>1000</Duration>
        <Cancelled>0</Cancelled>
        <TotalCompleted>2</TotalCompleted>
        <TotalNotAnswered>1</TotalNotAnswered>
        <Paused>0</Paused>
        <TotalJobs>10</TotalJobs>
        <Categories>
            <Value>10</Value>
            <Key>success</Key>
        </Categories>
        <Briefs>
            <Value>5</Value>
            <Key>score</Key>
        </Briefs>
    </Progress>
    <Strategy>
        <IsTemplate>false</IsTemplate>
        <Type>Repeatable</Type>
        <RepeatBy>Once</RepeatBy>
        <MinAttemptInterval>10</MinAttemptInterval>
        <EndTime>1579881227404</EndTime>
        <StrategyName>催收策略名字</StrategyName>
        <StrategyDescription>催收策略</StrategyDescription>
        <Customized>{}</Customized>
        <RoutingStrategy>LocalFirst</RoutingStrategy>
        <StrategyId>a2bff22c-2604-4df2-83d6-5952e2438c5a</StrategyId>
        <StartTime>1578881227404</StartTime>
        <MaxAttemptsPerDay>2</MaxAttemptsPerDay>
        <FollowUpStrategy>NONE</FollowUpStrategy>
        <WorkingTime>
            <EndTime>12:00:00</EndTime>
            <BeginTime>09:00:00</BeginTime>
        </WorkingTime>
        <RepeatDays>[1,2,3,4,5]</RepeatDays>
    </Strategy>
    <RecallStrategy>
        <OutOfServiceIgnore>true</OutOfServiceIgnore>
        <EmptyNumberIgnore>true</EmptyNumberIgnore>
        <InArrearsIgnore>true</InArrearsIgnore>
    </RecallStrategy>
    <Result>
        <UnrecognizedNum>1</UnrecognizedNum>
        <NoInteractNum>1</NoInteractNum>
        <FinishedNum>1</FinishedNum>
        <ClientHangupNum>1</ClientHangupNum>
        <TimeoutHangupNum>1</TimeoutHangupNum>
    </Result>
</JobGroup>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Message>Success</Message>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>

JSON格式

{"JobGroup":{"Status":"Completed","ModifyTime":"1578881227404","JobDataParsingTaskId":"da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx","ScenarioId":"fce6c599-8ede-40e3-9f78-0928eda7b4e8","Priority":"Daily","ScriptVersion":"49f00b0d-78ac-4d51-91de-a9e8e92b8470","JobGroupName":"催收作业组","ScriptId":"49f00b0d-78ac-4d51-91de-a9e8e92b8470","JobGroupDescription":"催收作业组","MinConcurrency":"1","RingingDuration":"10","JobGroupId":"fce6c599-8ede-40e3-9f78-0928eda7b4e8","ScriptName":"催收话术","CreationTime":"1578881227404","JobFilePath":"da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx","CallingNumbers":"[\"10086\"]","ExportProgress":{"Status":"FINISHED","Progress":"1","FileHttpUrl":"https://oss-cn-shanghai.aliyuncs.com/xx.zip"},"Progress":{"Status":"Executing","Failed":"0","StartTime":"1578881227404","Executing":"2","Scheduling":"5","Duration":"1000","Cancelled":"0","TotalCompleted":"2","TotalNotAnswered":"1","Paused":"0","TotalJobs":"10","Categories":[{"Value":"10","Key":"success"}],"Briefs":[{"Value":"5","Key":"score"}]},"Strategy":{"IsTemplate":"false","Type":"Repeatable","RepeatBy":"Once","MinAttemptInterval":"10","EndTime":"1579881227404","StrategyName":"催收策略名字","StrategyDescription":"催收策略","Customized":"{}","RoutingStrategy":"LocalFirst","StrategyId":"a2bff22c-2604-4df2-83d6-5952e2438c5a","StartTime":"1578881227404","MaxAttemptsPerDay":"2","FollowUpStrategy":"NONE","WorkingTime":[{"EndTime":"12:00:00","BeginTime":"09:00:00"}],"RepeatDays":"[1,2,3,4,5]"},"RecallStrategy":{"OutOfServiceIgnore":"true","EmptyNumberIgnore":"true","InArrearsIgnore":"true"},"Result":{"UnrecognizedNum":"1","NoInteractNum":"1","FinishedNum":"1","ClientHangupNum":"1","TimeoutHangupNum":"1"}},"RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC","Message":"Success","HttpStatusCode":"200","Code":"OK","Success":"true"}

错误码

HttpCode 错误码 错误信息 描述
404 NotExist.Instance The specified Instance does not exist. 指定的实例不存在。
404 NotExist.JobGroup The specified JobGroup does not exist. 指定的任务组不存在。
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试，如果多次重试报错请提交工单。

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