CCaaS_GetRepresentativeAvailabilityBeforeConversation käyttäminen

CCaaS_GetRepresentativeAvailabilityBeforeConversation avulla saat jonon ja palvelun edustajan saataville ennen keskustelun alkua.

Jos esimerkiksi kutsut tätä ohjelmointirajapintaa palvelun edustajan käytettävyyden varmistamiseksi, näytä keskustelupienoissovellus sivustossasi vain, kun tarvittavat jonot ovat käyttötunteina.

Käytä tätä ohjelmointirajapintaa, kun ulkoisten järjestelmien tulee ennakoivasti kysellä palvelun edustajan saatavuutta ja auttaa esimiehiä tekemään henkilöstön optimointipäätöksiä jonoihinsa.

Pyynnön tiedot

osoite

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

Menetelmä

POST

Versio

1.0

Pyynnön otsikot

Nimi Kuvaus
Valtuutus Pakollinen. Microsoft Entra ID API-soittajan haltijatunnus Contact Center -esiintymässä. Lisätietoja on artikkelissa API-valtuutuksen asennustunnus

Mallipyyntö

Skenaario Esimerkki koodista
Tarkista palveluedustajan saatavuus työvirtaa varten, jossa on yksi oletusjono. 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" }'
Määritä työsäilön asianmukainen jonon käytettävyys, kun kontekstimuuttujia käytetään reitistä jonoon -säännöissä. 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\"}}" }'
Kontekstikohteiden lisääminen tai ohittaminen. Esimerkiksi kysely. 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\"}}" }'
Määritä palvelun edustava käytettävyys, kun keskustelu sisältää sitoutumiskontekstin entiteettiä koskevia sääntöjä. 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}"" '
Palvelun edustavan käytettävyyden määrittäminen, kun käytössä on sääntöjä sekä kontekstikohteissa että osallistumisen kontekstissa 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 }}" }'

Muistio

  • Pyynnön runkona on merkkijono, CustomContextItems joka sisältää reitistä jonoon -säännöissä käytetyt kontekstikohteet. Esimerkki kontekstikohteista:

    {
      "contextItemName1": {
        "value": "contextItemValue1",
        "isDisplayable": true,
        "datatype": "DataType1"
      },
      "contextItemName2": {
        "value": "contextItemValue2",
        "isDisplayable": true,
        "datatype": "DataType2"
      }
    }
    
  • isDisplayable ilmaisee, näkyykö kontekstikohde näytössä. Tämä arvo on joko Tosi tai Epätosi.

  • datatype voi olla vain Teksti = 192350000 tai Kokonaisluku = 192350001

Vastaus

Jos tämä menetelmä onnistuu, se palauttaa 200 OK-vastauskoodin. -menetelmä palauttaa myös seuraavat tilakoodit.

HTTP-tila Kuvaus
400 Huono pyyntö (väärät syöteparametrit)
401 Luvaton
404 Resurssi ei löytynyt
429 Hintarajoitus (Liian monta pyyntöä)
405 API ei sallittu
500 Sisäisen palvelimen virhe

Vastausarvot

Jos tämä menetelmä onnistuu, se palauttaa 200 OK-vastauskoodin. -menetelmä palauttaa myös seuraavat tilakoodit.

HTTP-tila Kuvaus
400 Huono pyyntö (väärät syöteparametrit)
401 Luvaton
404 Resurssi ei löytynyt
429 Hintarajoitus (Liian monta pyyntöä)
405 API ei sallittu
500 Sisäisen palvelimen virhe

Vastausarvot

Nimi Tyyppi Kuvaus
queueId Merkkijono Kohdejonon, jossa pyyntö reititetään reitityssäännön määritysten ja syötetietojen, kuten entiteetin arvojen ja kontekstin, perusteella, jotka ovat osa reitityssääntöä.
OnkoJonoSaatavilla totuusarvo Näyttää arvon TRUE, jos jono on käyttötuntien sisällä. FALSE, jos jono on käyttötuntien ulkopuolella.
Seuraavan toimintatunnin aloitusaika DateTime Jonon käyttötuntien alkamisaika (UTC), jos se on tällä hetkellä käyttötuntien ulkopuolella. Palauttaa arvon 01-01-0001 käyttöaikana.
Seuraavan käyttötunnin päättymisaika DateTime Aika (UTC), kun käyttötunnit päättyvät jonossa, jos se on tällä hetkellä käyttötuntien ulkopuolella. Palauttaa arvon 01-01-0001 käyttöaikana.
seuraavasiirtymäaika DateTime Aika (UTC), jolloin jono on jälleen toiminnassa, jos se on aukioloaikojen ulkopuolella. Aukioloaikoina näytetään, milloin jono ei ole toiminnassa.
sijaintiJonossa Numero Sijoita jonoon asiakas, joka odottaa muiden takana samassa jonossa.
onkoAgenttiSaatavilla totuusarvo Näyttää:
  • TRUE, jos jonon palvelun edustajat ovat tällä hetkellä käytettävissä pyyntöjen vastaanottamiseen työvirran reititys- ja määrityssääntöjen perusteella.
  • FALSE, jos palvelun edustajat eivät ole käytettävissä pyyntöihin.
keskimääräinen odotusaika Numero Tavoitejonon asiakkaiden keskimääräinen odotusaika minuutteina.
KeskimääräinenOdotusaikaSekunneissa Numerot Tavoitejonon asiakkaiden keskimääräinen odotusaika sekunteina.
AsiakkaidenJonossaSaatavillaOlevienAsiantuntijoidenLukumäärä Numerot Kohdejonossa on tällä hetkellä käytettävissä olevien palveluedustajien määrä keskusteluiden vastaanottamiseen.

Mallivastaus

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

Käytä edustavia käytettävyysrajapintoja
CCaaS_GetRepresentativeAvailabilityForConversation