Usare CCaaS_GetRepresentativeAvailabilityBeforeConversation

Usa CCaaS_GetRepresentativeAvailabilityBeforeConversation per ottenere la disponibilità della coda e del rappresentante del servizio clienti prima dell'inizio della conversazione.

Ad esempio, chiamando questa API per verificare la disponibilità del rappresentante del servizio, visualizzare un widget di chat nel sito Web solo quando le code pertinenti sono entro l'orario operativo.

Usare questa API quando i sistemi esterni devono eseguire query proattivamente sulla disponibilità del rappresentante del servizio e aiutare i supervisori a prendere decisioni di ottimizzazione del personale per le code.

Dettagli della richiesta

URL

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

Method

POST

Versione

1.0

Header di richiesta

Nome Descrizione
Authorization Obbligatorio. Microsoft Entra ID token di connessione per il chiamante API nell'istanza del Centro contatti. Per altre informazioni, vedere Configurare il token per l'autorizzazione API

Esempio di richiesta

Scenario codice di esempio
Controllare la disponibilità del rappresentante del servizio per un flusso di lavoro con una singola coda predefinita. 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" }'
Determinare la disponibilità della coda pertinente per un flusso di lavoro in cui le variabili di contesto vengono usate nelle regole di instradamento verso la coda. 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\"}}" }'
Aggiungere o eseguire l'override degli elementi di contesto. Ad esempio, sondaggio. 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\"}}" }'
Determinare la disponibilità del rappresentante del servizio quando le conversazioni hanno regole relative all'entità del contesto di coinvolgimento. 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}"" '
Determinare la disponibilità del rappresentante del servizio quando le regole sono presenti sia sugli elementi di contesto che sul contesto di engagement 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

  • Nel corpo della richiesta, CustomContextItems è presente una stringa con gli elementi di contesto usati nelle regole route-to-queue. Elenco di esempi di elementi di contesto:

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

  • isDisplayable indica se l'elemento di contesto viene visualizzato sullo schermo. Questo valore è True o False.

  • datatype può essere solo Text = 192350000 o Integer = 192350001

risposta

In caso di esito positivo, questo metodo restituisce un codice di risposta 200 OK. Il metodo restituisce anche i codici di stato seguenti.

Stato HTTP Descrizione
400 Richiesta crollata (parametri di input errati)
401 Non autorizzata
404 Risorsa non trovata
429 Limite di frequenza (Troppe richieste)
405 API non consentita
500 Errore interno del server

Valori risposta

In caso di esito positivo, questo metodo restituisce un codice di risposta 200 OK. Il metodo restituisce anche i codici di stato seguenti.

Stato HTTP Descrizione
400 Richiesta crollata (parametri di input errati)
401 Non autorizzata
404 Risorsa non trovata
429 Limite di frequenza (Troppe richieste)
405 API non consentita
500 Errore interno del server

Valori risposta

Nome Tipo Descrizione
queueId string Coda di destinazione in cui la richiesta viene instradata in base alle configurazioni delle regole di routing e ai dati di input, ad esempio valori di entità e contesto che fanno parte della regola di routing.
isQueueAvailable Booleano Visualizza TRUE se la coda è entro l'orario di funzionamento. FALSE se la coda è al di fuori dell'orario operativo.
OraInizioProssimaOraOperativa DateTime Ora di inizio (UTC) dell'orario di funzionamento per la coda se è attualmente al di fuori dell'orario operativo. Restituisce 01-01-0001 durante l'orario di funzionamento.
EndTimeOfNextOperatingHour (OraFineProssimaOraOperativa) DateTime Ora (UTC) alla fine dell'orario di funzionamento per la coda, se è attualmente al di fuori dell'orario operativo. Restituisce 01-01-0001 durante l'orario di funzionamento.
prossimotempotrasizione DateTime L'ora (UTC) in cui la coda è di nuovo operativa se è al di fuori dell'orario di apertura. Durante l'orario di funzionamento, visualizza quando la coda diventa non operativa.
positionInQueue Number Posizione in coda per un cliente in attesa di altri nella stessa coda.
isAgentAvailable Booleano Visualizza:
  • TRUE se gli operatori nella coda sono attualmente disponibili per accettare richieste in base alle regole di instradamento e assegnazione per il workstream.
  • FALSE se i rappresentanti del servizio non sono disponibili per accettare richieste.
tempo medio di attesa Number Tempo medio di attesa in minuti per i clienti nella coda di destinazione.
TempoMedioAttesaInSecondi Numeri Tempo medio di attesa in secondi per i clienti nella coda di destinazione.
NumeroDiEspertiDisponibiliInCoda Numeri Numero di rappresentanti del servizio attualmente disponibili per accettare conversazioni nella coda di destinazione.

Risposta di esempio

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

Usare le API di disponibilità rappresentative
CCaaS_GetRepresentativeAvailabilityForConversation

  • Last updated on