Job Router - Get Job

Referencia

Servicio:: Communication

Versión de la API:: 2022-07-18-preview

Recupera un trabajo existente por id.

GET {endpoint}/routing/jobs/{id}?api-version=2022-07-18-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Punto de conexión del recurso de Comunicación de Azure.
id	path	True	string	Identificador del trabajo que se va a recuperar.
api-version	query	True	string	Versión de la API que se va a invocar.

Respuestas

Nombre	Tipo	Description
200 OK	RouterJob	Éxito
Other Status Codes	CommunicationErrorResponse	Error

Ejemplos

Get a single Job

Solicitud de ejemplo

HTTP

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958?api-version=2022-07-18-preview

Respuesta de muestra

status code:: 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": {
    "modeType": "queueAndMatchMode",
    "queueAndMatchMode": {},
    "scheduleAndSuspendMode": null,
    "suspendMode": null
  }
}

Definiciones

Nombre	Description
JobMatchingMode	Modo de coincidencia que se va a aplicar a este trabajo. Tipos admitidos: QueueAndMatchMode: se usa cuando se necesita hacer coincidir el trabajo con un trabajo justo después de poner en cola el trabajo. ScheduleAndSuspendMode: se usa para programar trabajos en cola en un momento futuro. En el momento especificado, la coincidencia de un trabajo con el trabajo no se iniciará automáticamente. SuspendMode: se usa cuando es necesario suspender los trabajos coincidentes con un trabajo.
JobMatchModeType	Valor discriminador usado para diferenciar entre los tipos de modo coincidentes admitidos.
LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de etiquetas.
RouterJob	Unidad de trabajo que se va a enrutar
RouterJobAssignment	Detalles de asignación de un trabajo a un trabajador
RouterJobStatus	Estado del trabajo.
RouterWorkerSelector	Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.
RouterWorkerSelectorStatus	Estado del selector de trabajo.
ScheduleAndSuspendMode	Describe un modo coincidente que se usa para programar trabajos que se van a poner en cola en un momento futuro. En el momento especificado, la coincidencia de trabajo con un trabajo no se iniciará automáticamente.

JobMatchingMode

Object

Modo de coincidencia que se va a aplicar a este trabajo.

Tipos admitidos:

QueueAndMatchMode: se usa cuando se necesita hacer coincidir el trabajo con un trabajo justo después de poner en cola el trabajo. ScheduleAndSuspendMode: se usa para programar trabajos en cola en un momento futuro. En el momento especificado, la coincidencia de un trabajo con el trabajo no se iniciará automáticamente. SuspendMode: se usa cuando es necesario suspender los trabajos coincidentes con un trabajo.

Nombre	Tipo	Description
modeType	JobMatchModeType	Valor discriminador usado para diferenciar entre los tipos de modo coincidentes admitidos.
queueAndMatchMode	object	Describe un modo coincidente en el que el trabajo coincidente con un trabajo se inicia automáticamente después de que el trabajo se pone en cola correctamente.
scheduleAndSuspendMode	ScheduleAndSuspendMode	Describe un modo coincidente que se usa para programar trabajos que se van a poner en cola en un momento futuro. En el momento especificado, la coincidencia de trabajo con un trabajo no se iniciará automáticamente.
suspendMode	object	Describe un modo coincidente en el que se suspende la coincidencia de trabajo con un trabajo.

JobMatchModeType

Enumeración

Valor discriminador usado para diferenciar entre los tipos de modo coincidentes admitidos.

Valor	Description
queueAndMatchMode
scheduleAndSuspendMode
suspendMode

LabelOperator

Enumeración

Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de etiquetas.

Valor	Description
equal
greaterThan
greaterThanEqual
lessThan
lessThanEqual
notEqual

RouterJob

Object

Unidad de trabajo que se va a enrutar

Nombre	Tipo	Description
assignments	<string, RouterJobAssignment>	Colección de las asignaciones del trabajo. La clave es AssignmentId.
attachedWorkerSelectors	RouterWorkerSelector[]	Colección de selectores de etiquetas adjuntos por una directiva de clasificación, que un trabajador debe satisfacer para procesar este trabajo.
channelId	string	Identificador del canal. Eg. voz, chat, etc.
channelReference	string	Referencia a un contexto primario externo, por ejemplo, id. de llamada.
classificationPolicyId	string	Identificador de la directiva de clasificación que se usa para clasificar un trabajo.
dispositionCode	string	Código de motivo para trabajos cancelados o cerrados.
enqueuedAt	string (date-time)	Hora en que un trabajo se puso en cola en UTC.
id	string	Identificador del trabajo.
labels		Conjunto de pares clave-valor que identifican los atributos usados por los motores de reglas para tomar decisiones.
matchingMode	JobMatchingMode	Modo de coincidencia que se va a aplicar a este trabajo. Tipos admitidos: QueueAndMatchMode: se usa cuando se necesita hacer coincidir el trabajo con un trabajo justo después de poner en cola el trabajo. ScheduleAndSuspendMode: se usa para programar trabajos en cola en un momento futuro. En el momento especificado, la coincidencia de un trabajo con el trabajo no se iniciará automáticamente. SuspendMode: se usa cuando es necesario suspender los trabajos coincidentes con un trabajo.
notes	object	Notas adjuntas a un trabajo, ordenadas por marca de tiempo
priority	integer (int32)	Prioridad de este trabajo.
queueId	string	Identificador de la cola a la que se pone en cola este trabajo.
requestedWorkerSelectors	RouterWorkerSelector[]	Colección de selectores de etiquetas especificados manualmente, que un trabajo debe satisfacer para procesar este trabajo.
scheduledAt	string (date-time)	Si se establece, el trabajo se programará para poner en cola en un momento dado.
status	RouterJobStatus	Estado del trabajo.
tags		Un conjunto de atributos no identificativos adjuntos a este trabajo

RouterJobAssignment

Object

Detalles de asignación de un trabajo a un trabajador

Nombre	Tipo	Description
assignedAt	string (date-time)	Hora de asignación del trabajo en UTC.
assignmentId	string minLength: 1	Identificador de la asignación de trabajo.
closedAt	string (date-time)	Hora en que el trabajo se marcó como cerrado después de completarse en UTC.
completedAt	string (date-time)	Hora en que el trabajo se marcó como completado después de asignarse en UTC.
workerId	string	Identificador del trabajo asignado al trabajo.

RouterJobStatus

Enumeración

Estado del trabajo.

Valor	Description
assigned
cancelled
classificationFailed
closed
completed
created
pendingClassification
pendingSchedule
queued
scheduleFailed
scheduled
waitingForActivation

RouterWorkerSelector

Object

Describe una condición que se debe cumplir con un conjunto de etiquetas para la selección de trabajo.

Nombre	Tipo	Description
expedite	boolean	Inserta el trabajo en la parte delantera de la cola siempre que este selector esté activo.
expiresAfterSeconds	number (double)	Describe cuánto tiempo es válido este selector de etiquetas en segundos.
expiresAt	string (date-time)	Hora a la que expira este selector de trabajo en UTC
key	string minLength: 0 maxLength: 500	Clave de etiqueta en la que se va a consultar
labelOperator	LabelOperator	Describe cómo se compara el valor de la etiqueta con el valor definido en el selector de etiquetas.
status	RouterWorkerSelectorStatus	Estado del selector de trabajo.
value	object	Valor que se va a comparar con el valor de etiqueta real con el operador especificado.

RouterWorkerSelectorStatus

Enumeración

Estado del selector de trabajo.

Valor	Description
active
expired

ScheduleAndSuspendMode

Object

Describe un modo coincidente que se usa para programar trabajos que se van a poner en cola en un momento futuro. En el momento especificado, la coincidencia de trabajo con un trabajo no se iniciará automáticamente.

Nombre	Tipo	Description
scheduleAt	string (date-time)	Hora programada.

Compartir a través de

Job Router - Get Job

Parámetros de identificador URI

Respuestas

Ejemplos

Get a single Job

Solicitud de ejemplo

Respuesta de muestra

Definiciones

JobMatchingMode

JobMatchModeType

LabelOperator

RouterJob

RouterJobAssignment

RouterJobStatus

RouterWorkerSelector

RouterWorkerSelectorStatus

ScheduleAndSuspendMode