ListJobs - 查询多个作业

查询多个作业。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
outboundbot:GetJobsget
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID

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

作业 ID 列表,注:子级条数 <= 99。

string

作业 ID

24fb9a8d-f20e-4ee2-a11c-094dda68c5cc

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP 状态码

200
Codestring

接口状态码

OK
Messagestring

接口提示消息

Success
RequestIdstring

请求 ID

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

是否成功

true
Jobsarray<object>

作业数组

Jobobject
Statusstring

作业状态,取值范围

  • Scheduling:调度中。
  • Executing:执行中。
  • Succeeded:成功。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Drafted:草稿态。
Succeeded
ScenarioIdstring

业务 ID

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

作业组 ID

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

策略 ID

c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobIdstring

作业 ID

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

作业优先级

5
SystemPriorityinteger

系统优先级

1
FailureReasonstring

作业失败原因

NoAnswer
ReferenceIdstring

作业第三方系统 ID

d5971d98-7312-4f0e-a918-a17d67133e28
Contactsarray<object>

联系人列表

Contactobject
PhoneNumberstring

电话号码

135****8888
Statestring

状态

Available
ContactIdstring

联系人 ID

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

尊称

张先生
JobIdstring

作业 ID

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

联系人名字

张三
Rolestring

联系人角色

*
ReferenceIdstring

联系人第三方系统 ID

2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extrasarray<object>

业务参数列表

KeyValuePairobject
Keystring

业务参数 Key

name
Valuestring

业务参数 Value

张三
Summaryarray<object>

对话摘要信息

Summaryobject
SummaryNamestring

对话摘要名字

score
Categorystring

对话摘要类别

{}
Contentstring

对话摘要内容

5
Tasksarray<object>

任务列表

Taskobject
Statusstring

任务状态,取值范围 (注:Succeeded 状态已细分原因,不会展示 Succeeded:1(已接通)状态,之后返回均为具体细分原因类型。)

  • Executing:0(正在拨打)。
  • Succeeded:1(已接通)。
  • NoAnswer:2(未接通-无人接听)。
  • NotExist:3(未接通-空号)。
  • Busy:4(未接通-占线)。
  • Cancelled:5(未呼出-任务停止)。
  • Failed:6(失败)。
  • NotConnected:7(未接通-无法接通)。
  • PoweredOff:8(未接通-关机)。
  • OutOfService:9(未接通-被叫停机)。
  • InArrears:10(未接通-被叫欠费)。
  • EmptyNumber:11(未呼出-空号不外呼)。
  • PerDayCallCountLimit:12(未呼出-超出每日上限)。
  • ContactBlockList:13(未呼出-黑名单)。
  • CallerNotRegistered:14(未呼出-主叫号码未注册)。
  • Terminated:15(未呼出-被终止)。
  • VerificationCancelled:16(未呼出-呼叫前验证不通过取消)。
  • OutOfServiceNoCall:17(未呼出-被叫停机不外呼)。
  • InArrearsNoCall:18(未呼出-被叫欠费不外呼)。
  • CallingNumberNotExist:19(未呼出-主叫号码不存在)。
  • SucceededFinish:20(已接通-正常完结)。
  • SucceededChatbotHangUpAfterNoAnswer:21(已接通-拒识后机器人挂机)。
  • SucceededChatbotHangUpAfterSilence:22(已接通-静默超时挂机)。
  • SucceededClientHangUpAfterNoAnswer:23(已接通-拒识后用户挂机)。
  • SucceededClientHangUp:24(已接通-用户无理由挂机)。
  • SucceededTransferByIntent:25(已接通-命中意图转人工)。
  • SucceededTransferAfterNoAnswer:26(已接通-拒识转人工)。
  • SucceededInoInterAction:27(已接通-用户侧无交互)。
  • SucceededError:28(已接通-系统异常中断)。
  • SucceededSpecialInterceptVoiceAssistant:29(已接通-特殊情况拦截-语音助手)。
  • SucceededSpecialInterceptExtensionNumberTransfer:30(已接通-特殊情况拦截-分机号转接)。
Succeeded
PlanedTimelong

任务计划执行时间

1579068424883
ChatbotIdstring

对话机器人 id

1234
ActualTimelong

实际执行时间

1579068424883
CalledNumberstring

被叫号码

135****8888
ScenarioIdstring

场景 ID

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

作业 ID

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

呼叫 ID

1528189846043
CallingNumberstring

主叫号码

0571****3106
Briefstring

业务结果

1
Durationinteger

持续时间

120
TaskIdstring

任务 ID

ff44709e-39a6-43ba-959b-20fcabe3e496
Conversationarray<object>

对话列表

ConversationDetailobject
Speakerstring

是谁说的话,Robot 机器人, Contact 联系人

Robot
Timestamplong

对话文本入库时间戳

1579068424883
Scriptstring

对话文本

你好,我是**客服
Summaryarray<object>

摘要信息

Summaryobject
SummaryNamestring

摘要名称

是本人
Categorystring

类目

标签
Contentstring

摘要内容

Contactobject

任务的联系人

PhoneNumberstring

电话号码

135****8888
Statestring

状态

Available
ContactIdstring

联系人 ID

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

联系人尊称

张先生
JobIdstring

作业 ID

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

联系人名字

张三
Rolestring

角色

*
ReferenceIdstring

联系人第三方系统 ID

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

主叫号码列表

Stringstring

主叫号码列表

["0571****3106"]

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": [
    {
      "Status": "Succeeded",
      "ScenarioId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
      "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": "135****8888",
          "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": "name",
          "Value": "张三"
        }
      ],
      "Summary": [
        {
          "SummaryName": "score",
          "Category": "\t{}",
          "Content": "5"
        }
      ],
      "Tasks": [
        {
          "Status": "Succeeded",
          "PlanedTime": 1579068424883,
          "ChatbotId": "\t1234",
          "ActualTime": 1579068424883,
          "CalledNumber": "135****8888",
          "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
          "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
          "CallId": "1528189846043",
          "CallingNumber": "0571****3106",
          "Brief": "1",
          "Duration": 120,
          "TaskId": "ff44709e-39a6-43ba-959b-20fcabe3e496",
          "Conversation": [
            {
              "Speaker": "Robot",
              "Timestamp": 1579068424883,
              "Script": "你好,我是**客服",
              "Summary": [
                {
                  "SummaryName": "是本人",
                  "Category": "标签",
                  "Content": "是"
                }
              ]
            }
          ],
          "Contact": {
            "PhoneNumber": "135****8888",
            "State": "Available",
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "Honorific": "张先生",
            "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
            "ContactName": "张三",
            "Role": "*",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
          }
        }
      ],
      "CallingNumbers": [
        "[\"0571****3106\"]"
      ]
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2025-02-26OpenAPI 描述信息更新查看变更详情