你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Job Router Operations - Get Job

服务:

Communication

API 版本:

2023-11-01

按 ID 检索现有作业。

GET {endpoint}/routing/jobs/{jobId}?api-version=2023-11-01

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	通信资源的 URI
jobId	path	True	string	作业的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	RouterJob	请求已成功。 标头 ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

示例

Retrieves an existing job by Id

示例请求

HTTP

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958?api-version=2023-11-01

示例响应

状态代码:

200

{
  "id": "8780b28c-7079-4de1-9143-4d369289e958",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomVoiceChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "queueAndMatch"
  },
  "etag": "etag"
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobMatchingModeKind	支持的匹配模式类型的鉴别器。
LabelOperator	描述支持对标签值执行的操作。
QueueAndMatchMode	描述一种匹配模式，在该模式中，将辅助角色与作业匹配在作业成功排队后自动启动。
RouterJob	要路由的工作单元
RouterJobAssignment	向辅助角色分配作业的详细信息。
RouterJobNote	附加到作业的注释。
RouterJobStatus	描述作业的各种状态。
RouterWorkerSelector	描述必须针对一组标签满足才能选择辅助角色的条件。
RouterWorkerSelectorStatus	描述辅助角色选择器的状态。
ScheduleAndSuspendMode	描述用于计划将来排队的作业的匹配模式。 在指定时间，将辅助角色与作业匹配不会自动启动。
SuspendMode	描述挂起辅助角色与作业匹配的匹配模式。

Azure.Core.Foundations.Error

错误对象。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
details	Azure.Core.Foundations.Error[]	有关导致此项报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	一个 对象，该对象包含比当前对象更具体的错误信息。
message	string	错误的用户可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	string	服务器定义的一组错误代码中的一个。
innererror	Azure.Core.Foundations.InnerError	内部错误。

JobMatchingModeKind

支持的匹配模式类型的鉴别器。

名称	类型	说明
queueAndMatch	string	QueueAndMatchMode 的鉴别器值。
scheduleAndSuspend	string	ScheduleAndSuspendMode 的鉴别器值。
suspend	string	SuspendMode 的鉴别器值。

LabelOperator

描述支持对标签值执行的操作。

名称	类型	说明
equal	string	平等。
greaterThan	string	大于。
greaterThanOrEqual	string	大于或等于。
lessThan	string	小于。
lessThanOrEqual	string	小于或等于。
notEqual	string	不等于。

QueueAndMatchMode

描述一种匹配模式，在该模式中，将辅助角色与作业匹配在作业成功排队后自动启动。

名称	类型	说明
kind	string: queueAndMatch	描述 JobMatchingMode 子类型的类型鉴别器。

RouterJob

要路由的工作单元

名称	类型	说明
assignments	<string,  RouterJobAssignment>	作业分配的集合。 键为 AssignmentId。
attachedWorkerSelectors	RouterWorkerSelector[]	分类策略附加的辅助角色选择器的集合，辅助角色必须满足这些选择器才能处理此作业。
channelId	string	通道标识符。例如语音、聊天等。
channelReference	string	对外部父上下文的引用，例如呼叫 ID。
classificationPolicyId	string	用于对此作业进行分类的分类策略的 ID。
dispositionCode	string	已取消或关闭作业的原因代码。
enqueuedAt	string	作业以 UTC 格式排队的时间戳。
etag	string	此资源的实体标记。
id	string	作业的 ID。
labels		一组键/值对，用于标识规则引擎用于做出决策的属性。 值必须是基元值 - 数字、字符串、布尔值。
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	如果提供， 将确定如何进行作业匹配。默认模式：QueueAndMatchMode。
notes	RouterJobNote[]	附加到作业的笔记，按时间戳排序。
priority	integer	此作业的优先级。 值必须介于 -100 到 100 之间。
queueId	string	此作业排队的队列的 ID。
requestedWorkerSelectors	RouterWorkerSelector[]	手动指定的辅助角色选择器的集合，辅助角色必须满足这些选择器才能处理此作业。
scheduledAt	string	如果设置，作业将安排在给定时间排队。
status	RouterJobStatus	作业的状态。
tags		附加到此作业的一组非标识属性。 值必须是基元值 - 数字、字符串、布尔值。

RouterJobAssignment

向辅助角色分配作业的详细信息。

名称	类型	说明
assignedAt	string	以 UTC 格式将作业分配给辅助角色时的时间戳。
assignmentId	string	作业分配的 ID。
closedAt	string	作业在 UTC 完成后标记为已关闭时的时间戳。
completedAt	string	在 UTC 中分配作业后标记为已完成的时间戳。
workerId	string	分配给作业的辅助角色的 ID。

RouterJobNote

附加到作业的注释。

名称	类型	说明
addedAt	string	以 UTC 格式添加笔记的时间。 如果未提供， 将默认为当前时间。
message	string	注释中包含的消息。

RouterJobStatus

描述作业的各种状态。

名称	类型	说明
assigned	string	作业已分配给辅助角色。
cancelled	string	作业已取消。
classificationFailed	string	作业的分类过程失败。
closed	string	工作线程已关闭作业。
completed	string	作业已由辅助角色完成。
created	string	已创建作业。
pendingClassification	string	作业正在等待分类。
pendingSchedule	string	作业已创建，但尚未计划。
queued	string	作业已排队。
scheduleFailed	string	作业计划失败。
scheduled	string	已成功安排作业。
waitingForActivation	string	作业处于挂起状态，正在等待更新。

RouterWorkerSelector

描述必须针对一组标签满足才能选择辅助角色的条件。

名称	类型	说明
expedite	boolean	只要此选择器处于活动状态，就将作业推送到队列的前面。
expiresAfterSeconds	number	描述此标签选择器的有效期（以秒为单位）。
expiresAt	string	此辅助角色选择器过期的时间（UTC）。
key	string	要查询的标签键。
labelOperator	LabelOperator	介绍如何将标签的值与辅助角色选择器上定义的值进行比较。
status	RouterWorkerSelectorStatus	辅助角色选择器的状态。
value		与给定运算符的实际标签值进行比较的值。 值必须是基元值 - 数字、字符串、布尔值。

RouterWorkerSelectorStatus

描述辅助角色选择器的状态。

名称	类型	说明
active	string	辅助角色选择器有效。
expired	string	辅助角色选择器无效。

ScheduleAndSuspendMode

描述用于计划将来排队的作业的匹配模式。 在指定时间，将辅助角色与作业匹配不会自动启动。

名称	类型	说明
kind	string: scheduleAndSuspend	描述 JobMatchingMode 子类型的类型鉴别器。
scheduleAt	string	请求的计划时间。

SuspendMode

描述挂起辅助角色与作业匹配的匹配模式。

名称	类型	说明
kind	string: suspend	描述 JobMatchingMode 子类型的类型鉴别器。