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

查询作业列表。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:ListJobStatus	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	af81a389-91f0-4157-8d82-720edd02b66a
ScenarioId	string	否	场景 ID。	b0f35dd1-0337-402e-9c4f-3a6c2426950a
JobGroupId	string	否	任务 ID。	994b8baf-7ef8-480c-b141-b7b6db77c4df
StartTime	long	否	过滤条件，开始时间，缺省为 0，代表从今天 0 时开始。	1579068424883
EndTime	long	否	过滤条件，截止时间，缺省为 0，代表截止到当前时间。	1579077794665
TimeAlignment	string	否	时间条件按照开始时间还是结束时间查询，有效值为：start、end、job_create。	start
ContactName	string	否	过滤条件，联系人名字。	张三
PhoneNumber	string	否	过滤条件，联系人电话号码。	135****8888
PageNumber	integer	是	分页序号。	1
PageSize	integer	是	分页大小。	10

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	响应码。	200
Code	string	HTTP 状态码。	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	数据总数。	1
List	array<object>	作业数组
Job	object
Status	string	作业状态。 Scheduling(0, "调度中") Executing(1, "执行中"), Succeeded(2, "结束-已触达"), Paused(3, "暂停"), Failed(4, "结束-未触达") Cancelled(5, "已取消-人工干预") Drafted(6, "草稿态"),	Succeeded
JobGroupId	string	任务 ID。	fce6c599-8ede-40e3-9f78-0928eda7b4e8
ScenarioId	string	场景 ID。	ade80092-03d9-4f4d-ad4f-ab8a247d3150
StrategyId	string	策略 ID。	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
JobId	string	作业 ID。	fce6c599-8ede-40e3-9f78-0928eda7b4e8
Priority	integer	优先级。	1
FailureReason	string	失败原因。 Unknown（未知错误）， NoAnswer（无人接听）， InvalidStrategy（无效的策略，策略配置不正确）， TimeUp（调度时发现超时）， NoStrategy（策略为空或没有找到）， CallFailed（呼叫失败）， PerDayCallCountLimit（号码每日呼叫次数限制）， ContactBlockList（禁止外呼名单）， EmptyNumber（空号不再外呼）， JobPerDayCallCountLimit（号码每日呼叫次数限制）， VerificationCancelled（呼叫前验证不通过取消）， ContactSuspended（止呼）， InArrears（欠费）， OutOfService（停机）；	NoAnswer
ReferenceId	string	关联业务 ID。	d5971d98-7312-4f0e-a918-a17d67133e28
Contacts	array<object>	联系人信息。
Contact	object
PhoneNumber	string	电话号码。	135****8888
State	string	状态。 Available（正常）， WrongNumber（号码错误）， DoesNotExist（空号）， Suspended（止呼）；	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>	业务数据
KeyValuePair	object
Key	string	业务数据 key	djrq
Value	string	业务数据 value	2019-08-21 09:49:59.0
Summary	array<object>	对话小结。（历史字段，不再使用）
Summary	object
SummaryName	string	小结名称。	score
GroupId	string	任务 ID。	ba1ba502-d044-48c0-b710-0f1f840a7c53
JobId	string	作业 ID。	994b8baf-7ef8-480c-b141-b7b6db77c4df
Category	string	类别	{}
TaskId	string	通话 ID。	9fdf7a81-6781-4ab8-92fb-1d4231ef365e
Content	string	内容	5
ConversationDetailId	string	通话记录 ID	098b9b09-9223-4a8b-a422-99726f0457f3
SummaryId	string	摘要 ID	dc67d544-df06-4625-ae48-13e3c9f72d8a
Tasks	array<object>	通话列表。
Task	object
Status	string	任务状态，取值范围（注：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
PlanedTime	long	计划呼出时间。	1579068424883
ChatbotId	string	机器人 ID。	1234
ActualTime	long	实际呼出时间。	1579068424883
CalledNumber	string	被叫号码。	135****8888
ScenarioId	string	场景 ID。	ade80092-03d9-4f4d-ad4f-ab8a247d3150
JobId	string	作业 ID。	b72425bd-7871-4050-838e-033d80d754b7
CallId	string	SIP call ID。	1528189846043
CallingNumber	string	主叫号码。	0571****3106
Brief	string	总结（历史字段，不再使用）	1
Duration	integer	通话时长。	120
TaskId	string	通话 ID。	ff44709e-39a6-43ba-959b-20fcabe3e496
Contact	object	联系人信息。
PhoneNumber	string	联系人电话号码。	135****8888
State	string	状态。	Available
ContactId	string	联系人 ID。	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	尊称。	张先生
JobId	string	作业 ID。	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	联系人名称。	张三
Role	string	角色。	*
ReferenceId	string	业务关联 ID。	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
CallingNumbers	array	主叫号码列表。
String	string	主叫号码列表。	["0571****3106"]
TagHits	array<object>	命中标签信息。
TagHit	object
TagName	string	标签名称。	有意向
TagGroup	string	标签组名称。	意向收集

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Jobs": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Status": "Succeeded",
        "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
        "JobId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "Priority": 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": "djrq",
            "Value": "2019-08-21 09:49:59.0"
          }
        ],
        "Summary": [
          {
            "SummaryName": "score",
            "GroupId": "ba1ba502-d044-48c0-b710-0f1f840a7c53",
            "JobId": "994b8baf-7ef8-480c-b141-b7b6db77c4df",
            "Category": "{}",
            "TaskId": "9fdf7a81-6781-4ab8-92fb-1d4231ef365e",
            "Content": "5",
            "ConversationDetailId": "098b9b09-9223-4a8b-a422-99726f0457f3",
            "SummaryId": "dc67d544-df06-4625-ae48-13e3c9f72d8a"
          }
        ],
        "Tasks": [
          {
            "Status": "Succeeded",
            "PlanedTime": 1579068424883,
            "ChatbotId": "1234",
            "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",
            "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\"]"
        ],
        "TagHits": [
          {
            "TagName": "有意向",
            "TagGroup": "意向收集"
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	The specified parameter %s is invalid.	参数值校验不通过。请使用请求参数构造规范化的请求字符串。
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.	内部错误。建议重试，如果多次重试报错请提交工单。

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

变更历史

变更时间	变更内容概要	操作
2025-02-26	OpenAPI 描述信息更新、OpenAPI 错误码发生变更	查看变更详情
2023-10-20	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情