Brug CCaaS_GetRepresentativeAvailabilityBeforeConversation

Brug CCaaS_GetRepresentativeAvailabilityBeforeConversation til at få køen og tilgængeligheden af en tjenesterepræsentant, før samtalen starter.

Hvis du f.eks. kalder denne API for at bekræfte tilgængeligheden af en tjenesterepræsentant, skal du kun vise en chatwidget på dit websted, når relevante køer er inden for driftstimerne.

Brug denne API, når eksterne systemer har brug for proaktivt at forespørge servicemedarbejdernes tilgængelighed og hjælpe vejledere med at træffe beslutninger om bemandingsoptimering for deres køer.

Detaljer om anmodning

URL

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

Metode

POST

Version

1.0

Overskrifter til anmodning

Navn Beskrivelse
Tilladelse Obligatorisk. Microsoft Entra ID ihændehavertoken for API-kalderen i forekomsten af Kontaktcenter. Få mere at vide i Konfigurationstoken til API-godkendelse

Eksempelanmodning

Scenarie Eksempel på kode
Kontrollér tilgængeligheden af en tjenesterepræsentant for en workstream med en enkelt standardkø. 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" }'
Fastlæg relevant køtilgængelighed for en arbejdsstrøm, hvor kontekstvariabler bruges i regler for rute til kø. 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\"}}" }'
Tilføj eller tilsidesæt kontekstelementer. F.eks. undersøgelse. 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\"}}" }'
Bestem tilgængeligheden af en tjenesterepræsentant, når en samtale har regler for objektet aftalekontekst. 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}"" '
Fastlæg tilgængeligheden af en tjenesterepræsentant, når der er regler for både kontekstelementer og aftalekontekst 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

  • I anmodningens brødtekst CustomContextItems er en streng med kontekstelementer, der bruges i regler for rute til kø. Eksempellisten over kontekstelementer:

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

  • isDisplayable angiver, om kontekstelementet vises på skærmen. Denne værdi er enten True eller False.

  • datatype kan kun være Tekst = 192350000 eller Heltal = 192350001

Svar

Hvis det lykkes, returnerer denne metode en 200 OK-svarkode. Metoden returnerer også følgende statuskoder.

HTTP-status Beskrivelse
400 Dårlig anmodning (forkerte inputparametre)
401 Uautoriseret
404 Ressource ikke fundet
429 Hastighedsgrænse (For mange forespørgsler)
405 API ikke tilladt
500 Intern serverfejl

Responsværdier

Hvis det lykkes, returnerer denne metode en 200 OK-svarkode. Metoden returnerer også følgende statuskoder.

HTTP-status Beskrivelse
400 Dårlig anmodning (forkerte inputparametre)
401 Uautoriseret
404 Ressource ikke fundet
429 Hastighedsgrænse (For mange forespørgsler)
405 API ikke tilladt
500 Intern serverfejl

Responsværdier

Navn Type Beskrivelse
queueId String Destinationskøen, hvor anmodningen distribueres baseret på konfigurationer af distributionsregel og inputdata, f.eks. enhedsværdier og kontekst, der er en del af distributionsreglen.
erKøTilgængelig Boolean Viser TRUE, hvis køen er inden for driftstimerne. FALSE, hvis køen er uden for driftstimerne.
StartTimeOfNextOperatingHour DateTime Starttidspunktet (UTC) for driftstimer for køen, hvis den i øjeblikket er uden for driftstimerne. Returnerer 01-01-0001 i driftstimerne.
SluttidspunktForNæsteDriftstime DateTime Det klokkeslæt (UTC), hvor driftstimerne slutter for køen, hvis den i øjeblikket er uden for driftstimerne. Returnerer 01-01-0001 i driftstimerne.
næste overgangstid DateTime Det tidspunkt (UTC), hvor køen er i drift igen, hvis det er uden for åbningstiden. I driftstimerne vises, når køen ikke fungerer.
positionInQueue Antal Placer i kø for en kunde, der venter bag andre i samme kø.
erAgentTilgængelig Boolean Viser:
  • SAND, hvis tjenesterepræsentanter i køen i øjeblikket er tilgængelige til at tage anmodninger baseret på reglerne for routing og tildeling for workstream.
  • FALSE, hvis tjenesterepræsentanter ikke er tilgængelige til at tage anmodninger.
gennemsnitlig ventetid Antal Den gennemsnitlige ventetid i minutter for kunder i destinationskøen.
GennemsnitligVentetidISekunder Tal Den gennemsnitlige ventetid i sekunder for kunder i målkøen.
AntalEksperterTilgængeligeIVentekøen Tal Det antal tjenesterepræsentanter, der i øjeblikket er tilgængelige til at acceptere samtaler i destinationskøen.

Eksempelsvar

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

Brug repræsentative tilgængeligheds-API'er
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on