调用DescribeJobGroup返回作业组的数据_智能外呼机器人(Outbound Bot)-阿里云帮助中心

调试

您可以在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	String	否	回访成功	过滤条件，业务结果。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
Code	String	OK	接口状态码。
Message	String	Success	接口提示信息。
RequestId	String	254EB995-DEDF-48A4-9101-9CA5B72FFBCC	请求ID。
Success	Boolean	true	是否成功。
JobGroup	Object		任务信息。
CreationTime	Long	1578881227404	创建时间。
Status	String	Completed	任务状态。
JobGroupName	String	催收作业组	任务名称。
ScriptId	String	49f00b0d-78ac-4d51-91de-a9e8e92b8470	话术场景ID。
JobGroupId	String	46a9ad0c-3e11-44da-a9a7-2c21bf5ce185	任务ID。
ScenarioId	String	fce6c599-8ede-40e3-9f78-0928eda7b4e8	场景ID（旧画布参数，新画布场景同ScriptId）。
JobFilePath	String	da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx	任务名单上传后的OSS Filekey
JobGroupDescription	String	催收作业组	任务描述。
JobDataParsingTaskId	String	da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx	任务名单解析操作ID。
ScriptName	String	催收话术	话术场景名称。
ModifyTime	String	1578881227404	修改时间。
ScriptVersion	String	49f00b0d-78ac-4d51-91de-a9e8e92b8470	话术场景版本号。
CallingNumbers	Array of String	["1****6"]	主叫号码列表。
ExportProgress	Object		导出进度
Status	String	FINISHED	导出状态
FileHttpUrl	String	https://oss-cn-shanghai.aliyuncs.com/xx.zip	文件地址
Progress	String	1	导出进度
Progress	Object		任务进展情况。
TotalNotAnswered	Integer	1	到当前时间为止未接通作业数量。
Status	String	Executing	任务整体执行状况。
StartTime	Long	1578881227404	开始执行的时间。
Failed	Integer	0	失败的作业数量。
Executing	Integer	2	执行中的作业数量。
TotalJobs	Integer	10	总作业数量
TotalCompleted	Integer	2	总计完成的作业数量
Duration	Integer	1000	任务执行时间。
Scheduling	Integer	5	调度中的作业数量
Paused	Integer	0	暂停的作业数量
Cancelled	Integer	0	取消的作业数量
Briefs	Array of KeyValuePair		业务结果信息
Key	String	score	业务结果名字
Value	String	5	业务结果值
Categories	Array of KeyValuePair		key vaule 形式的统计信息
Key	String	success	自定义的统计信息字段名字
Value	String	10	自定义的统计信息值
Strategy	Object		作业的执行策略
Type	String	Repeatable	策略类型
StrategyName	String	催收策略名字	策略名字
MaxAttemptsPerDay	Integer	2	未接通情况下每日最大呼叫次数
FollowUpStrategy	String	NONE	执行周期结束后的处理方式（历史参数，已不再使用）。
EndTime	Long	1579881227404	调度策略的总结束时间
Customized	String	{}	策略的自定义数据（历史参数，已不再使用）。
IsTemplate	Boolean	false	是否是模版
StartTime	Long	1578881227404	策略总的开始时间
StrategyId	String	a2bff22c-2604-4df2-83d6-5952e2438c5a	策略ID
RoutingStrategy	String	LocalFirst	号码路由策略
MinAttemptInterval	Integer	10	重新拨打的间隔时间
StrategyDescription	String	催收策略	策略描述
RepeatBy	String	Once	作业重复方式
WorkingTime	Array of TimeFrame		工作时间段
EndTime	String	12:00:00	开始时间
BeginTime	String	09:00:00	结束时间
RepeatDays	Array of String	[1,2,3,4,5]	重复执行的天
Repeatable	Boolean	false	是否为循环任务
RecallStrategy	Object		重呼策略
EmptyNumberIgnore	Boolean	false	空号不再外呼
InArrearsIgnore	Boolean	false	欠费不再外呼
OutOfServiceIgnore	Boolean	false	停机不再外呼
Result	Object		统计信息（历史参数，已不再提供）
TimeoutHangupNum	Integer	1	超时挂机数量
FinishedNum	Integer	1	完成数量
NoInteractNum	Integer	1	没有交互数量
ClientHangupNum	Integer	1	客户挂机数量
UnrecognizedNum	Integer	1	拒识数量
RingingDuration	Long	30	振铃时长
Priority	String	1	优先级
MinConcurrency	Long	1	最小并发
FlashSmsExtras	Object		闪信推送的配置参数，JSON格式，包含第三方闪信的配置信息。
ConfigId	String	bebe23e6e2604f50bbeb12900c07703d	闪信配置ID。
TemplateId	String	e080d737-5c0b-4350-b7d4-1162530579e7	闪信模板ID。
RecallCallingNumbers	Array of String	["1****6"]	重呼主叫号码列表

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeJobGroup
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&JobGroupId=46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
&BriefTypes=["回访成功"]
&公共请求参数

正常返回示例

XML格式

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

<DescribeJobGroupResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Code>OK</Code>
    <Message>Success</Message>
    <RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
    <Success>true</Success>
    <JobGroup>
        <CreationTime>1578881227404</CreationTime>
        <Status>Completed</Status>
        <JobGroupName>催收作业组</JobGroupName>
        <ScriptId>49f00b0d-78ac-4d51-91de-a9e8e92b8470</ScriptId>
        <JobGroupId>46a9ad0c-3e11-44da-a9a7-2c21bf5ce185</JobGroupId>
        <ScenarioId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</ScenarioId>
        <JobFilePath>da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx</JobFilePath>
        <JobGroupDescription>催收作业组</JobGroupDescription>
        <JobDataParsingTaskId>da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx</JobDataParsingTaskId>
        <ScriptName>催收话术</ScriptName>
        <ModifyTime>1578881227404</ModifyTime>
        <ScriptVersion>49f00b0d-78ac-4d51-91de-a9e8e92b8470</ScriptVersion>
        <CallingNumbers>["1****6"]</CallingNumbers>
        <ExportProgress>
            <Status>FINISHED</Status>
            <FileHttpUrl>https://oss-cn-shanghai.aliyuncs.com/xx.zip</FileHttpUrl>
            <Progress>1</Progress>
        </ExportProgress>
        <Progress>
            <TotalNotAnswered>1</TotalNotAnswered>
            <Status>Executing</Status>
            <StartTime>1578881227404</StartTime>
            <Failed>0</Failed>
            <Executing>2</Executing>
            <TotalJobs>10</TotalJobs>
            <TotalCompleted>2</TotalCompleted>
            <Duration>1000</Duration>
            <Scheduling>5</Scheduling>
            <Paused>0</Paused>
            <Cancelled>0</Cancelled>
            <Briefs>
                <Key>score</Key>
                <Value>5</Value>
            </Briefs>
            <Categories>
                <Key>success</Key>
                <Value>10</Value>
            </Categories>
        </Progress>
        <Strategy>
            <Type>Repeatable</Type>
            <StrategyName>催收策略名字</StrategyName>
            <MaxAttemptsPerDay>2</MaxAttemptsPerDay>
            <FollowUpStrategy>NONE</FollowUpStrategy>
            <EndTime>1579881227404</EndTime>
            <Customized>{}</Customized>
            <IsTemplate>false</IsTemplate>
            <StartTime>1578881227404</StartTime>
            <StrategyId>a2bff22c-2604-4df2-83d6-5952e2438c5a</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>
        <Result>
            <TimeoutHangupNum>1</TimeoutHangupNum>
            <FinishedNum>1</FinishedNum>
            <NoInteractNum>1</NoInteractNum>
            <ClientHangupNum>1</ClientHangupNum>
            <UnrecognizedNum>1</UnrecognizedNum>
        </Result>
        <RingingDuration>30</RingingDuration>
        <Priority>1</Priority>
        <MinConcurrency>1</MinConcurrency>
        <FlashSmsExtras>
            <ConfigId>bebe23e6e2604f50bbeb12900c07703d</ConfigId>
            <TemplateId>e080d737-5c0b-4350-b7d4-1162530579e7</TemplateId>
        </FlashSmsExtras>
        <RecallCallingNumbers>["1****6"]</RecallCallingNumbers>
    </JobGroup>
</DescribeJobGroupResponse>

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" : {
    "CreationTime" : 1578881227404,
    "Status" : "Completed",
    "JobGroupName" : "催收作业组",
    "ScriptId" : "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "JobGroupId" : "46a9ad0c-3e11-44da-a9a7-2c21bf5ce185",
    "ScenarioId" : "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
    "JobFilePath" : "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "JobGroupDescription" : "催收作业组",
    "JobDataParsingTaskId" : "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "ScriptName" : "催收话术",
    "ModifyTime" : "1578881227404",
    "ScriptVersion" : "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "CallingNumbers" : [ "[\"1****6\"]" ],
    "ExportProgress" : {
      "Status" : "FINISHED",
      "FileHttpUrl" : "https://oss-cn-shanghai.aliyuncs.com/xx.zip",
      "Progress" : "1"
    },
    "Progress" : {
      "TotalNotAnswered" : 1,
      "Status" : "Executing",
      "StartTime" : 1578881227404,
      "Failed" : 0,
      "Executing" : 2,
      "TotalJobs" : 10,
      "TotalCompleted" : 2,
      "Duration" : 1000,
      "Scheduling" : 5,
      "Paused" : 0,
      "Cancelled" : 0,
      "Briefs" : [ {
        "Key" : "score",
        "Value" : "5"
      } ],
      "Categories" : [ {
        "Key" : "success",
        "Value" : "10"
      } ]
    },
    "Strategy" : {
      "Type" : "Repeatable",
      "StrategyName" : "催收策略名字",
      "MaxAttemptsPerDay" : 2,
      "FollowUpStrategy" : "NONE",
      "EndTime" : 1579881227404,
      "Customized" : "{}",
      "IsTemplate" : false,
      "StartTime" : 1578881227404,
      "StrategyId" : "a2bff22c-2604-4df2-83d6-5952e2438c5a",
      "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
    },
    "Result" : {
      "TimeoutHangupNum" : 1,
      "FinishedNum" : 1,
      "NoInteractNum" : 1,
      "ClientHangupNum" : 1,
      "UnrecognizedNum" : 1
    },
    "RingingDuration" : 30,
    "Priority" : "1",
    "MinConcurrency" : 1,
    "FlashSmsExtras" : {
      "ConfigId" : "bebe23e6e2604f50bbeb12900c07703d",
      "TemplateId" : "e080d737-5c0b-4350-b7d4-1162530579e7"
    },
    "RecallCallingNumbers" : [ "[\"1****6\"]" ]
  }
}

错误码

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

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