Freigeben über


Job Router Operations - Get Job

Ruft einen vorhandenen Auftrag nach ID ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

URI Ihrer Kommunikationsressource

jobId
path True

string

ID eines Auftrags.

api-version
query True

string

Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name Typ Beschreibung
200 OK

RouterJob

Die Anforderung ist erfolgreich.

Header

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

Azure.Core.Foundations.ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name Beschreibung
https://communication.azure.com/.default

Beispiele

Retrieves an existing job by Id

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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"
}

Definitionen

Name Beschreibung
Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

JobMatchingModeKind

Diskriminatoren für unterstützte Übereinstimmungsmodustypen.

LabelOperator

Beschreibt unterstützte Vorgänge für Bezeichnungswerte.

QueueAndMatchMode

Beschreibt einen Abgleichsmodus, in dem übereinstimmende Mitarbeiter zu einem Auftrag automatisch gestartet werden, nachdem der Auftrag erfolgreich in die Warteschlange gestellt wurde.

RouterJob

Eine Arbeitseinheit, die weitergeleitet werden soll

RouterJobAssignment

Zuordnungsdetails eines Arbeitsplatzes an einen Mitarbeiter.

RouterJobNote

Eine an einen Auftrag angefügte Notiz.

RouterJobStatus

Beschreibt den verschiedenen Status eines Auftrags.

RouterWorkerSelector

Beschreibt eine Bedingung, die für eine Reihe von Bezeichnungen für die Arbeitsauswahl erfüllt werden muss.

RouterWorkerSelectorStatus

Beschreibt den Status einer Arbeitsauswahl.

ScheduleAndSuspendMode

Beschreibt einen Abgleichsmodus, der zum Planen von Aufträgen verwendet wird, die zu einem späteren Zeitpunkt in die Warteschlange gestellt werden. Zu dem angegebenen Zeitpunkt wird der Abgleich eines Mitarbeiters mit einem Auftrag nicht automatisch gestartet.

SuspendMode

Beschreibt einen Abgleichsmodus, in dem der Zuordnen eines Mitarbeiters zu einem Auftrag angehalten wird.

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

details

Azure.Core.Foundations.Error[]

Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.

innererror

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

message

string

Eine lesbare Darstellung des Fehlers.

target

string

Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name Typ Beschreibung
error

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Beschreibung
code

string

Eine serverdefinierte Gruppe von Fehlercodes.

innererror

Azure.Core.Foundations.InnerError

Innerer Fehler.

JobMatchingModeKind

Diskriminatoren für unterstützte Übereinstimmungsmodustypen.

Name Typ Beschreibung
queueAndMatch

string

Diskriminatorwert für QueueAndMatchMode.

scheduleAndSuspend

string

Diskriminatorwert für ScheduleAndSuspendMode.

suspend

string

Diskriminatorwert für SuspendMode.

LabelOperator

Beschreibt unterstützte Vorgänge für Bezeichnungswerte.

Name Typ Beschreibung
equal

string

Gleich.

greaterThan

string

Größer als.

greaterThanOrEqual

string

Größer oder gleich.

lessThan

string

Weniger als.

lessThanOrEqual

string

Kleiner oder gleich.

notEqual

string

Nicht gleich.

QueueAndMatchMode

Beschreibt einen Abgleichsmodus, in dem übereinstimmende Mitarbeiter zu einem Auftrag automatisch gestartet werden, nachdem der Auftrag erfolgreich in die Warteschlange gestellt wurde.

Name Typ Beschreibung
kind string:

queueAndMatch

Der Typdiskriminator, der einen Untertyp von JobMatchingMode beschreibt.

RouterJob

Eine Arbeitseinheit, die weitergeleitet werden soll

Name Typ Beschreibung
assignments

<string,  RouterJobAssignment>

Eine Sammlung der Aufgaben des Auftrags. Schlüssel ist AssignmentId.

attachedWorkerSelectors

RouterWorkerSelector[]

Eine Sammlung von Workerselektoren, die durch eine Klassifizierungsrichtlinie angefügt sind, die ein Arbeitnehmer erfüllen muss, um diesen Auftrag zu verarbeiten.

channelId

string

Der Kanalbezeichner. Zb. Sprache, Chat usw.

channelReference

string

Verweisen auf einen externen übergeordneten Kontext, z. B. Anruf-ID.

classificationPolicyId

string

ID einer Klassifizierungsrichtlinie, die zum Klassifizieren dieses Auftrags verwendet wird.

dispositionCode

string

Grundcode für abgebrochene oder geschlossene Aufträge.

enqueuedAt

string

Der Zeitstempel eines Auftrags wurde in UTC in die Warteschlange gestellt.

etag

string

Das Entitätstag für diese Ressource.

id

string

ID eines Auftrags.

labels

Eine Reihe von Schlüssel-Wert-Paaren, die Attribute identifizieren, die von den Regelmodulen verwendet werden, um Entscheidungen zu treffen. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

matchingMode JobMatchingMode:

Wenn angegeben, wird bestimmt, wie der Auftragsabgleich durchgeführt wird. Standardmodus: QueueAndMatchMode.

notes

RouterJobNote[]

An einen Auftrag angefügte Notizen, sortiert nach Zeitstempel.

priority

integer

Priorität dieses Auftrags. Der Wert muss zwischen -100 und 100 sein.

queueId

string

ID einer Warteschlange, an die dieser Auftrag in die Warteschlange gestellt wird.

requestedWorkerSelectors

RouterWorkerSelector[]

Eine Sammlung manuell angegebener Arbeitsauswahlen, die ein Arbeitnehmer erfüllen muss, um diesen Auftrag zu verarbeiten.

scheduledAt

string

Wenn festgelegt, wird der Auftrag so geplant, dass er zu einem bestimmten Zeitpunkt abgefragt wird.

status

RouterJobStatus

Der Status des Auftrags.

tags

Eine Reihe von nicht identifizierenden Attributen, die diesem Auftrag zugeordnet sind. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

RouterJobAssignment

Zuordnungsdetails eines Arbeitsplatzes an einen Mitarbeiter.

Name Typ Beschreibung
assignedAt

string

Zeitstempel, als der Auftrag einem Arbeiter in UTC zugewiesen wurde.

assignmentId

string

ID einer Auftragszuweisung.

closedAt

string

Zeitstempel, als der Auftrag nach Abschluss in UTC als geschlossen markiert wurde.

completedAt

string

Zeitstempel, als der Auftrag nach der Zuweisung in UTC als abgeschlossen markiert wurde.

workerId

string

ID des Workers, der dem Auftrag zugewiesen ist.

RouterJobNote

Eine an einen Auftrag angefügte Notiz.

Name Typ Beschreibung
addedAt

string

Die Uhrzeit, zu der die Notiz in UTC hinzugefügt wurde. Wenn nicht angegeben, wird standardmäßig die aktuelle Uhrzeit verwendet.

message

string

Die in der Notiz enthaltene Nachricht.

RouterJobStatus

Beschreibt den verschiedenen Status eines Auftrags.

Name Typ Beschreibung
assigned

string

Der Auftrag wurde einem Mitarbeiter zugewiesen.

cancelled

string

Der Auftrag wurde abgebrochen.

classificationFailed

string

Fehler beim Klassifizierungsprozess für den Auftrag.

closed

string

Der Auftrag wurde von einem Arbeitnehmer geschlossen.

completed

string

Der Auftrag wurde von einem Arbeiter abgeschlossen.

created

string

Auftrag wurde erstellt.

pendingClassification

string

Auftrag wartet darauf, klassifiziert zu werden.

pendingSchedule

string

Auftrag wurde erstellt, aber noch nicht geplant.

queued

string

Auftrag wurde in die Warteschlange gestellt.

scheduleFailed

string

Fehler bei der Auftragsplanung.

scheduled

string

Der Auftrag wurde erfolgreich geplant.

waitingForActivation

string

Auftrag befindet sich in einem angehaltenen Zustand und wartet auf ein Update.

RouterWorkerSelector

Beschreibt eine Bedingung, die für eine Reihe von Bezeichnungen für die Arbeitsauswahl erfüllt werden muss.

Name Typ Beschreibung
expedite

boolean

Verschiebt einen Auftrag an die Vorderseite der Warteschlange, solange diese Auswahl aktiv ist.

expiresAfterSeconds

number

Beschreibt, wie lange dieser Bezeichnungsmarkierer in Sekunden gültig ist.

expiresAt

string

Die Uhrzeit, zu der diese Arbeitsauswahl in UTC abläuft.

key

string

Der Bezeichnungsschlüssel, nach dem abgefragt werden soll.

labelOperator

LabelOperator

Beschreibt, wie der Wert der Beschriftung mit dem für die Arbeitsauswahl definierten Wert verglichen wird.

status

RouterWorkerSelectorStatus

Status der Arbeitsauswahl.

value

Der Wert, der mit dem tatsächlichen Beschriftungswert mit dem angegebenen Operator verglichen werden soll. Werte müssen primitive Werte sein – Zahl, Zeichenfolge, boolescher Wert.

RouterWorkerSelectorStatus

Beschreibt den Status einer Arbeitsauswahl.

Name Typ Beschreibung
active

string

Die Arbeitsauswahl ist gültig.

expired

string

Die Arbeitsauswahl ist ungültig.

ScheduleAndSuspendMode

Beschreibt einen Abgleichsmodus, der zum Planen von Aufträgen verwendet wird, die zu einem späteren Zeitpunkt in die Warteschlange gestellt werden. Zu dem angegebenen Zeitpunkt wird der Abgleich eines Mitarbeiters mit einem Auftrag nicht automatisch gestartet.

Name Typ Beschreibung
kind string:

scheduleAndSuspend

Der Typdiskriminator, der einen Untertyp von JobMatchingMode beschreibt.

scheduleAt

string

Angeforderte Zeitplanzeit.

SuspendMode

Beschreibt einen Abgleichsmodus, in dem der Zuordnen eines Mitarbeiters zu einem Auftrag angehalten wird.

Name Typ Beschreibung
kind string:

suspend

Der Typdiskriminator, der einen Untertyp von JobMatchingMode beschreibt.