Använd CCaaS_GetRepresentativeAvailabilityBeforeConversation

Använd CCaaS_GetRepresentativeAvailabilityBeforeConversation för att hämta tillgängligheten för köplatsen och tjänsterepresentanten innan konversationen startar.

Genom att till exempel anropa det här API:et för att verifiera tillgängligheten för tjänstrepresentanter visar du bara en chattwidget på din webbplats när relevanta köer är inom arbetstid.

Använd det här API:et när externa system proaktivt behöver fråga tjänstrepresentantens tillgänglighet och hjälpa övervakare att fatta beslut om bemanningsoptimering för sina köer.

Begär information

URL

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

Metod

POST

Version

1.0

Rubrik för begäran

Namn Beskrivning
Authorization Obligatorisk. Microsoft Entra ID autentiseringstoken för API-anroparen i kontaktcenterinstansen. Läs mer i Installationstoken för API-auktorisering

Exempelbegäran

Scenario Exempelkod
Kontrollera tillgängligheten för serviceansvariga i en arbetsström med en 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" }'
Fastställa relevant kötillgänglighet för en arbetsström där kontextvariabler används i regler för routning till 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\"}}" }'
Lägg till eller åsidosätt kontextobjekt. Till exempel undersökning. 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\"}}" }'
Fastställ tillgänglighet för tjänstrepresentanter när en konversation har regler över entiteten interaktionskontext. 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}"" '
Fastställa tjänstrepresentantens tillgänglighet när regler finns i både kontextobjekt och engagemangskontext 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 }}" }'

Anmärkning

  • I begärandetexten CustomContextItems är en sträng med de kontextobjekt som används i regler för routning till kö. Exempellistan över kontextobjekt:

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

  • isDisplayable anger om kontextobjektet visas på skärmen. Det här värdet är antingen Sant eller Falskt.

  • datatype kan bara vara Text = 192350000 eller Heltal = 192350001

Svar

Om det lyckas returnerar den här metoden en 200 OK-svarskod. Metoden returnerar också följande statuskoder.

HTTP-status Beskrivning
400 Dålig begäran (Fel inmatningsparametrar)
401 Unauthorized
404 Resurs ej hittad
429 Hastighetsgräns (För många förfrågningar)
405 API är inte tillåtet
500 Internt serverfel

Svarsvärden

Om det lyckas returnerar den här metoden en 200 OK-svarskod. Metoden returnerar också följande statuskoder.

HTTP-status Beskrivning
400 Dålig begäran (Fel inmatningsparametrar)
401 Unauthorized
404 Resurs ej hittad
429 Hastighetsgräns (För många förfrågningar)
405 API är inte tillåtet
500 Internt serverfel

Svarsvärden

Namn Type Beskrivning
queueId String Målkön där begäran dirigeras baserat på konfigurationer av routningsregel och indata, till exempel entitetsvärden och kontext som ingår i routningsregeln.
isQueueAvailable Boolesk Visar TRUE om kön är inom drifttimmar. FALSKT om kön är utanför drifttimmarna.
NästaDriftstimsStarttid Datum och tid Starttiden (UTC) för driftstimmar för kön om det för närvarande är utanför driftstimmarna. Returnerar 01-01-0001 under kontorstid.
EndTimeOfNextOperatingHour Datum och tid Tiden (UTC) när drifttimmarna slutar för kön, om det för närvarande är utanför de aktuella drifttimmarna. Returnerar 01-01-0001 under kontorstid.
nexttransitiontime Datum och tid Tiden (UTC) när kön är i drift igen om den är utanför arbetstid. Under drifttimmar visas det när kön blir icke-operativ.
positionInQueue Siffra Kundens position i kön bakom andra i samma kö.
ärAgentTillgänglig Boolesk Visar:
  • SANT om kundtjänstrepresentanter i kön för närvarande är tillgängliga för att ta emot begäranden baserat på dirigering- och tilldelningsreglerna för arbetsström.
  • FALSKT om tjänstrepresentanter inte är tillgängliga för att ta emot begäranden.
genomsnittlig väntetid Siffra Genomsnittlig väntetid i minuter för kunder i målkön.
GenomsnittligVäntetidIsekunder Numbers Genomsnittlig väntetid i sekunder för kunder i målkön.
AntalExperterTillgängligaIKön Numbers Antalet tjänstrepresentanter som för närvarande är tillgängliga för att acceptera konversationer i målkön.

Exempelsvar

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

Använda API:er för representativ tillgänglighet
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on