Bruk CCaaS_GetRepresentativeAvailabilityBeforeConversation

Bruk CCaaS_GetRepresentativeAvailabilityBeforeConversation for å få tilgjengeligheten til kø- og tjenesterepresentanten før samtalen starter.

Hvis du for eksempel kaller denne API-en for å bekrefte tjenesterepresentanttilgjengelighet, kan du vise et chat-kontrollprogram på nettstedet bare når relevante køer er innen driftstimer.

Bruk denne API-en når eksterne systemer må proaktivt spørre tjenesterepresentanttilgjengelighet og hjelpe veiledere med å ta beslutninger om bemanningsoptimalisering for køene sine.

Forespørselsdetaljer

URL

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

Metode

POST

Versjon

1.0

Forespørselshoder

Navn Beskrivelse
Autorisasjon Obligatorisk. Microsoft Entra ID bærertoken for API-innringeren i kontaktsenterforekomsten. Finn ut mer i installasjonstokenet for API-godkjenning

Eksempelforespørsel

Scenario Eksempel kode
Kontroller tjenesterepresentanttilgjengelighet for en arbeidsstrøm med én 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" }'
Fastslå relevant køtilgjengelighet for en arbeidsstrøm der kontekstvariabler brukes i rute-til-kø-regler. 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\"}}" }'
Legg til eller overstyr kontekstelementer. For eksempel undersøkelse. 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 tjenesterepresentanttilgjengelighet når en samtale har regler over kontekstenheten for engasjement. 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}"" '
Bestem tjenesterepresentanttilgjengelighet når regler finnes over både kontekstelementer og forhandlingskontekst 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 forespørselsteksten CustomContextItems er det en streng med kontekstelementene som brukes i rute-til-kø-regler. Eksempellisten over kontekstelementer:

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

  • isDisplayable angir om kontekstelementet vises på skjermen. Denne verdien er enten Sann eller Usann.

  • datatype kan bare være Tekst = 192350000 eller Heltall = 192350001

Svar

Hvis vellykket, returnerer denne metoden en svarkode på 200 OK. Metoden returnerer også følgende statuskoder.

HTTP-status Beskrivelse
400 Dårlig forespørsel (Feil inngangsparametere)
401 Uautorisert
404 Ressurs ikke funnet
429 Prisgrense (For mange forespørsler)
405 API er ikke tillatt
500 Intern serverfeil

Svarverdier

Hvis vellykket, returnerer denne metoden en svarkode på 200 OK. Metoden returnerer også følgende statuskoder.

HTTP-status Beskrivelse
400 Dårlig forespørsel (Feil inngangsparametere)
401 Uautorisert
404 Ressurs ikke funnet
429 Prisgrense (For mange forespørsler)
405 API er ikke tillatt
500 Intern serverfeil

Svarverdier

Navn Type Beskrivelse
queueId Streng Målkøen der forespørselen rutes basert på rutingregelkonfigurasjoner og inndata, for eksempel enhetsverdier og kontekst som er en del av rutingregelen.
isKøTilgjengelig boolsk Viser SANN hvis køen er innen driftstimer. FALSK hvis køen er utenfor åpningstidene.
StarttidspunktForNesteDriftstimen Date/klokkeslett Starttidspunktet (UTC) for driftstimer for køen hvis den for øyeblikket er utenfor arbeidstiden. Returnerer 01-01-0001 i driftstimer.
SlutttidenForNesteDriftstime Date/klokkeslett Klokkeslettet (UTC) når driftstimer avsluttes for køen, hvis det for øyeblikket er utenfor arbeidstiden. Returnerer 01-01-0001 i driftstimer.
neste overgangstid Date/klokkeslett Tidspunktet (UTC) når køen er i drift igjen hvis den er utenfor åpningstiden. I driftstiden vil det kun vises når køen blir uoperativ.
positionInQueue Nummer Plasser i kø for en kunde som venter bak andre i samme kø.
erAgentTilgjengelig boolsk Viser:
  • SANN hvis kundeservicerepresentanter i køen er tilgjengelige akkurat nå for forespørsler basert på ruting- og tildelingsreglene for arbeidsflyt.
  • false hvis tjenesterepresentanter ikke er tilgjengelige for å ta imot forespørsler.
gjennomsnittlig ventetid Nummer Gjennomsnittlig ventetid i minutter for kunder i målkøen.
GjennomsnittligVentetidISekunder Tall Gjennomsnittlig ventetid i sekunder for kunder i målkøen.
AntallEksperterTilgjengeligIKø Tall Antall tjenesterepresentanter som for øyeblikket er tilgjengelige for å godta samtaler i målkø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  
}

Bruk representative tilgjengelighets-API-er
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on