AI 助理
文档备案控制台
官方文档
首页 伶鹊 智能外呼机器人 开发参考 API参考 API目录 外呼任务组管理 ListJobsByGroup - 根据作业组查询作业

ListJobsByGroup - 根据作业组查询作业

更新时间：
复制 MD 格式
产品详情
我的收藏

根据作业组查询作业。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:ListJobsByGroup

list

*全部资源

*

 无 无

请求参数

名称

类型

必填

描述

示例值
InstanceId

string

是

实例 ID

af81a389-91f0-4157-8d82-720edd02b66a
JobGroupId

string

是

作业组 ID

de48407d-309e-451a-81ec-6fb11f8fdbf3
JobStatus

string

否

作业状态

Succeeded
JobFailureReason

string

否

作业失败原因

NoAnswer
PageNumber

integer

是

页数

1
PageSize

integer

是

每页显示的条数

10

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码

200
Code

string

响应码

OK
Message

string

接口提示信息

Success
RequestId

string

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success

boolean

是否成功

true
Jobs

object

作业数组

PageNumber

integer

页号

1
PageSize

integer

分页大小

10
TotalCount

integer

总计个数

18
List

array<object>

作业列表

array<object>

Status

string

作业状态。

  • Scheduling(0, "调度中")

  • Executing(1, "执行中"),

  • Succeeded(2, "结束-已触达"),

  • Paused(3, "暂停"),

  • Failed(4, "结束-未触达")

  • Cancelled(5, "已取消-人工干预")

  • Drafted(6, "草稿态"),

Succeeded
ScenarioId

string

场景 ID（历史参数）

ade80092-03d9-4f4d-ad4f-ab8a247d3150
JobGroupId

string

任务 ID

fce6c599-8ede-40e3-9f78-0928eda7b4e8
StrategyId

string

策略 ID

c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobId

string

作业 ID

b72425bd-7871-4050-838e-033d80d754b7
Priority

integer

优先级

5
SystemPriority

integer

系统优先级

1
FailureReason

string

失败原因。

  • Unknown（未知错误），

  • NoAnswer（无人接听），

  • InvalidStrategy（无效的策略，策略配置不正确），

  • TimeUp（调度时发现超时），

  • NoStrategy（策略为空或没有找到），

  • CallFailed（呼叫失败），

  • PerDayCallCountLimit（号码每日呼叫次数限制），

  • ContactBlockList（禁止外呼名单），

  • EmptyNumber（空号不再外呼），

  • JobPerDayCallCountLimit（号码每日呼叫次数限制），

  • VerificationCancelled（呼叫前验证不通过取消），

  • ContactSuspended（止呼），

  • InArrears（欠费），

  • OutOfService（停机），

  • NoneRepeatableJobMaxAttemptCountLimit（任务达到最大尝试次数）；

NoAnswer
ReferenceId

string

第三方系统 id

d5971d98-7312-4f0e-a918-a17d67133e28
Contacts

array<object>

联系人列表

object

联系人信息。

PhoneNumber

string

联系人号码

134********
State

string

已废弃

Available
ContactId

string

联系人 ID。（系统自动生成）

db3db762-e421-44c9-9a01-cb423470757c
Honorific

string

联系人尊称。（与联系人名字一致）

张先生
JobId

string

作业 ID。（已废弃）

72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName

string

联系人名字

张三
Role

string

已废弃

*
ReferenceId

string

联系人第三方系统 id，客户自己上传

2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras

array<object>

业务数据

说明

TenantId、ServiceId 为系统生成，其余参数为自定义参考传入的

object

Key

string

业务参数名字

性别
Value

string

业务参数值

男
Summary

array<object>

对话摘要。【已废弃】

说明

可通过 DescribeJob 接口获取

object

SummaryName

string

摘要名字

score
JobGroupId

string

作业组 ID

88e56cfb-33f8-477a-907c-0fe83292d924
JobId

string

作业 ID。

f102a853-5f5a-47fb-8869-b31ea74a9620
Category

string

对话摘要类别

{}
TaskId

string

通话 ID。

b0f35dd1-0337-402e-9c4f-3a6c2426950a
Content

string

对话摘要内容

5
ConversationDetailId

string

通话记录 ID

62a860f5-a8b3-4b75-9512-c7e04bb7c8bc
SummaryId

string

摘要 ID

680f1905-81ae-4aab-99dd-2964dfb767fa
CallingNumbers

array

主叫号码列表

string

主叫号码

0571****3106

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 18,
    "List": [
      {
        "Status": "Succeeded",
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
        "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
        "Priority": 5,
        "SystemPriority": 1,
        "FailureReason": "NoAnswer",
        "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
        "Contacts": [
          {
            "PhoneNumber": "134********",
            "State": "Available",
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "Honorific": "张先生",
            "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160",
            "ContactName": "张三",
            "Role": "*",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
          }
        ],
        "Extras": [
          {
            "Key": "性别",
            "Value": "男"
          }
        ],
        "Summary": [
          {
            "SummaryName": "score",
            "JobGroupId": "88e56cfb-33f8-477a-907c-0fe83292d924",
            "JobId": "f102a853-5f5a-47fb-8869-b31ea74a9620",
            "Category": "{}",
            "TaskId": "b0f35dd1-0337-402e-9c4f-3a6c2426950a",
            "Content": "5",
            "ConversationDetailId": "62a860f5-a8b3-4b75-9512-c7e04bb7c8bc",
            "SummaryId": "680f1905-81ae-4aab-99dd-2964dfb767fa"
          }
        ],
        "CallingNumbers": [
          "0571****3106"
        ]
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParameter The specified parameter %s is invalid. 参数值校验不通过。请使用请求参数构造规范化的请求字符串。
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. 指定的实例不存在。

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

变更历史

更多信息，参考变更详情。

上一篇：ListDownloadTasks - 任务下载列表下一篇：CreateJobGroupExportTask - 创建外呼作业组导出任务