CCaaS_GetRepresentativeAvailabilityForConversation

Verwenden Sie die CCaaS_GetRepresentativeAvailabilityForConversation-API , um die Verfügbarkeit von Warteschlangen- und Servicemitarbeitern während einer aktiven Unterhaltung mit einer gültigen Unterhaltungs-ID abzurufen.

Wenn beispielsweise ein Kunde, der mit einem IVR oder AI-Agent chattet, eine Eskalation an einen Servicemitarbeiter anfordert, ruft der KI-Agent diese API auf, um die Verfügbarkeit des Servicemitarbeiters zu ermitteln und die Unterhaltung basierend auf der Antwort weiterzuleiten.

Anfragedetails

URL

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

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

Beispiel für Anforderungstext

Beschreibung Beispielanforderung
Bestimmt die Warteschlangen- und Vertreterverfügbarkeit während einer aktiven Unterhaltung. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer token' \ --data '{ "ApiVersion": "1.0", "ConversationId": "2f2508bd-b58e-4982-b142-651e36dc8df3" }'
Ermitteln sie die Warteschlangen- und repräsentative Verfügbarkeit für eine Unterhaltung, bei der die Regeln für die Routen-zu-Warteschlange mehr Kontextelemente benötigen. curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer token' \ --data '{ "ApiVersion": "1.0", "ConversationId": "cf21df54-6d64-4aea-b668-405b8aa42b07", "CustomContextItems": "{\"contextItem1\": {\"value\": \"contextItemValue1\", \"isDisplayable\": true, \"datatype\": \"DataType1\"}, \"contextItem2\": {\"value\": \"contextItemValue2\", \"isDisplayable\": true, \"datatype\": \"DataType2\"}}" }'
Die Regel befindet sich in der Kontextelementumfrage (Typ: Text, Wert: Indien) curl --request POST \ --url https://<org-url>/api/data/v9.2/CCaaS_GetRepresentativeAvailabilityForConversation \ --header 'Authorization: Bearer <Token>' \ --header 'Content-Type: application/json' \ --data '{ "ApiVersion": "1.0", "ConversationId": "94c002c8-b14e-4a0e-8069-78dcf0d6c208", "CustomContextItems": "{\"Survey\": {\"value\": \"India\", \"isDisplayable\": true, \"datatype\": \"192350000\"}}" }'

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

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_GetRepresentativeAvailabilityBeforeConversation