Job Router - Get Job

Referencia

Szolgáltatás:: Communication

API-verzió:: 2022-07-18-preview

Egy meglévő feladatot kér le azonosító alapján.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	Az Azure Communication-erőforrás végpontja.
id	path	True	string	A lekérni kívánt feladat azonosítója.
api-version	query	True	string	A meghívandó API verziója.

Válaszok

Name	Típus	Description
200 OK	RouterJob	Siker
Other Status Codes	CommunicationErrorResponse	Hiba

Példák

Get a single Job

Mintakérelem

HTTP

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

Mintaválasz

Állapotkód:: 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
  }
}

Definíciók

Name	Description
JobMatchingMode	A feladathoz alkalmazni kívánt megfelelő mód. Támogatott típusok: QueueAndMatchMode: Akkor használatos, ha a munkavégzőt közvetlenül a feladat várólistára helyezése után kell elvégezni. ScheduleAndSuspendMode: A feladatok későbbi várólistára helyezéséhez használatos. Adott időpontban a feldolgozó és a feladat egyeztetése nem indul el automatikusan. SuspendMode: Akkor használatos, ha a feldolgozóknak egy feladathoz való egyeztetését fel kell függeszteni.
JobMatchModeType	A támogatott egyező módtípusok megkülönböztetésére használt diszkriminatív érték.
LabelOperator	Azt ismerteti, hogyan hasonlítja össze a címke értékét a címkeválasztón definiált értékkel
RouterJob	Irányítandó munkaegység
RouterJobAssignment	Feladat hozzárendelési adatai egy feldolgozóhoz
RouterJobStatus	A feladat állapota.
RouterWorkerSelector	Olyan feltételt ír le, amelyet a munkavégzők kiválasztásához szükséges címkékkel kell teljesíteni
RouterWorkerSelectorStatus	A feldolgozóválasztó állapota.
ScheduleAndSuspendMode	A következő időpontban várólistára helyezett feladatok ütemezéséhez használt egyező módot ismerteti. A megadott időpontban a munkavégző feladathoz való egyeztetése nem indul el automatikusan.

JobMatchingMode

Objektum

A feladathoz alkalmazni kívánt megfelelő mód.

Támogatott típusok:

QueueAndMatchMode: Akkor használatos, ha a munkavégzőt közvetlenül a feladat várólistára helyezése után kell elvégezni. ScheduleAndSuspendMode: A feladatok későbbi várólistára helyezéséhez használatos. Adott időpontban a feldolgozó és a feladat egyeztetése nem indul el automatikusan. SuspendMode: Akkor használatos, ha a feldolgozóknak egy feladathoz való egyeztetését fel kell függeszteni.

Name	Típus	Description
modeType	JobMatchModeType	A támogatott egyező módtípusok megkülönböztetésére használt diszkriminatív érték.
queueAndMatchMode	object	Egy olyan egyező módot ismertet, amelyben a munkavégző feladathoz való egyeztetés automatikusan elindul a feladat sikeres várólistára helyezése után.
scheduleAndSuspendMode	ScheduleAndSuspendMode	A következő időpontban várólistára helyezett feladatok ütemezéséhez használt egyező módot ismerteti. A megadott időpontban a munkavégző feladathoz való egyeztetése nem indul el automatikusan.
suspendMode	object	Egy egyező módot ír le, amelyben a munkavégző feladathoz való egyeztetése fel van függesztve.

JobMatchModeType

Enumerálás

A támogatott egyező módtípusok megkülönböztetésére használt diszkriminatív érték.

Érték	Description
queueAndMatchMode
scheduleAndSuspendMode
suspendMode

LabelOperator

Enumerálás

Azt ismerteti, hogyan hasonlítja össze a címke értékét a címkeválasztón definiált értékkel

Érték	Description
equal
greaterThan
greaterThanEqual
lessThan
lessThanEqual
notEqual

RouterJob

Objektum

Irányítandó munkaegység

Name	Típus	Description
assignments	<string, RouterJobAssignment>	A feladat hozzárendeléseinek gyűjteménye. A kulcs a AssignmentId.
attachedWorkerSelectors	RouterWorkerSelector[]	Egy besorolási szabályzathoz csatolt címkeválasztók gyűjteménye, amelyet a feldolgozónak teljesítenie kell a feladat feldolgozásához.
channelId	string	A csatorna azonosítója. Pl.. hang, csevegés stb.
channelReference	string	Hivatkozás külső szülőkörnyezetre, pl. hívásazonosító.
classificationPolicyId	string	A feladat besorolásához használt besorolási szabályzat azonosítója.
dispositionCode	string	Megszakított vagy bezárt feladatok okkódja.
enqueuedAt	string (date-time)	A feladatok várólistára helyezésének időpontja UTC-ben.
id	string	A feladat azonosítója.
labels		Kulcs-érték párok készlete, amelyek azonosítják a szabálymotorok által a döntéshozatalhoz használt attribútumokat.
matchingMode	JobMatchingMode	A feladathoz alkalmazni kívánt megfelelő mód. Támogatott típusok: QueueAndMatchMode: Akkor használatos, ha a munkavégzőt közvetlenül a feladat várólistára helyezése után kell elvégezni. ScheduleAndSuspendMode: A feladatok későbbi várólistára helyezéséhez használatos. Adott időpontban a feldolgozó és a feladat egyeztetése nem indul el automatikusan. SuspendMode: Akkor használatos, ha a feldolgozóknak egy feladathoz való egyeztetését fel kell függeszteni.
notes	object	Feladatokhoz csatolt jegyzetek időbélyeg szerint rendezve
priority	integer (int32)	A feladat prioritása.
queueId	string	Annak az üzenetsornak az azonosítója, amelybe a feladat várólistára kerül.
requestedWorkerSelectors	RouterWorkerSelector[]	Manuálisan megadott címkeválasztók gyűjteménye, amelyeket a feldolgozónak teljesítenie kell a feladat feldolgozásához.
scheduledAt	string (date-time)	Ha be van állítva, a feladat ütemezetten lesz leküldve egy adott időpontban
status	RouterJobStatus	A feladat állapota.
tags		A feladathoz csatolt nem azonosító attribútumok készlete

RouterJobAssignment

Objektum

Feladat hozzárendelési adatai egy feldolgozóhoz

Name	Típus	Description
assignedAt	string (date-time)	A feladat hozzárendelési ideje UTC-ben.
assignmentId	string minLength: 1	A feladat-hozzárendelés azonosítója.
closedAt	string (date-time)	Az időpont, amikor a feladat lezárultként lett megjelölve, miután utc-ben befejeződött.
completedAt	string (date-time)	A feladat utc-beli hozzárendelés után befejezettként való megjelölésének időpontja.
workerId	string	A feladathoz rendelt feldolgozó azonosítója.

RouterJobStatus

Enumerálás

A feladat állapota.

Érték	Description
assigned
cancelled
classificationFailed
closed
completed
created
pendingClassification
pendingSchedule
queued
scheduleFailed
scheduled
waitingForActivation

RouterWorkerSelector

Objektum

Olyan feltételt ír le, amelyet a munkavégzők kiválasztásához szükséges címkékkel kell teljesíteni

Name	Típus	Description
expedite	boolean	Leküldi a feladatot az üzenetsor elejére, amíg ez a választó aktív.
expiresAfterSeconds	number (double)	Azt ismerteti, hogy a címkeválasztó mennyi ideig érvényes másodpercekben.
expiresAt	string (date-time)	Az időpont, amikor ez a feldolgozó-választó UTC-ben lejár
key	string minLength: 0 maxLength: 500	A lekérdezéshez tartozó címkekulcs
labelOperator	LabelOperator	Azt ismerteti, hogyan hasonlítja össze a címke értékét a címkeválasztón definiált értékkel
status	RouterWorkerSelectorStatus	A feldolgozóválasztó állapota.
value	object	A tényleges címkeérték és az adott operátor összehasonlítása

RouterWorkerSelectorStatus

Enumerálás

A feldolgozóválasztó állapota.

Érték	Description
active
expired

ScheduleAndSuspendMode

Objektum

A következő időpontban várólistára helyezett feladatok ütemezéséhez használt egyező módot ismerteti. A megadott időpontban a munkavégző feladathoz való egyeztetése nem indul el automatikusan.

Name	Típus	Description
scheduleAt	string (date-time)	Ütemezett idő.

Megosztás a következőn keresztül:

Job Router - Get Job

URI-paraméterek

Válaszok

Példák

Get a single Job

Mintakérelem

Mintaválasz

Definíciók

JobMatchingMode

JobMatchModeType

LabelOperator

RouterJob

RouterJobAssignment

RouterJobStatus

RouterWorkerSelector

RouterWorkerSelectorStatus

ScheduleAndSuspendMode