Job Router Operations - Get Job

Tjänst:

Communication

API-version:

2023-11-01

Hämtar ett befintligt jobb efter ID.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Uri för din kommunikationsresurs
jobId	path	True	string	Id för ett jobb.
api-version	query	True	string	DEN API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	RouterJob	Begäran har slutförts. Sidhuvuden ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

AadOauth2Auth

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

Retrieves an existing job by Id

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
Azure.Core.Foundations.Error	Felobjektet.
Azure.Core.Foundations.ErrorResponse	Ett svar som innehåller felinformation.
Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobMatchingModeKind	Diskriminerande för matchningslägestyper som stöds.
LabelOperator	Beskriver åtgärder som stöds för etikettvärden.
QueueAndMatchMode	Beskriver ett matchande läge där matchande arbetare till ett jobb startas automatiskt efter att jobbet har placerats i kö.
RouterJob	En arbetsenhet som ska dirigeras
RouterJobAssignment	Tilldelningsinformation för ett jobb till en arbetare.
RouterJobNote	En anteckning som är kopplad till ett jobb.
RouterJobStatus	Beskriver de olika statusarna för ett jobb.
RouterWorkerSelector	Beskriver ett villkor som måste uppfyllas mot en uppsättning etiketter för val av arbetare.
RouterWorkerSelectorStatus	Beskriver statusen för en arbetarväljare.
ScheduleAndSuspendMode	Beskriver ett matchande läge som används för att schemalägga jobb som ska köas vid en framtida tidpunkt. Vid den angivna tidpunkten startar inte matchande arbetare till ett jobb automatiskt.
SuspendMode	Beskriver ett matchande läge där matchande arbetare till ett jobb pausas.

Azure.Core.Foundations.Error

Felobjektet.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
details	Azure.Core.Foundations.Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	Azure.Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

Azure.Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Felobjektet.

Azure.Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
innererror	Azure.Core.Foundations.InnerError	Inre fel.

JobMatchingModeKind

Diskriminerande för matchningslägestyper som stöds.

Name	Typ	Description
queueAndMatch	string	Diskriminerande värde för QueueAndMatchMode.
scheduleAndSuspend	string	Diskriminerande värde för ScheduleAndSuspendMode.
suspend	string	Diskriminerande värde för SuspendMode.

LabelOperator

Beskriver åtgärder som stöds för etikettvärden.

Name	Typ	Description
equal	string	Lika.
greaterThan	string	Större än.
greaterThanOrEqual	string	Större än eller lika med.
lessThan	string	Mindre än.
lessThanOrEqual	string	Mindre än eller lika med.
notEqual	string	Inte lika med.

QueueAndMatchMode

Beskriver ett matchande läge där matchande arbetare till ett jobb startas automatiskt efter att jobbet har placerats i kö.

Name	Typ	Description
kind	string: queueAndMatch	Typdiskriminering som beskriver en undertyp av JobMatchingMode.

RouterJob

En arbetsenhet som ska dirigeras

Name	Typ	Description
assignments	<string,  RouterJobAssignment>	En samling av tilldelningarna för jobbet. Nyckeln är AssignmentId.
attachedWorkerSelectors	RouterWorkerSelector[]	En samling arbetsväljare som är kopplade till en klassificeringsprincip, som en arbetare måste uppfylla för att kunna bearbeta det här jobbet.
channelId	string	Kanalidentifieraren. T.ex. röst, chatt osv.
channelReference	string	Referens till en extern överordnad kontext, t.ex. samtals-ID.
classificationPolicyId	string	ID för en klassificeringsprincip som används för att klassificera det här jobbet.
dispositionCode	string	Orsakskod för avbrutna eller stängda jobb.
enqueuedAt	string	Tidsstämpeln för ett jobb köades i UTC.
etag	string	Entitetstaggen för den här resursen.
id	string	Id för ett jobb.
labels		En uppsättning nyckel/värde-par som identifierar attribut som används av regelmotorerna för att fatta beslut. Värden måste vara primitiva värden – tal, sträng, booleskt värde.
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	Om det tillhandahålls avgör du hur jobbmatchningen ska utföras. Standardläge: QueueAndMatchMode.
notes	RouterJobNote[]	Anteckningar som är kopplade till ett jobb, sorterade efter tidsstämpel.
priority	integer	Prioritet för det här jobbet. Värdet måste vara mellan -100 och 100.
queueId	string	ID för en kö som det här jobbet placeras i kö till.
requestedWorkerSelectors	RouterWorkerSelector[]	En samling manuellt angivna arbetarväljare, som en arbetare måste uppfylla för att kunna bearbeta det här jobbet.
scheduledAt	string	Om det anges schemaläggs jobbet så att det visas vid en viss tidpunkt.
status	RouterJobStatus	Jobbets status.
tags		En uppsättning icke-identifierande attribut som är kopplade till det här jobbet. Värden måste vara primitiva värden – tal, sträng, booleskt värde.

RouterJobAssignment

Tilldelningsinformation för ett jobb till en arbetare.

Name	Typ	Description
assignedAt	string	Tidsstämpel när jobbet tilldelades till en arbetare i UTC.
assignmentId	string	ID för en jobbtilldelning.
closedAt	string	Tidsstämpel när jobbet markerades som stängt efter att ha slutförts i UTC.
completedAt	string	Tidsstämpel när jobbet markerades som slutfört efter att ha tilldelats i UTC.
workerId	string	ID för arbetsuppgiften som tilldelats jobbet.

RouterJobNote

En anteckning som är kopplad till ett jobb.

Name	Typ	Description
addedAt	string	Tidpunkt då anteckningen lades till i UTC. Om det inte anges kommer den aktuella tiden att vara standard.
message	string	Meddelandet som finns i anteckningen.

RouterJobStatus

Beskriver de olika statusarna för ett jobb.

Name	Typ	Description
assigned	string	Jobbet har tilldelats till en arbetare.
cancelled	string	Jobbet har avbrutits.
classificationFailed	string	Klassificeringsprocessen misslyckades för jobbet.
closed	string	Jobbet har stängts av en arbetare.
completed	string	Jobbet har slutförts av en arbetare.
created	string	Jobbet har skapats.
pendingClassification	string	Jobbet väntar på att klassificeras.
pendingSchedule	string	Jobbet har skapats men har inte schemalagts ännu.
queued	string	Jobbet har placerats i kö.
scheduleFailed	string	Jobbschemaläggningen misslyckades.
scheduled	string	Jobbet har schemalagts.
waitingForActivation	string	Jobbet är i pausat tillstånd och väntar på en uppdatering.

RouterWorkerSelector

Beskriver ett villkor som måste uppfyllas mot en uppsättning etiketter för val av arbetare.

Name	Typ	Description
expedite	boolean	Push-överför ett jobb till köns framsida så länge väljaren är aktiv.
expiresAfterSeconds	number	Beskriver hur länge den här etikettväljaren är giltig i sekunder.
expiresAt	string	Tiden då den här arbetarväljaren upphör att gälla i UTC.
key	string	Etikettnyckeln som du vill köra frågor mot.
labelOperator	LabelOperator	Beskriver hur värdet för etiketten jämförs med det värde som definierats i arbetarväljaren.
status	RouterWorkerSelectorStatus	Status för arbetarväljaren.
value		Det värde som ska jämföras med det faktiska etikettvärdet med den angivna operatorn. Värden måste vara primitiva värden – tal, sträng, booleskt värde.

RouterWorkerSelectorStatus

Beskriver statusen för en arbetarväljare.

Name	Typ	Description
active	string	Arbetarväljaren är giltig.
expired	string	Arbetarväljaren är inte giltig.

ScheduleAndSuspendMode

Beskriver ett matchande läge som används för att schemalägga jobb som ska köas vid en framtida tidpunkt. Vid den angivna tidpunkten startar inte matchande arbetare till ett jobb automatiskt.

Name	Typ	Description
kind	string: scheduleAndSuspend	Typdiskriminering som beskriver en undertyp av JobMatchingMode.
scheduleAt	string	Begärd schematid.

SuspendMode

Beskriver ett matchande läge där matchande arbetare till ett jobb pausas.

Name	Typ	Description
kind	string: suspend	Typdiskriminering som beskriver en undertyp av JobMatchingMode.