查询外呼作业组列表

调试

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

请求参数

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

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

InstanceId String 174952ab-9825-4cc9-a5e2-de82d7fa4cdd

实例id

PageNumber Integer 1

页码,从1开始。

PageSize Integer 10

每页显示条数,必须大于零。

StartTime Long 1578965079000

过滤条件,开始时间

EndTime Long 1579965079000

结束时间

AsyncQuery Boolean false

是否异步获取查询结果。当该值为true时,为异步查询模式,当前接口仅返回AsyncTaskId,需要通过返回的AsyncTaskId请求另外一个接口ListJobGroupsAsync,异步获取查询结果。

SearchText String 面试

搜索关键字。当指定此关键字后,会搜索名称中包含此关键字的作业组。

JobGroupStatusFilter String Draft,Scheduling

过滤条件:按照作业组状态过滤,可以同时选择多个状态过滤,各个状态之间用逗号分隔,逻辑或关系。

取值范围:

  • Draft:草稿。
  • Scheduling:调度中。
  • Executing:执行中。
  • Completed:已完成。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Initializing:初始化。

返回数据

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

接口状态码

AsyncTaskId String 9f372667-3bff-2067-e2eb-7ccd46968847

异步查询key

JobGroups Struct

作业组列表

List Array of JobGroup

数组

CreationTime Long 1578550074361

创建时间

ExportProgress Struct

导出任务进度

FileHttpUrl String https://xxx

文件地址URL

Progress String 50

进度

Status String FINISHED

导出任务状态,取值范围:

  • PENDING:等待中。
  • IN_PROGRESS:处理中。
  • FINISHED:完成。
  • FAILED:失败。
JobDataParsingTaskId String e988987d-fe4f-2037-0a74-0ed8219f7ebd

jobFile解析任务的id

JobGroupDescription String 作业组描述信息

作业组描述

JobGroupId String c62e6789-28a8-41db-941e-171a01d3b3b9

作业组id

JobGroupName String 作业组名称

作业组名称

ModifyTime String 1672922042000

更新时间,单位毫秒。

Progress Struct

作业组统计信息

CancelledNum Integer 5

取消的job数量

Duration Integer 1000

到目前为止执行总时长。

ExecutingNum Integer 5

执行中的job数量

FailedNum Integer 5

失败的job数量

PausedNum Integer 5

暂停的job数量

Scheduling Integer 100

调度中的job数量

StartTime Long 1578965079000

开始时间

Status String Executing

执行状态,取值范围:

  • Draft:草稿。
  • Scheduling:调度中。
  • Executing:执行中。
  • Completed:已完成。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Initializing:初始化。
TotalCompleted Integer 5

总计完成个数

TotalJobs Integer 10

总计作业数量

TotalNotAnswered Integer 0

作业未接通数量

ScriptId String 6cea9bed-63e6-439e-ae4c-b3333efff53d

话术id

ScriptName String 话术名称

话术名称

ScriptVersion String d9e828ac-744b-4dd3-848a-17a3da9167b8

话术版本

Status String Scheduling

执行状态,取值范围:

  • Draft:草稿。
  • Scheduling:调度中。
  • Executing:执行中。
  • Completed:已完成。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Initializing:初始化。
Strategy Struct

作业组调度信息

EndTime Long 2209702074000

策略结束时间

StartTime Long 1578550074000

策略开始时间

TotalCallNum Integer 200

总呼叫次数

PageNumber Integer 1

页码,从1开始。

PageSize Integer 10

每页显示条数,必须大于零。

TotalCount Integer 100

记录总数

HttpStatusCode Integer 200

http状态码

Message String Success

接口提示消息

RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求id

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=ListJobGroups
&InstanceId=174952ab-9825-4cc9-a5e2-de82d7fa4cdd
&PageNumber=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML格式

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<JobGroups>
    <CallingNumbers>95187</CallingNumbers>
    <JobGroupName>第一个催收作业组</JobGroupName>
    <ScriptId>63cc3b45-feb2-4676-a7d7-f717001fa1e1</ScriptId>
    <Strategy>
        <MaxAttemptsPerDay>2</MaxAttemptsPerDay>
        <MinAttemptInterval>60</MinAttemptInterval>
        <StrategyName>策略名字</StrategyName>
        <WorkingTime>
            <BeginTime>09:00:00</BeginTime>
            <EndTime>12:00:00</EndTime>
        </WorkingTime>
        <WorkingTime>
            <BeginTime>13:00:00</BeginTime>
            <EndTime>18:30:00</EndTime>
        </WorkingTime>
    </Strategy>
</JobGroups>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>

JSON格式

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "JobGroups": [{
        "CallingNumbers": ["95187"],
        "JobGroupName": "第一个催收作业组",
        "ScriptId": "63cc3b45-feb2-4676-a7d7-f717001fa1e1",
        "Strategy": {
            "MaxAttemptsPerDay": 2,
            "MinAttemptInterval": 60,
            "StrategyName": "策略名字",
            "WorkingTime": [
                {
                    "BeginTime": "09:00:00",
                    "EndTime": "12:00:00"
                },
                {
                    "BeginTime": "13:00:00",
                    "EndTime": "18:30:00"                }
            ]
        }
    }],
    "RequestId":"254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "Success": true
}

错误码

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