Job Router Operations - Get Job

Service:

Communication

API-versie:

2023-11-01

Hiermee haalt u een bestaande taak op id.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	URI van uw communicatieresource
jobId	path	True	string	Id van een taak.
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	RouterJob	De aanvraag is geslaagd. Kopteksten ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwacht foutbericht. Kopteksten x-ms-error-code: string

Voorbeelden

Retrieves an existing job by Id

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobMatchingModeKind	Discriminaties voor ondersteunde overeenkomende modustypen.
LabelOperator	Hierin worden ondersteunde bewerkingen voor labelwaarden beschreven.
QueueAndMatchMode	Beschrijft een overeenkomende modus waarbij het koppelen van werkrollen aan een taak automatisch wordt gestart nadat de taak in de wachtrij is geplaatst.
RouterJob	Een werkeenheid die moet worden gerouteerd
RouterJobAssignment	Toewijzingsdetails van een taak aan een werknemer.
RouterJobNote	Een notitie die is gekoppeld aan een taak.
RouterJobStatus	Beschrijft de verschillende statussen van een taak.
RouterWorkerSelector	Beschrijft een voorwaarde waaraan moet worden voldaan op basis van een set labels voor het selecteren van werkrollen.
RouterWorkerSelectorStatus	Beschrijft de status van een werkrolselector.
ScheduleAndSuspendMode	Beschrijft een overeenkomende modus die wordt gebruikt voor het plannen van taken die in de wachtrij moeten worden geplaatst op een later tijdstip. Op het opgegeven moment wordt het koppelen van een werknemer aan een taak niet automatisch gestart.
SuspendMode	Beschrijft een overeenkomende modus waarbij het koppelen van werkrollen aan een taak wordt onderbroken.

Azure.Core.Foundations.Error

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid.
innererror	Azure.Core.Foundations.InnerError	Een object met specifiekere informatie dan het huidige object over de fout.
message	string	Een door mensen leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Een object met specifiekere informatie over de fout. Volgens de Richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

JobMatchingModeKind

Discriminaties voor ondersteunde overeenkomende modustypen.

Name	Type	Description
queueAndMatch	string	Discriminatorwaarde voor QueueAndMatchMode.
scheduleAndSuspend	string	Discriminatorwaarde voor ScheduleAndSuspendMode.
suspend	string	Discriminator-waarde voor SuspendMode.

LabelOperator

Hierin worden ondersteunde bewerkingen voor labelwaarden beschreven.

Name	Type	Description
equal	string	Gelijke.
greaterThan	string	Groter dan.
greaterThanOrEqual	string	Groter dan of gelijk aan.
lessThan	string	Kleiner dan.
lessThanOrEqual	string	Kleiner dan of gelijk aan.
notEqual	string	Niet gelijk.

QueueAndMatchMode

Beschrijft een overeenkomende modus waarbij het koppelen van werkrollen aan een taak automatisch wordt gestart nadat de taak in de wachtrij is geplaatst.

Name	Type	Description
kind	string: queueAndMatch	De typediscriminator die een subtype van JobMatchingMode beschrijft.

RouterJob

Een werkeenheid die moet worden gerouteerd

Name	Type	Description
assignments	<string,  RouterJobAssignment>	Een verzameling van de toewijzingen van de taak. Sleutel is AssignmentId.
attachedWorkerSelectors	RouterWorkerSelector[]	Een verzameling werkrolselectors die zijn gekoppeld aan een classificatiebeleid, waaraan een werknemer moet voldoen om deze taak te kunnen verwerken.
channelId	string	De kanaal-id. bijvoorbeeld spraak, chat, enzovoort.
channelReference	string	Verwijzing naar een externe bovenliggende context, bijvoorbeeld oproep-id.
classificationPolicyId	string	Id van een classificatiebeleid dat wordt gebruikt voor het classificeren van deze taak.
dispositionCode	string	Redencode voor geannuleerde of gesloten taken.
enqueuedAt	string	Tijdstempel dat een taak in de wachtrij is geplaatst in UTC.
etag	string	De entiteitstag voor deze resource.
id	string	Id van een taak.
labels		Een set sleutel-waardeparen die kenmerken identificeren die door de regelengines worden gebruikt om beslissingen te nemen. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	Indien opgegeven, bepaalt hoe job matching wordt uitgevoerd. Standaardmodus: QueueAndMatchMode.
notes	RouterJobNote[]	Notities die zijn gekoppeld aan een taak, gesorteerd op tijdstempel.
priority	integer	Prioriteit van deze taak. De waarde moet tussen -100 en 100 zijn.
queueId	string	Id van een wachtrij waarvoor deze taak in de wachtrij staat.
requestedWorkerSelectors	RouterWorkerSelector[]	Een verzameling handmatig opgegeven werkrolkiezers waaraan een werkrol moet voldoen om deze taak te kunnen verwerken.
scheduledAt	string	Als dit is ingesteld, wordt de taak gepland om op een bepaald moment te worden ge enqueued.
status	RouterJobStatus	De status van de taak.
tags		Een set niet-identificerende kenmerken die aan deze taak zijn gekoppeld. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

RouterJobAssignment

Toewijzingsdetails van een taak aan een werknemer.

Name	Type	Description
assignedAt	string	Tijdstempel wanneer de taak is toegewezen aan een werkrol in UTC.
assignmentId	string	Id van een taaktoewijzing.
closedAt	string	Tijdstempel wanneer de taak is gemarkeerd als gesloten na voltooiing in UTC.
completedAt	string	Tijdstempel wanneer de taak is gemarkeerd als voltooid na toewijzing in UTC.
workerId	string	Id van de werkrol die is toegewezen aan de taak.

RouterJobNote

Een notitie die is gekoppeld aan een taak.

Name	Type	Description
addedAt	string	Het tijdstip waarop de notitie is toegevoegd in UTC. Indien niet opgegeven, wordt standaard ingesteld op de huidige tijd.
message	string	Het bericht in de notitie.

RouterJobStatus

Beschrijft de verschillende statussen van een taak.

Name	Type	Description
assigned	string	De taak is toegewezen aan een werkrol.
cancelled	string	De taak is geannuleerd.
classificationFailed	string	Het classificatieproces is mislukt voor de taak.
closed	string	De taak is gesloten door een werknemer.
completed	string	De taak is voltooid door een werkrol.
created	string	De taak is gemaakt.
pendingClassification	string	Taak wacht om te worden geclassificeerd.
pendingSchedule	string	De taak is gemaakt, maar is nog niet gepland.
queued	string	Taak is in de wachtrij geplaatst.
scheduleFailed	string	Taakplanning is mislukt.
scheduled	string	De taak is gepland.
waitingForActivation	string	De taak heeft een onderbroken status en wacht op een update.

RouterWorkerSelector

Beschrijft een voorwaarde waaraan moet worden voldaan op basis van een set labels voor het selecteren van werkrollen.

Name	Type	Description
expedite	boolean	Hiermee wordt een taak naar de voorzijde van de wachtrij gepusht zolang deze selector actief is.
expiresAfterSeconds	number	Beschrijft hoe lang deze labelkiezer in seconden geldig is.
expiresAt	string	Het tijdstip waarop deze werkrolkiezer verloopt in UTC.
key	string	De labelsleutel om een query op uit te voeren.
labelOperator	LabelOperator	Beschrijft hoe de waarde van het label wordt vergeleken met de waarde die is gedefinieerd in de werkrolkiezer.
status	RouterWorkerSelectorStatus	Status van de werkrolselector.
value		De waarde die moet worden vergeleken met de werkelijke labelwaarde met de opgegeven operator. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

RouterWorkerSelectorStatus

Beschrijft de status van een werkrolselector.

Name	Type	Description
active	string	Werkrolkiezer is geldig.
expired	string	Werkrolkiezer is ongeldig.

ScheduleAndSuspendMode

Beschrijft een overeenkomende modus die wordt gebruikt voor het plannen van taken die in de wachtrij moeten worden geplaatst op een later tijdstip. Op het opgegeven moment wordt het koppelen van een werknemer aan een taak niet automatisch gestart.

Name	Type	Description
kind	string: scheduleAndSuspend	De typediscriminator die een subtype van JobMatchingMode beschrijft.
scheduleAt	string	Aangevraagde planningstijd.

SuspendMode

Beschrijft een overeenkomende modus waarbij het koppelen van werkrollen aan een taak wordt onderbroken.

Name	Type	Description
kind	string: suspend	De typediscriminator die een subtype van JobMatchingMode beschrijft.