Delen via

Job Router Operations - Upsert Job

  • Referentie
Service:
Communication
API-versie:
2023-11-01

Hiermee maakt of werkt u een routertaak bij.

PATCH {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

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Media Types: "application/merge-patch+json"

Name Vereist Type Description
If-Match

string

De aanvraag mag alleen worden voortgezet als een entiteit overeenkomt met deze tekenreeks.
If-Unmodified-Since

string (date-time-rfc7231)

De aanvraag moet alleen worden voortgezet als de entiteit na deze tijd niet is gewijzigd.

Aanvraagbody

Media Types: "application/merge-patch+json"

Name Type Description
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.
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 JobMatchingModeCreateOrUpdate:

Indien opgegeven, bepaalt u hoe jobkoppeling wordt uitgevoerd. Standaardmodus: QueueAndMatchMode.
notes

RouterJobNote[]

Notities die zijn gekoppeld aan een taak, gesorteerd op tijdstempel.
priority

integer (int32)

Prioriteit van deze taak. De waarde moet tussen -100 en 100 zijn.
queueId

string

Id van een wachtrij waarnaar deze taak in de wachtrij staat.
requestedWorkerSelectors

RouterWorkerSelector[]

Een verzameling handmatig opgegeven werkrolkiezers waaraan een werkrol moet voldoen om deze taak te kunnen verwerken.
tags

Een set niet-identificerende kenmerken die aan deze taak zijn gekoppeld. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

Antwoorden

Name Type Description
200 OK

RouterJob

De aanvraag is voltooid.

Kopteksten

  • ETag: string
  • Last-Modified: string
201 Created

RouterJob

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Kopteksten

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

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

AadOauth2Auth

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

Creates a new job
Creates a new scheduled router job
Updates a router job

Creates a new job

Voorbeeldaanvraag

PATCH https://contoso.westus.communications.azure.com/routing/jobs/JobId?api-version=2023-11-01

{
  "channelId": "CustomChatChannel",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "queueId": "MainQueue",
  "priority": 5,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true
    }
  ],
  "labels": {},
  "matchingMode": {
    "kind": "queueAndMatch"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "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"
}
Statuscode:
201 
{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "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"
}

Creates a new scheduled router job

Voorbeeldaanvraag

PATCH https://contoso.westus.communications.azure.com/routing/jobs/JobId?api-version=2023-11-01

{
  "channelId": "CustomChatChannel",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "queueId": "MainQueue",
  "priority": 5,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true
    }
  ],
  "labels": {},
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  },
  "scheduledAt": null,
  "etag": "etag"
}
Statuscode:
201 
{
  "id": "JobId",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomChatChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "scheduleAndSuspend",
    "scheduleAt": "2023-05-26T23:22:12.0774222+00:00"
  },
  "scheduledAt": null,
  "etag": "etag"
}

Updates a router job

Voorbeeldaanvraag

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

{
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af"
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "383541b3-5637-4af6-8aac-3391da8a578a",
  "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"
}
Statuscode:
201 
{
  "id": "383541b3-5637-4af6-8aac-3391da8a578a",
  "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 meer specifieke 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

Discriminators voor ondersteunde typen overeenkomende modus.
LabelOperator

Beschrijft ondersteunde bewerkingen op labelwaarden.
QueueAndMatchMode

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

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

Toewijzingsgegevens van een taak aan een werknemer.
RouterJobCreateOrUpdate

Een werkeenheid die moet worden gerouteerd
RouterJobNote

Een notitie die is gekoppeld aan een taak.
RouterJobStatus

Beschrijft de verschillende status van een taak.
RouterWorkerSelector

Beschrijft een voorwaarde waaraan moet worden voldaan voor een set labels voor werkrolselectie.
RouterWorkerSelectorStatus

Beschrijft de status van een werkrolkiezer.
ScheduleAndSuspendMode

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

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

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

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

Azure.Core.Foundations.Error

Object

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 hebben geleid tot deze gemelde fout.
innererror

Azure.Core.Foundations.InnerError

Een object met meer specifieke informatie dan het huidige object over de fout.
message

string

Een leesbare weergave van de fout.
target

string

Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name Type Description
error

Azure.Core.Foundations.Error

Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke 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

Inventarisatie

Discriminators voor ondersteunde typen overeenkomende modus.

Waarde Description
queueAndMatch

Discriminatorwaarde voor QueueAndMatchMode.
scheduleAndSuspend

Discriminatorwaarde voor ScheduleAndSuspendMode.
suspend

Discriminatorwaarde voor SuspendMode.

LabelOperator

Inventarisatie

Beschrijft ondersteunde bewerkingen op labelwaarden.

Waarde Description
equal

Gelijk.
greaterThan

Groter dan.
greaterThanOrEqual

Groter dan of gelijk aan.
lessThan

Kleiner dan.
lessThanOrEqual

Kleiner dan of gelijk aan.
notEqual

Niet gelijk aan.

QueueAndMatchMode

Object

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

Het typediscriminator dat een subtype JobMatchingMode beschrijft.

QueueAndMatchModeCreateOrUpdate

Object

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

Het typediscriminator dat een subtype JobMatchingMode beschrijft.

RouterJob

Object

Een werkeenheid die moet worden gerouteerd

Name Type Description
assignments

<string,  RouterJobAssignment>

Een verzameling van de toewijzingen van de taak. De sleutel is AssignmentId.
attachedWorkerSelectors

RouterWorkerSelector[]

Een verzameling werkrolkiezers die zijn gekoppeld aan een classificatiebeleid waaraan een werkrol 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 (date-time)

Tijdstempel van een taak is in de wachtrij 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:

Indien opgegeven, bepaalt u hoe jobkoppeling wordt uitgevoerd. Standaardmodus: QueueAndMatchMode.
notes

RouterJobNote[]

Notities die zijn gekoppeld aan een taak, gesorteerd op tijdstempel.
priority

integer (int32)

Prioriteit van deze taak. De waarde moet tussen -100 en 100 zijn.
queueId

string

Id van een wachtrij waarnaar 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 (date-time)

Indien ingesteld, wordt de taak op een bepaald moment ingepland.
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

Object

Toewijzingsgegevens van een taak aan een werknemer.

Name Type Description
assignedAt

string (date-time)

Tijdstempel toen de taak in UTC aan een werkrol werd toegewezen.
assignmentId

string

Id van een taaktoewijzing.
closedAt

string (date-time)

Tijdstempel toen de taak werd gemarkeerd als gesloten nadat deze in UTC is voltooid.
completedAt

string (date-time)

Tijdstempel waarop de taak is gemarkeerd als voltooid nadat deze is toegewezen in UTC.
workerId

string

Id van de werkrol die aan de taak is toegewezen.

RouterJobCreateOrUpdate

Object

Een werkeenheid die moet worden gerouteerd

Name Type Description
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.
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 JobMatchingModeCreateOrUpdate:

Indien opgegeven, bepaalt u hoe jobkoppeling wordt uitgevoerd. Standaardmodus: QueueAndMatchMode.
notes

RouterJobNote[]

Notities die zijn gekoppeld aan een taak, gesorteerd op tijdstempel.
priority

integer (int32)

Prioriteit van deze taak. De waarde moet tussen -100 en 100 zijn.
queueId

string

Id van een wachtrij waarnaar deze taak in de wachtrij staat.
requestedWorkerSelectors

RouterWorkerSelector[]

Een verzameling handmatig opgegeven werkrolkiezers waaraan een werkrol moet voldoen om deze taak te kunnen verwerken.
tags

Een set niet-identificerende kenmerken die aan deze taak zijn gekoppeld. Waarden moeten primitieve waarden zijn: getal, tekenreeks, booleaanse waarde.

RouterJobNote

Object

Een notitie die is gekoppeld aan een taak.

Name Type Description
addedAt

string (date-time)

Het tijdstip waarop de notitie is toegevoegd in UTC. Als dit niet is opgegeven, wordt standaard de huidige tijd gebruikt.
message

string

Het bericht in de notitie.

RouterJobStatus

Inventarisatie

Beschrijft de verschillende status van een taak.

Waarde Description
assigned

De taak is toegewezen aan een werknemer.
cancelled

De taak is geannuleerd.
classificationFailed

Het classificatieproces is mislukt voor de taak.
closed

De baan is gesloten door een werknemer.
completed

De taak is voltooid door een werknemer.
created

De taak is gemaakt.
pendingClassification

De taak wacht om te worden geclassificeerd.
pendingSchedule

De taak is gemaakt, maar is nog niet gepland.
queued

De taak is in de wachtrij geplaatst.
scheduleFailed

Taakplanning is mislukt.
scheduled

De taak is gepland.
waitingForActivation

De taak heeft een onderbroken status en wacht op een update.

RouterWorkerSelector

Object

Beschrijft een voorwaarde waaraan moet worden voldaan voor een set labels voor werkrolselectie.

Name Type Description
expedite

boolean

Hiermee wordt een taak naar de voorzijde van de wachtrij gepusht zolang deze selector actief is.
expiresAfterSeconds

number (double)

Beschrijft hoe lang deze labelkiezer in seconden geldig is.
expiresAt

string (date-time)

Het tijdstip waarop deze werkrolkiezer in UTC verloopt.
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 werkrolkiezer.
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

Inventarisatie

Beschrijft de status van een werkrolkiezer.

Waarde Description
active

De werkrolkiezer is geldig.
expired

Werkrolkiezer is ongeldig.

ScheduleAndSuspendMode

Object

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

Name Type Description
kind string:

scheduleAndSuspend

Het typediscriminator dat een subtype JobMatchingMode beschrijft.
scheduleAt

string (date-time)

Aangevraagde planningstijd.

ScheduleAndSuspendModeCreateOrUpdate

Object

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

Name Type Description
kind string:

scheduleAndSuspend

Het typediscriminator dat een subtype JobMatchingMode beschrijft.
scheduleAt

string (date-time)

Aangevraagde planningstijd.

SuspendMode

Object

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

Name Type Description
kind string:

suspend

Het typediscriminator dat een subtype JobMatchingMode beschrijft.

SuspendModeCreateOrUpdate

Object

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

Name Type Description
kind string:

suspend

Het typediscriminator dat een subtype JobMatchingMode beschrijft.