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

Job Router Operations - Upsert Job

参考

服务:: Communication

API 版本:: 2023-11-01

创建或更新路由器作业。

PATCH {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 版本。

请求头

Media Types: "application/merge-patch+json"

名称	必需	类型	说明
If-Match		string	仅当实体与此字符串匹配时，请求才应继续。
If-Unmodified-Since		string date-time-rfc7231	仅当此时间之后未修改实体时，请求才应继续。

请求正文

Media Types: "application/merge-patch+json"

名称	类型	说明
channelId	string	通道标识符。例如语音、聊天等。
channelReference	string	对外部父上下文的引用，例如调用 ID。
classificationPolicyId	string	用于对此作业进行分类的分类策略的 ID。
dispositionCode	string	取消或关闭作业的原因代码。
labels		一组键/值对，用于标识规则引擎用于做出决策的属性。值必须是基元值 - number、string、boolean 类型的值。
matchingMode	JobMatchingModeCreateOrUpdate: QueueAndMatchModeCreateOrUpdate ScheduleAndSuspendModeCreateOrUpdate SuspendModeCreateOrUpdate	如果提供，将确定如何执行作业匹配。默认模式：QueueAndMatchMode。
notes	RouterJobNote[]	附加到作业的备注，按时间戳排序。
priority	integer	此作业的优先级。值必须介于 -100 到 100 之间。
queueId	string	此作业排队到的队列的 ID。
requestedWorkerSelectors	RouterWorkerSelector[]	手动指定的辅助角色选择器的集合，辅助角色必须满足这些选择器才能处理此作业。
tags		附加到此作业的一组非标识属性。值必须是基元值 - number、string、boolean 类型的值。

响应

名称	类型	说明
200 OK	RouterJob	请求已成功。标头 ETag: string Last-Modified: string
201 Created	RouterJob	请求已成功，因此创建了一个新资源。标头 ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。标头 x-ms-error-code: string

名称

类型

说明

200 OK

RouterJob

请求已成功。

标头

ETag: string
Last-Modified: string

201 Created

RouterJob

请求已成功，因此创建了一个新资源。

标头

ETag: string
Last-Modified: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

意外的错误响应。

标头

x-ms-error-code: string

安全性

AadOauth2Auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
https://communication.azure.com/.default

示例

Creates a new job

Creates a new scheduled router job

Updates a router job

Creates a new job

示例请求

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/jobs/JobId?api-version=2023-11-01

{
  "channelId": "CustomChatChannel",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "queueId": "MainQueue",
  "priority": 5,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true
    }
  ],
  "labels": {},
  "matchingMode": {
    "kind": "queueAndMatch"
  }
}

示例响应

状态代码:: 200

{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "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"
}

状态代码:: 201

{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "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"
}

Creates a new scheduled router job

示例请求

HTTP

PATCH https://contoso.westus.communications.azure.com/routing/jobs/JobId?api-version=2023-11-01

{
  "channelId": "CustomChatChannel",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "queueId": "MainQueue",
  "priority": 5,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true
    }
  ],
  "labels": {},
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  }
}

示例响应

状态代码:: 200

{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  },
  "scheduledAt": null,
  "etag": "etag"
}

状态代码:: 201

{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  },
  "scheduledAt": null,
  "etag": "etag"
}

Updates a router job

示例请求

HTTP

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

{
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af"
}

示例响应

状态代码:: 200

{
  "id": "383541b3-5637-4af6-8aac-3391da8a578a",
  "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"
}

状态代码:: 201

{
  "id": "383541b3-5637-4af6-8aac-3391da8a578a",
  "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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
JobMatchingModeKind	支持的匹配模式类型的鉴别器。
LabelOperator	介绍标签值上支持的操作。
QueueAndMatchMode	描述在作业成功排队后自动启动与作业匹配的匹配模式。
QueueAndMatchModeCreateOrUpdate	描述在作业成功排队后自动启动与作业匹配的匹配模式。
RouterJob	要路由的工作单位
RouterJobAssignment	向辅助角色分配作业的详细信息。
RouterJobCreateOrUpdate	要路由的工作单位
RouterJobNote	附加到作业的备注。
RouterJobStatus	描述作业的各种状态。
RouterWorkerSelector	描述一个条件，该条件必须针对一组标签进行辅助角色选择。
RouterWorkerSelectorStatus	描述辅助角色选择器的状态。
ScheduleAndSuspendMode	描述用于计划将来排队的作业的匹配模式。在指定时间，将辅助角色与作业匹配不会自动启动。
ScheduleAndSuspendModeCreateOrUpdate	描述用于计划将来排队的作业的匹配模式。在指定时间，将辅助角色与作业匹配不会自动启动。
SuspendMode	描述一种匹配模式，其中将挂起与作业匹配的工作器。
SuspendModeCreateOrUpdate	描述一种匹配模式，其中将挂起与作业匹配的工作器。

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一个 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 子类型的类型鉴别器。

QueueAndMatchModeCreateOrUpdate

描述在作业成功排队后自动启动与作业匹配的匹配模式。

名称	类型	说明
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		一组键/值对，用于标识规则引擎用于做出决策的属性。值必须是基元值 - number、string、boolean 类型的值。
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	如果提供，将确定如何执行作业匹配。默认模式：QueueAndMatchMode。
notes	RouterJobNote[]	附加到作业的备注，按时间戳排序。
priority	integer	此作业的优先级。值必须介于 -100 到 100 之间。
queueId	string	此作业排队到的队列的 ID。
requestedWorkerSelectors	RouterWorkerSelector[]	手动指定的辅助角色选择器的集合，辅助角色必须满足这些选择器才能处理此作业。
scheduledAt	string	如果已设置，作业将计划在给定时间排队。
status	RouterJobStatus	作业的状态。
tags		附加到此作业的一组非标识属性。值必须是基元值 - number、string、boolean 类型的值。

RouterJobAssignment

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

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

RouterJobCreateOrUpdate

要路由的工作单位

名称	类型	说明
channelId	string	通道标识符。例如语音、聊天等。
channelReference	string	对外部父上下文的引用，例如调用 ID。
classificationPolicyId	string	用于对此作业进行分类的分类策略的 ID。
dispositionCode	string	取消或关闭作业的原因代码。
labels		一组键/值对，用于标识规则引擎用于做出决策的属性。值必须是基元值 - number、string、boolean 类型的值。
matchingMode	JobMatchingModeCreateOrUpdate: QueueAndMatchModeCreateOrUpdate ScheduleAndSuspendModeCreateOrUpdate SuspendModeCreateOrUpdate	如果提供，将确定如何执行作业匹配。默认模式：QueueAndMatchMode。
notes	RouterJobNote[]	附加到作业的备注，按时间戳排序。
priority	integer	此作业的优先级。值必须介于 -100 到 100 之间。
queueId	string	此作业排队到的队列的 ID。
requestedWorkerSelectors	RouterWorkerSelector[]	手动指定的辅助角色选择器的集合，辅助角色必须满足这些选择器才能处理此作业。
tags		附加到此作业的一组非标识属性。值必须是基元值 - number、string、boolean 类型的值。

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		要与给定运算符的实际标签值进行比较的值。值必须是基元值 - number、string、boolean 类型的值。

RouterWorkerSelectorStatus

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

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

ScheduleAndSuspendMode

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

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

ScheduleAndSuspendModeCreateOrUpdate

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

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

SuspendMode

描述一种匹配模式，其中将挂起与作业匹配的工作器。

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

SuspendModeCreateOrUpdate

描述一种匹配模式，其中将挂起与作业匹配的工作器。

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

通过

Job Router Operations - Upsert Job

URI 参数

请求头

请求正文

响应

安全性

AadOauth2Auth

作用域

示例

Creates a new job

示例请求

示例响应

Creates a new scheduled router job

示例请求

示例响应

Updates a router job

示例请求

示例响应

定义

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

JobMatchingModeKind

LabelOperator

QueueAndMatchMode

QueueAndMatchModeCreateOrUpdate

RouterJob

RouterJobAssignment

RouterJobCreateOrUpdate

RouterJobNote

RouterJobStatus

RouterWorkerSelector

RouterWorkerSelectorStatus

ScheduleAndSuspendMode

ScheduleAndSuspendModeCreateOrUpdate

SuspendMode

SuspendModeCreateOrUpdate

其他资源