De functie CCaaS_GetRepresentativeAvailabilityBeforeConversation gebruiken

Gebruik de CCaaS_GetRepresentativeAvailabilityBeforeConversation om de beschikbaarheid van de wachtrij en servicevertegenwoordiger op te halen voordat het gesprek begint.

Als u deze API bijvoorbeeld aanroept om de beschikbaarheid van servicevertegenwoordigers te controleren, geeft u alleen een chatwidget op uw website weer wanneer relevante wachtrijen binnen kantooruren vallen.

Gebruik deze API wanneer externe systemen proactief de beschikbaarheid van servicevertegenwoordigers moeten opvragen en supervisors moeten helpen bij het nemen van beslissingen voor personeelsoptimalisatie voor hun wachtrijen.

Details van aanvraag

URL

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

Methode

POST

Version

1.0

Kopteksten voor aanvraag

Naam Beschrijving
Authorization Verplicht. Microsoft Entra ID bearer token voor de API-gebruiker in de Contact Center-instantie. Meer informatie in het installatietoken voor API-autorisatie

Voorbeeldaanvraag

Scenario Voorbeeldcode
Controleer de beschikbaarheid van servicevertegenwoordigers voor een workstream met één standaardwachtrij. 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" }'
Bepaal de relevante wachtrijbeschikbaarheid voor een werkstroom waarbij contextvariabelen worden gebruikt in regels voor route-naar-wachtrij. 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\"}}" }'
Contextitems toevoegen of overschrijven. Bijvoorbeeld enquête. 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\"}}" }'
Bepaal de beschikbaarheid van servicevertegenwoordigers wanneer een gesprek regels heeft met betrekking tot de betrokkenheidscontext. 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}"" '
Beschikbaarheid van servicevertegenwoordigers bepalen wanneer regels aanwezig zijn in zowel contextitems als betrokkenheidscontext 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

  • In de hoofdtekst van de aanvraag, CustomContextItems is een tekenreeks met de contextitems die worden gebruikt in route-naar-wachtrijregels. De voorbeeldlijst met contextitems:

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

  • isDisplayable geeft aan of het contextitem wordt weergegeven op het scherm. Deze waarde is Waar of Onwaar.

  • datatype mag alleen tekst = 192350000 of geheel getal = 192350001

Antwoord

Als dit lukt, retourneert deze methode een 200 OK-antwoordcode. De methode retourneert ook de volgende statuscodes.

HTTP-status Beschrijving
400 Slechte Request (Verkeerde invoerparameters)
401 Niet geautoriseerd
404 Bron niet gevonden
429 Tarieflimiet (Te veel verzoeken)
405 API niet toegestaan
500 Interne serverfout

Responswaarden

Als dit lukt, retourneert deze methode een 200 OK-antwoordcode. De methode retourneert ook de volgende statuscodes.

HTTP-status Beschrijving
400 Slechte Request (Verkeerde invoerparameters)
401 Niet geautoriseerd
404 Bron niet gevonden
429 Tarieflimiet (Te veel verzoeken)
405 API niet toegestaan
500 Interne serverfout

Responswaarden

Naam Typ Beschrijving
queueId Snaar / Touwtje De doelwachtrij waarin de aanvraag wordt gerouteerd op basis van routeringsregelconfiguraties en invoergegevens, zoals entiteitswaarden en context die deel uitmaken van de routeringsregel.
isQueueAvailable Boolean Geeft TRUE weer als de wachtrij binnen kantooruren valt. ONWAAR als de wachtrij buiten kantooruren valt.
StarttijdVanVolgendeBedrijfsuur Datum/tijd De begintijd (UTC) van de bedrijfsuren voor de wachtrij als deze zich momenteel buiten kantooruren bevindt. Retourneert 01-01-0001 tijdens bedrijfsuren.
EindtijdVanVolgendBedrijfsuur Datum/tijd De tijd (UTC) wanneer de kantooruren voor de wachtrij eindigen, als deze momenteel buiten kantooruren valt. Retourneert 01-01-0001 tijdens bedrijfsuren.
volgendeovergangstijd Datum/tijd De tijd (UTC) waarop de wachtrij weer operationeel is als deze buiten de openingstijden is. Tijdens kantooruren wordt weergegeven wanneer de wachtrij niet operationeel wordt.
positieInWachtrij Number Plaats in de wachtrij voor een klant die achter anderen in dezelfde wachtrij wacht.
isAgentBeschikbaar Boolean Weergegeven:
  • WAAR als servicemedewerkers in de wachtrij momenteel beschikbaar zijn om aanvragen aan te nemen op basis van de regels voor routering en toewijzing voor *workstream*.
  • ONWAAR als servicevertegenwoordigers niet beschikbaar zijn om aanvragen te nemen.
gemiddeldeWachttijd Number Gemiddelde wachttijd in minuten voor klanten in de beoogde wachtrij.
GemiddeldeWachttijdInSeconden Getallen Gemiddelde wachttijd in seconden voor klanten in de doelwachtrij.
AantalExpertsBeschikbaarInWachtrij Getallen Het aantal servicevertegenwoordigers dat momenteel beschikbaar is voor het accepteren van gesprekken in de doelwachtrij.

Voorbeeldrespons

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

Representatieve beschikbaarheids-API's gebruiken
CCaaS_GetRepresentativeBeschikbaarheidVoorGesprek

  • Last updated on