调用ListJobGroups查询外呼作业组列表_智能外呼机器人(Outbound Bot)-阿里云帮助中心

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListJobGroups	系统规定参数。取值：ListJobGroups。
InstanceId	String	是	174952ab-9825-4cc9-a5e2-de82d7fa4cdd	业务ID。
StartTime	Long	否	1578965079000	任务开始时间。
EndTime	Long	否	1579965079000	任务结束时间
PageNumber	Integer	是	1	页号
PageSize	Integer	是	10	每页记录数。
AsyncQuery	Boolean	否	true	是否异步获取查询结果
SearchText	String	否	面试	搜索关键字
JobGroupStatusFilter	String	否	Draft,Scheduling	过滤条件：按照任务状态过滤，可以同时选择多个状态过滤，各个状态之间用逗号分隔，逻辑或关系。取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。
OnlyMinConcurrencyEnabled	Boolean	否	false	查看并发保障值有效任务

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
RequestId	String	254EB995-DEDF-48A4-9101-9CA5B72FFBCC	请求ID。
Success	Boolean	true	是否调用成功。true：调用成功。 false：调用失败。
Code	String	OK	响应码。
Message	String	Success	错误信息。
AsyncTaskId	String	2bb0cf15-2126-4c9b-bc30-bb5301b96284	异步查询ID，若为异步查询，可以根据此ID获取查询结果。
JobGroups	Object		任务列表。
PageNumber	Integer	1	分页页码。
PageSize	Integer	10	分页数据数量。
TotalCount	Integer	100	记录总数
List	Array of JobGroup		数组
Status	String	Draft	执行状态，取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。
JobGroupId	String	c62e6789-28a8-41db-941e-171a01d3b3b9	任务ID。
CreationTime	Long	1578550074361	创建时间。
JobGroupName	String	催收作业组	任务名字。
TotalCallNum	Integer	10	总呼叫次数。
ScriptId	String	c62e6789-28a8-41db-941e-171a01d3b3b9	话术ID。
JobGroupDescription	String	催收的作业组	任务描述。
JobDataParsingTaskId	String	c62e6789-28a8-41db-941e-171a01d3b3b9	jobFile解析任务的ID。
ScriptName	String	话术名称	话术名称。
ScriptVersion	String	d9e828ac-744b-4dd3-848a-17a3da9167b8	话术版本。
ModifyTime	String	1578550074361	修改时间，单位毫秒。
Progress	Object		任务统计信息。
TotalNotAnswered	Integer	1	作业未接通数量。
Status	String	Scheduling	执行状态，取值范围： Draft：草稿。 Scheduling：调度中。 Executing：执行中。 Completed：已完成。 Paused：挂起。 Failed：失败。 Cancelled：已取消。 Initializing：初始化。
StartTime	Long	1578550074361	开始时间。
FailedNum	Integer	5	已作废
PausedNum	Integer	5	已作废
CancelledNum	Integer	5	已作废
TotalJobs	Integer	20	作业总数。
TotalCompleted	Integer	3	到当前时间为止作业完成数量。
Duration	Integer	1578550074361	到目前为止执行总时长。
ExecutingNum	Integer	10	已作废
Scheduling	Integer	10	调度中的作业数量。
ExportProgress	Object		导出进度。
Status	String	PENDING	导出任务状态，取值范围： PENDING：等待中。 IN_PROGRESS：处理中。 FINISHED：完成。 FAILED：失败。
FileHttpUrl	String	http://www.xxx.com/xxx	下载地址。
Progress	String	50	进度。
Strategy	Object		策略。
EndTime	Long	2209702074000	策略结束时间。
StartTime	Long	1578550074000	策略开始时间。
MinConcurrency	Integer	1	并发保障值有效任务数

示例

请求示例

http(s)://[Endpoint]/?Action=ListJobGroups
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&StartTime=1578965079000
&EndTime=1579965079000
&PageNumber=1
&PageSize=10
&AsyncQuery=true
&SearchText=面试
&JobGroupStatusFilter=Draft,Scheduling
&公共请求参数

正常返回示例

XML格式

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

<ListJobGroupsResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
    <Success>true</Success>
    <Code>OK</Code>
    <Message>Success</Message>
    <AsyncTaskId>2bb0cf15-2126-4c9b-bc30-bb5301b96284</AsyncTaskId>
    <JobGroups>
        <PageNumber>1</PageNumber>
        <PageSize>10</PageSize>
        <TotalCount>100</TotalCount>
        <List>
            <Status>Draft</Status>
            <JobGroupId>c62e6789-28a8-41db-941e-171a01d3b3b9</JobGroupId>
            <CreationTime>1578550074361</CreationTime>
            <JobGroupName>催收作业组</JobGroupName>
            <TotalCallNum>10</TotalCallNum>
            <ScriptId>c62e6789-28a8-41db-941e-171a01d3b3b9</ScriptId>
            <JobGroupDescription>催收的作业组</JobGroupDescription>
            <JobDataParsingTaskId>c62e6789-28a8-41db-941e-171a01d3b3b9</JobDataParsingTaskId>
            <ScriptName>话术名称</ScriptName>
            <ScriptVersion>d9e828ac-744b-4dd3-848a-17a3da9167b8</ScriptVersion>
            <ModifyTime>1578550074361</ModifyTime>
            <Progress>
                <TotalNotAnswered>1</TotalNotAnswered>
                <Status>Scheduling</Status>
                <StartTime>1578550074361</StartTime>
                <FailedNum>5</FailedNum>
                <PausedNum>5</PausedNum>
                <CancelledNum>5</CancelledNum>
                <TotalJobs>20</TotalJobs>
                <TotalCompleted>3</TotalCompleted>
                <ExecutingNum>10</ExecutingNum>
                <Scheduling>10</Scheduling>
            </Progress>
            <ExportProgress>
                <Status>PENDING</Status>
                <FileHttpUrl>http://www.xxx.com/xxx</FileHttpUrl>
                <Progress>50</Progress>
            </ExportProgress>
            <Strategy>
                <EndTime>2209702074000</EndTime>
                <StartTime>1578550074000</StartTime>
            </Strategy>
        </List>
    </JobGroups>
</ListJobGroupsResponse>

JSON格式

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

{
  "HttpStatusCode" : 200,
  "RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success" : true,
  "Code" : "OK",
  "Message" : "Success",
  "AsyncTaskId" : "2bb0cf15-2126-4c9b-bc30-bb5301b96284",
  "JobGroups" : {
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 100,
    "List" : [ {
      "Status" : "Draft",
      "JobGroupId" : "c62e6789-28a8-41db-941e-171a01d3b3b9",
      "CreationTime" : 1578550074361,
      "JobGroupName" : "催收作业组",
      "TotalCallNum" : 10,
      "ScriptId" : "c62e6789-28a8-41db-941e-171a01d3b3b9",
      "JobGroupDescription" : "催收的作业组",
      "JobDataParsingTaskId" : "c62e6789-28a8-41db-941e-171a01d3b3b9",
      "ScriptName" : "话术名称",
      "ScriptVersion" : "d9e828ac-744b-4dd3-848a-17a3da9167b8",
      "ModifyTime" : "1578550074361",
      "Progress" : {
        "TotalNotAnswered" : 1,
        "Status" : "Scheduling",
        "StartTime" : 1578550074361,
        "FailedNum" : 5,
        "PausedNum" : 5,
        "CancelledNum" : 5,
        "TotalJobs" : 20,
        "TotalCompleted" : 3,
        "ExecutingNum" : 10,
        "Scheduling" : 10
      },
      "ExportProgress" : {
        "Status" : "PENDING",
        "FileHttpUrl" : "http://www.xxx.com/xxx",
        "Progress" : "50"
      },
      "Strategy" : {
        "EndTime" : 2209702074000,
        "StartTime" : 1578550074000
      }
    } ]
  }
}

错误码

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