Condividi tramite

Job Router Operations - Get Job

  • Riferimento
Servizio:
Communication
Versione API:
2023-11-01

Recupera un processo esistente in base all'ID.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Uri della risorsa di comunicazione
jobId
 path True

string

ID di un processo.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Risposte

Nome Tipo Descrizione
200 OK

RouterJob

La richiesta ha avuto esito positivo.

Intestazioni

  • ETag: string
  • Last-Modified: string
Other Status Codes

Azure.Core.Foundations.ErrorResponse

Risposta di errore imprevista.

Intestazioni

x-ms-error-code: string

Esempio

Retrieves an existing job by Id

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
Azure.Core.Foundations.Error

Oggetto error.
Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobMatchingModeKind

Discriminazione per i tipi di modalità di corrispondenza supportati.
LabelOperator

Descrive le operazioni supportate sui valori dell'etichetta.
QueueAndMatchMode

Descrive una modalità corrispondente in cui il ruolo di lavoro corrispondente a un processo viene avviato automaticamente dopo che il processo viene accodato correttamente.
RouterJob

Unità di lavoro da instradare
RouterJobAssignment

Dettagli dell'assegnazione di un processo a un ruolo di lavoro.
RouterJobNote

Nota associata a un processo.
RouterJobStatus

Descrive lo stato di un processo.
RouterWorkerSelector

Descrive una condizione che deve essere soddisfatta rispetto a un set di etichette per la selezione del ruolo di lavoro.
RouterWorkerSelectorStatus

Descrive lo stato di un selettore di lavoro.
ScheduleAndSuspendMode

Descrive una modalità di corrispondenza usata per la pianificazione dei processi da accodare in un momento futuro. Al momento specificato, il ruolo di lavoro corrispondente a un processo non verrà avviato automaticamente.
SuspendMode

Descrive una modalità corrispondente in cui viene sospeso il ruolo di lavoro corrispondente a un processo.

Azure.Core.Foundations.Error

Oggetto error.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

Azure.Core.Foundations.Error[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message

string

Rappresentazione leggibile dell'errore.
target

string

Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Risposta contenente i dettagli dell'errore.

Nome Tipo Descrizione
error

Azure.Core.Foundations.Error

Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida per l'API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
innererror

Azure.Core.Foundations.InnerError

Errore interno.

JobMatchingModeKind

Discriminazione per i tipi di modalità di corrispondenza supportati.

Nome Tipo Descrizione
queueAndMatch

string

Valore discriminatorio per QueueAndMatchMode.
scheduleAndSuspend

string

Valore discriminatorio per ScheduleAndSuspendMode.
suspend

string

Valore discriminatorio per SuspendMode.

LabelOperator

Descrive le operazioni supportate sui valori dell'etichetta.

Nome Tipo Descrizione
equal

string

Uguale.
greaterThan

string

Maggiore di.
greaterThanOrEqual

string

Maggiore o uguale a.
lessThan

string

Minore di.
lessThanOrEqual

string

Minore o uguale a.
notEqual

string

Non uguale.

QueueAndMatchMode

Descrive una modalità corrispondente in cui il ruolo di lavoro corrispondente a un processo viene avviato automaticamente dopo che il processo viene accodato correttamente.

Nome Tipo Descrizione
kind string:

queueAndMatch

La discriminazione del tipo che descrive un sottotipo di JobMatchingMode.

RouterJob

Unità di lavoro da instradare

Nome Tipo Descrizione
assignments

<string,  RouterJobAssignment>

Raccolta delle assegnazioni del processo. La chiave è AssignmentId.
attachedWorkerSelectors

RouterWorkerSelector[]

Raccolta di selettori di lavoro collegati da criteri di classificazione, che un lavoratore deve soddisfare per elaborare questo processo.
channelId

string

Identificatore del canale. Ad esempio. voce, chat e così via.
channelReference

string

Riferimento a un contesto padre esterno, ad esempio. ID chiamata.
classificationPolicyId

string

ID di criteri di classificazione usati per classificare questo processo.
dispositionCode

string

Codice motivo per processi annullati o chiusi.
enqueuedAt

string

Timestamp di un processo in coda in FORMATO UTC.
etag

string

Tag di entità per questa risorsa.
id

string

ID di un processo.
labels

Set di coppie chiave/valore che identificano gli attributi usati dai motori delle regole per prendere decisioni. I valori devono essere valori primitivi: numero, stringa, booleano.
matchingMode JobMatchingMode:

Se specificato, determinerà la modalità di esecuzione della corrispondenza dei processi. Modalità predefinita: QueueAndMatchMode.
notes

RouterJobNote[]

Note associate a un processo, ordinate in base al timestamp.
priority

integer

Priorità di questo processo. Il valore deve essere compreso tra -100 e 100.
queueId

string

ID di una coda a cui viene accodato questo processo.
requestedWorkerSelectors

RouterWorkerSelector[]

Raccolta di selettore di lavoro specificato manualmente, che un lavoratore deve soddisfare per elaborare questo processo.
scheduledAt

string

Se impostato, il processo verrà pianificato per essere eseguito in un determinato momento.
status

RouterJobStatus

Stato del processo.
tags

Set di attributi non di identificazione collegati a questo processo. I valori devono essere valori primitivi: numero, stringa, booleano.

RouterJobAssignment

Dettagli dell'assegnazione di un processo a un ruolo di lavoro.

Nome Tipo Descrizione
assignedAt

string

Timestamp quando il processo è stato assegnato a un ruolo di lavoro in formato UTC.
assignmentId

string

ID di un'assegnazione di processo.
closedAt

string

Timestamp quando il processo è stato contrassegnato come chiuso dopo essere stato completato in UTC.
completedAt

string

Timestamp quando il processo è stato contrassegnato come completato dopo essere stato assegnato in UTC.
workerId

string

ID del ruolo di lavoro assegnato al processo.

RouterJobNote

Nota associata a un processo.

Nome Tipo Descrizione
addedAt

string

Ora in cui è stata aggiunta la nota in formato UTC. Se non specificato, il valore predefinito verrà impostato sull'ora corrente.
message

string

Messaggio contenuto nella nota.

RouterJobStatus

Descrive lo stato di un processo.

Nome Tipo Descrizione
assigned

string

Il processo è stato assegnato a un ruolo di lavoro.
cancelled

string

Il processo è stato annullato.
classificationFailed

string

Processo di classificazione non riuscito per il processo.
closed

string

Il processo è stato chiuso da un lavoratore.
completed

string

Il processo è stato completato da un lavoratore.
created

string

Il processo è stato creato.
pendingClassification

string

Il processo è in attesa di essere classificato.
pendingSchedule

string

Il processo è stato creato ma non è ancora stato pianificato.
queued

string

Il processo è stato accodato.
scheduleFailed

string

Pianificazione del processo non riuscita.
scheduled

string

Il processo è stato pianificato correttamente.
waitingForActivation

string

Il processo si trova in uno stato sospeso e in attesa di un aggiornamento.

RouterWorkerSelector

Descrive una condizione che deve essere soddisfatta rispetto a un set di etichette per la selezione del ruolo di lavoro.

Nome Tipo Descrizione
expedite

boolean

Esegue il push di un processo nella parte anteriore della coda, purché questo selettore sia attivo.
expiresAfterSeconds

number

Viene descritto quanto tempo questo selettore di etichette è valido in secondi.
expiresAt

string

Ora in cui il selettore di lavoro scade in formato UTC.
key

string

Chiave dell'etichetta da eseguire in caso di query.
labelOperator

LabelOperator

Descrive il modo in cui il valore dell'etichetta viene confrontato con il valore definito nel selettore di lavoro.
status

RouterWorkerSelectorStatus

Stato del selettore di lavoro.
value

Valore da confrontare con il valore effettivo dell'etichetta con l'operatore specificato. I valori devono essere valori primitivi: numero, stringa, booleano.

RouterWorkerSelectorStatus

Descrive lo stato di un selettore di lavoro.

Nome Tipo Descrizione
active

string

Il selettore di lavoro è valido.
expired

string

Il selettore di lavoro non è valido.

ScheduleAndSuspendMode

Descrive una modalità di corrispondenza usata per la pianificazione dei processi da accodare in un momento futuro. Al momento specificato, il ruolo di lavoro corrispondente a un processo non verrà avviato automaticamente.

Nome Tipo Descrizione
kind string:

scheduleAndSuspend

La discriminazione del tipo che descrive un sottotipo di JobMatchingMode.
scheduleAt

string

Tempo di pianificazione richiesto.

SuspendMode

Descrive una modalità corrispondente in cui viene sospeso il ruolo di lavoro corrispondente a un processo.

Nome Tipo Descrizione
kind string:

suspend

La discriminazione del tipo che descrive un sottotipo di JobMatchingMode.