Job Router Operations - Get Job

Служба:

Communication

Версия API:

2023-11-01

Извлекает существующее задание по идентификатору.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Uri ресурса коммуникации
jobId	path	True	string	Идентификатор задания.
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

Безопасность

AadOauth2Auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя	Описание
https://communication.azure.com/.default

Примеры

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	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — 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

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — 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	Ссылка на внешний родительский контекст, например. Идентификатор вызова.
classificationPolicyId	string	Идентификатор политики классификации, используемой для классификации этого задания.
dispositionCode	string	Код причины для отмененных или закрытых заданий.
enqueuedAt	string	Метка времени задания была помещена в очередь в формате UTC.
etag	string	Тег сущности для этого ресурса.
id	string	Идентификатор задания.
labels		Набор пар "ключ-значение", определяющих атрибуты, используемые обработчиками правил для принятия решений. Значения должны быть примитивными значениями — число, строка, логическое значение.
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	При условии определите, как будет выполняться сопоставление заданий. Режим по умолчанию: QueueAndMatchMode.
notes	RouterJobNote[]	Заметки, присоединенные к заданию, отсортированы по метке времени.
priority	integer	Приоритет этого задания. Значение должно быть от -100 до 100.
queueId	string	Идентификатор очереди, в которую выполняется задание.
requestedWorkerSelectors	RouterWorkerSelector[]	Коллекция вручную указанных селекторов рабочих селекторов, которые работник должен удовлетворять для обработки этого задания.
scheduledAt	string	Если задано, задание будет запланировано в течение определенного времени.
status	RouterJobStatus	Состояние задания.
tags		Набор неидентифицирующие атрибуты, присоединенные к этому заданию. Значения должны быть примитивными значениями — число, строка, логическое значение.

RouterJobAssignment

Сведения о назначении задания рабочей роли.

Имя	Тип	Описание
assignedAt	string	Метка времени, когда задание было назначено рабочей роли в формате UTC.
assignmentId	string	Идентификатор назначения задания.
closedAt	string	Метка времени, когда задание было отмечено как закрытое после завершения работы в формате UTC.
completedAt	string	Метка времени, когда задание было отмечено как завершенное после назначения в формате UTC.
workerId	string	Идентификатор рабочей роли, назначенной заданию.

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.