Verwenden von CCaaS_GetRepresentativeAvailabilityBeforeConversation

Verwenden Sie CCaaS_GetRepresentativeAvailabilityBeforeConversation, um die Verfügbarkeit von Warteschlangen und Servicemitarbeitern zu erhalten, bevor die Unterhaltung beginnt.

Wenn Sie diese API beispielsweise aufrufen, um die Verfügbarkeit von Servicemitarbeitern zu überprüfen, zeigen Sie ein Chat-Widget nur dann auf Ihrer Website an, wenn relevante Warteschlangen innerhalb der Betriebszeiten liegen.

Verwenden Sie diese API, wenn externe Systeme die Verfügbarkeit von Servicemitarbeitern proaktiv abfragen müssen, und unterstützen Sie Vorgesetzte bei der Entscheidung über die Personaloptimierung für ihre Warteschlangen.

Anfragedetails

URL

/\<orgurl\>/api/data/v9.2/CCaaS\_ GetRepresentativeAvailabilityBeforeConversation

Methode

POST

Version

1.0

Anforderungsheader

Namen Beschreibung
Autorisierung Obligatorisch. Microsoft Entra ID Bearertoken für den API-Aufrufer in der Contact Center-Instanz. Weitere Informationen zum Setup-Token für die API-Autorisierung

Musteranforderung

Szenario Beispielcode
Überprüfen Sie die Verfügbarkeit eines Servicemitarbeiters für einen Arbeitsstream mit einer einzelnen Standardwarteschlange. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63" }'
Ermitteln der relevanten Warteschlangenverfügbarkeit für einen Arbeitsablauf, bei dem Kontextvariablen in Route-to-Queue-Regeln verwendet werden. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "cf21df54-6d64-4aea-b668-405b8aa42b07", "CustomContextItems": "{\"contextItem1\": {\"value\": \"contextItemValue1\", \"isDisplayable\": true, \"datatype\": \"DataType1\"}, \"contextItem2\": {\"value\": \"contextItemValue2\", \"isDisplayable\": true, \"datatype\": \"DataType2\"}}" }'
Kontextelemente hinzufügen oder außer Kraft setzen. Beispiel: Umfrage. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "CustomContextItems": "{\"Survey\": {\"value\": \"India\", \"isDisplayable\": true, \"datatype\": \"192350000\"}}" }'
Ermitteln Sie die Verfügbarkeit eines Dienstmitarbeiters, wenn eine Unterhaltung Regeln in Bezug auf die Einsatzkontext-Entität aufweist. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge",\n "msdyn_city": "florida"\n}"" '
Ermitteln der Verfügbarkeit von Dienstmitarbeitern, wenn Regeln sowohl über Kontextelemente als auch über den Einsatzkontext vorhanden sind curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityBeforeConversation \ --header 'Authorization: Bearer token' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "LiveWorkStreamId": "8a581641-291b-2002-5b86-55e0cfa0fc63", "ChannelEngagementContext": "{"msdyn_browser": "Edge", \n "msdyn_city": "florida"\n}", "CustomContextItems": "{\"contextItem1\": {\n \"value\": \"contextItemValue1\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType1\"\n },\"contextItem12\": {\n \"value\": \"contextItemValue2\",\n \"isDisplayable\": true,\n \"datatype\": \"DataType2\"\n }}" }'

Note

  • Im Anforderungstext ist CustomContextItems eine Zeichenfolge mit den Kontextelementen, die in Routen-in-die-Warteschlange-Regeln verwendet werden. Die Beispielliste der Kontextelemente:

    {
  "contextItemName1": {
    "value": "contextItemValue1",
    "isDisplayable": true,
    "datatype": "DataType1"
  },
  "contextItemName2": {
    "value": "contextItemValue2",
    "isDisplayable": true,
    "datatype": "DataType2"
  }
}

  • isDisplayable gibt an, ob das Kontextelement auf dem Bildschirm angezeigt wird. Dieser Wert ist "True" oder "False".

  • datatype kann nur Text = 192350000 oder integer = 192350001 sein

Antwort

Bei erfolgreicher Ausführung gibt die Methode den Antwortcode 200 OK zurück. Die Methode gibt auch die folgenden Statuscodes zurück.

HTTP-Status Beschreibung
400 Schlechte Anfrage (Falsche Eingabeparameter)
401 Nicht autorisiert
404 Ressource nicht gefunden
429 Rate-Limit (Zu viele Anfragen)
405 API nicht erlaubt
500 Interner Serverfehler

Antwortwerte

Bei erfolgreicher Ausführung gibt die Methode den Antwortcode 200 OK zurück. Die Methode gibt auch die folgenden Statuscodes zurück.

HTTP-Status Beschreibung
400 Schlechte Anfrage (Falsche Eingabeparameter)
401 Nicht autorisiert
404 Ressource nicht gefunden
429 Rate-Limit (Zu viele Anfragen)
405 API nicht erlaubt
500 Interner Serverfehler

Antwortwerte

Namen Typ Beschreibung
queueId String Die Zielwarteschlange, in der die Anforderung basierend auf Routingregelkonfigurationen und Eingabedaten wie Entitätswerten und Kontext weitergeleitet wird, die Teil der Routingregel sind.
isQueueAvailable Boolean Zeigt TRUE an, wenn die Warteschlange innerhalb der Betriebszeiten liegt. FALSE, wenn die Warteschlange außerhalb der Betriebszeiten liegt.
Startzeit der nächsten Betriebsstunde DateTime Die Startzeit (UTC) der Betriebsstunden für die Warteschlange, wenn sie sich derzeit außerhalb der Betriebszeiten befindet. Gibt 01-01-0001 während der Betriebszeiten zurück.
EndzeitDerNächstenBetriebsstunde DateTime Die Zeit (UTC), zu der die Betriebszeiten für die Warteschlange enden, falls sie sich derzeit außerhalb der Betriebszeiten befindet. Gibt 01-01-0001 während der Betriebszeiten zurück.
nächster Übergangszeitpunkt DateTime Die Zeit (UTC), zu der die Warteschlange wieder betriebsbereit ist, wenn sie außerhalb der Betriebszeiten liegt. Zeigt während der Betriebszeiten an, wann die Warteschlange nicht betriebsbereit wird.
positionInQueue Nummer Position in der Warteschlange für einen Kunden, der hinter anderen in derselben Warteschlange wartet.
isAgentAvailable Boolean Anzeigen:
  • TRUE, wenn die Dienstmitarbeiter in der Warteschlange derzeit verfügbar sind, um Anforderungen gemäß den Routing- und Zuweisungsregeln für den Arbeitsablauf zu bearbeiten.
  • FALSE, wenn Servicemitarbeiter nicht zur Verfügung stehen, um Anfragen zu übernehmen.
durchschnittliche Wartezeit Nummer Durchschnittliche Wartezeit in Minuten für Kunden in der Zielwarteschlange.
DurchschnittlicheWartezeitInSekunden Nummern Durchschnittliche Wartezeit in Sekunden für Kunden in der Zielwarteschlange.
AnzahlDerExpertenInDerWarteschlangeVerfügbar Nummern Die Anzahl der derzeit verfügbaren Servicemitarbeiter, um Konversationen in der Zielwarteschlange anzunehmen.

Beispielantwort

{  
"@odata.context": "https://<org-url>/api/data/v9.2/\$metadata#Microsoft.Dynamics.CRM.CCaaS_GetRepresentativeAvailabilityForConversationResponse",  
"NextTransitionTime": "9999-12-31T23:59:59Z",
"NumberOfExpertsAvailableInQueue": 5,
"AverageWaitTimeInSeconds": 45  
"PositionInQueue": 1,  
"AverageWaitTime": null,  
"StartTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"EndTimeOfNextOperatingHour": "0001-01-01T00:00:00Z",  
"QueueId": "85e55877-f27a-e911-a81a-000d3a1ca610",  
"IsAgentAvailable": true,  
"IsQueueAvailable": true  
}

Verwenden repräsentativer Verfügbarkeits-APIs
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on