Vai al contenuto principale

  Articolo aggiornato: 4 gennaio 2022

API delle metriche in tempo reale Sparkcentral

L'API Metrics in tempo reale ti consente di accedere direttamente alle metriche in tempo reale nella piattaforma Sparkcentral tramite un'API RESTful comoda e sicura. L'API fornisce ai clienti Sparkcentral un mezzo per integrarsi con i dashboard del contact center interni in combinazione con altri canali di comunicazione tradizionali e/o digitali come telefono, e-mail, live chat, ecc.

Utilizzo dell'API di metriche in tempo reale

Se stai creando software, puoi utilizzare l'API per coinvolgere i tuoi clienti:

  • Visualizzazione del tempo di attesa corrente per i clienti in un'applicazione mobile o sito Web.

Se sei un'azienda, puoi utilizzare l'API per semplificare i processi aziendali interni:

  • Visualizzazione del backlog corrente e delle metriche chiave sui canali digitali insieme ad altri supporti di contact center su dashboard in tempo reale mantenuti internamente.
  • Mantenere informati gli stakeholder interni segnalando le tendenze orarie delle statistiche di& backlog dei volumi su tutti i canali digitali, per indirizzare in modo efficiente gli agenti verso un altro canale in caso di picchi di volume.

Reti supportate

Sparkcentral si impegna a supportare la maggior parte delle reti di messaggistica sul mercato con la più ricca serie di funzionalità. Oggi puoi usare Sparkcentral per conversare su:

  • Facebook
  • Twitter
  • Instagram
  • Message Bird
  • Messaggistica in-app
  • WhatsApp
  • Twilio
  • WeChat
  • Pistola postale
  • Telegram
  • Viber

Per iniziare

L'accesso agli endpoint dei messaggi proattivi di Sparkcentral richiede delle chiavi di accesso. Per generare le chiavi, gli utenti con accesso a livello di amministratore possono accedere alle Impostazioni di amministrazione, espandere Integrazione e API e selezionare Chiavi API REST.

Autenticazione

L'API Real-Time Metrics (metriche in tempo reale) usa il flusso Client Credentials Grant della specifica Oauth 2.0 per l'autenticazione e l'autorizzazione del client. Ai client viene fornito un client_id e un client_secret per l'autenticazione con il server di autorizzazione di Sparkcentral e la ricezione di un access_token da utilizzare per l'autorizzazione della richiesta API. L'access_token deve essere utilizzato in un'intestazione di autorizzazione, ma può essere facoltativamente passato come parametro della stringa di query (vedere i dettagli richiesta/risposta più avanti in questo articolo). Quando l'access_token scade, l'API restituisce un messaggio 401 Non autorizzato. Il client può automatizzare questa operazione generando un nuovo token di accesso e ripetendo la richiesta non riuscita con il nuovo token di accesso, come documentato nella sezione successiva.

Concessione credenziali client

Recupera un access_token per effettuare richieste API autorizzate. Quando l'access_token scade, usa questo endpoint per generare un nuovo token.

Richiesta

Copia
Piattaforma USA: 
$ curl -X POST https://public-api.sparkcentral.com/oauth2/token -H 'content-type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials& client_id=your_client_id_here& client_secret=your_client_ SECRET_HERE& scope=client-read'
Piattaforma UE:
$ curl -X POST https://public-api-eu.sparkcentral.com/oauth2/token -H 'content-type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials& client_id=your_ CLIENT_ID_HERE& client_secret=Your_client_secret_here& scope=client-read'
Parametri, stato e descrizioni delle richieste
Parametro Stato Descrizione
grant_type necessario Deve essere impostato su client_credentials
client_id necessario Identificatore client fornito da Sparkcentral
client_secret necessario Sparkcentral ha fornito il segreto del cliente
scopo necessario Deve essere impostato su lettura client

Risposta

Copia
{ “token_type”: “bearer”, “access_token”: “a1b2c3d4e5f6”, “expires_in”: 43200 }
Parametri di risposta e descrizioni
Parametro Descrizione
token_type Il tipo di token da utilizzare nell'intestazione dell'autorizzazione. Questo sarà sempre al portatore della concessione delle credenziali del cliente.
access_token Il token utilizzato per autorizzare le richieste. Questo dovrebbe essere aggiunto alle richieste come intestazione di autorizzazione: Autorizzazione: Bearer a1b2c3d4e5f6. L'API accetterà anche access_token come parametro di stringa di query; tuttavia, utilizzare l'intestazione di autorizzazione è il metodo preferito.
expires_in Il numero di secondi fino alla scadenza del token (12 ore)

API dati

Volume messaggi in entrata

Un numero di messaggi in entrata basato sui filtri applicati.

URI di esempio:

GET /reporting-metrics/inbound-message-volume

Parametri URI

Parametri URI
   
da

string (richiesto)

Una data e ora ISO-8601 che segna l'inizio inclusivo del risultato. Deve essere codificato con URL. Il filtro da può essere di un massimo di 14 giorni nel passato.

a

string (opzionale)

Una data e ora ISO-8601 che segna la fine esclusiva del risultato. Deve essere codificato con URL. Se non viene fornito alcun filtro, i messaggi che sono stati inviati fino ad ora verranno inclusi.

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati da tutti i supporti collegati. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Raggruppa per intervallo

string (opzionale)

Intervallo per raggruppare i risultati per. Se non viene fornito GroupByInterval, verrà restituito il conteggio totale per i messaggi corrispondenti a questi filtri. Non è possibile richiedere più di 60 intervalli per richiesta. Ad esempio, quando si seleziona il minuto, l'intervallo di tempo richiesto non può essere superiore a 1 ora. Scelte: minuto ora al giorno

fuso orario

string (opzionale)

Il nome del fuso orario da utilizzare insieme a GroupByInterval, ad esempio America/Los_Angeles. Deve essere codificato con URL. Se non viene fornito alcun fuso orario, viene utilizzato il fuso orario "UTC" predefinito.

Volume messaggi in uscita

Un numero di messaggi in uscita basato sui filtri applicati.

URI di esempio:

GET /reporting-metrics/outbound-message-volume

Parametri URI

Parametri URI
   
da

string (richiesto)

Una data e ora ISO-8601 che segna l'inizio inclusivo del risultato. Deve essere codificato con URL. Il filtro da può essere di un massimo di 14 giorni nel passato.

a

string (opzionale)

Una data e ora ISO-8601 che segna la fine esclusiva del risultato. Se non viene fornito alcun filtro, i messaggi che sono stati inviati fino ad ora verranno inclusi.

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati a tutti i supporti collegati. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Raggruppa per intervallo

string (opzionale)

Intervallo per raggruppare i risultati per. Se non viene fornito GroupByInterval, verrà restituito il conteggio totale per i messaggi corrispondenti a questi filtri. Non è possibile richiedere più di 60 intervalli per richiesta. Ad esempio, quando si seleziona il minuto, l'intervallo di tempo richiesto non può essere superiore a 1 ora. Scelte: minuto ora al giorno

fuso orario

string (opzionale)

Il nome del fuso orario da utilizzare insieme a GroupByInterval. Deve essere codificato con URL. Se non viene fornito il fuso orario, viene utilizzato il fuso orario predefinito «UTC».

Tempo medio di prima risposta

Il tempo medio in secondi alla prima risposta a un messaggio in entrata.

URI di esempio:

GET /reporting-metrics/prima risposta

Parametri URI

Parametri URI
   
da

string (richiesto)

Una data e ora ISO-8601 che segna l'inizio inclusivo del risultato. Deve essere codificato con URL. Il filtro da può essere di un massimo di 14 giorni nel passato.

a

string (opzionale)

Una data e ora ISO-8601 che segna la fine del risultato. Deve essere codificato con URL. Solo i messaggi in entrata e le risposte inviate prima dell'ora attuale saranno inclusi nel calcolo medio del tempo di risposta della prima risposta. Se non viene fornito alcun filtro, i messaggi che sono stati inviati fino ad ora verranno inclusi.

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati in qualsiasi supporto collegato. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Risolto con risposta

Il numero di messaggi che sono stati risolti con almeno una risposta.

URI di esempio:

OTTIENI /reporting-metrics/risolve-con-one-reply

Parametri URI

Parametri URI
   
da

string (opzionale)

Una data e ora ISO-8601 che segna l'inizio inclusivo del risultato. Deve essere codificato con URL. Solo i messaggi in entrata e le risposte inviate dopo la data saranno inclusi nel calcolo Risolto con risposta. Se non viene fornito alcun filtro da, verranno inclusi i messaggi inviati da 5 giorni fa.

a

string (opzionale)

Una data e ora ISO-8601 che segna la fine esclusiva del risultato. Deve essere codificato con URL. Solo i messaggi in entrata e le risposte inviate prima dell'ora attuale saranno inclusi nel calcolo Risolto con risposta. Se non viene fornito alcun filtro, i messaggi che sono stati inviati fino ad ora verranno inclusi.

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati in qualsiasi supporto collegato. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

 

Tempo medio di maniglia

Il tempo medio in secondi in cui una conversazione viene gestita da un agente, in particolare la differenza tra i timestamp della conversazione aperta e la conversazione in sospeso e risoluzione della conversazione. Per calcolare il tempo medio della maniglia, è necessario che sia presente un evento aperto e in sospeso.

URI di esempio:

GET /reporting-metrics/handle-time

Parametri URI

Parametri URI
   
da

string (richiesto)

Una data e ora ISO-8601 che segna l'inizio inclusivo del risultato. Deve essere codificato con URL. Il filtro da può essere di un massimo di 14 giorni nel passato.

a

string (opzionale)

Una data e ora ISO-8601 che segna la fine esclusiva del risultato

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati in qualsiasi supporto collegato. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Disponibilità agente

Il numero di agenti disponibili o non disponibili.

URI di esempio:

OTTIENI /reporting-metrics/agent-availability

Parametri URI

Parametri URI
   
Stato di presenza utente

string (opzionale)

Stato dell'agente su cui filtrare. Si consiglia di fornire sempre UserPresenceStatus; il risultato sarà sempre 0 in caso contrario. Scelte: disponibili

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Contatti In attesa in coda

Il numero di contatti in attesa in coda per una risposta.

URI di esempio:

GET /queue-metrics/contacts-waiting

Parametri URI

Parametri URI
   
stato

string (richiesto)

Stato della coda su cui filtrare. Scelte: nuovo in sospeso

Medium ID

string (opzionale)

Filtra per identificatore medio. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati in qualsiasi supporto collegato. Scelte: fb twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Tempo di attesa più lungo in coda

Il tempo corrente più lungo in secondi in cui un contatto è in attesa di una risposta. Se non viene fornito alcun filtro MediuMid, verranno inclusi i messaggi inviati in qualsiasi supporto collegato.

URI di esempio:

GET /queue-metrics/tempo di attesa più lungo

Parametri URI

Parametri URI
   
stato

string (richiesto)

Stato della coda su cui filtrare Scelte: nuovo in sospeso

Medium ID

string (opzionale)

Filtra per identificatore medio Scelte: f b twit instagram messagebird rtm whatsapp twilio wechat pistola postale telegramma viber

ID canale

string (opzionale)

Filtra per identificatore di canale (per ottenere un elenco dei tuoi ID canale, contatta un rappresentante Sparkcentral). Se non viene fornito alcun filtro ChannelID, verranno inclusi i messaggi inviati da tutti i canali collegati.

Esempi

1. Mostrami il volume orario dei messaggi in arrivo per tutti i supporti

URI di esempio:

GET /reporting-metrics/inbound-message-volume

2. Mostrami il tempo di risposta medio corrente per un canale in un intervallo di 30 minuti

Se l'ora corrente è: 2017-06-22T 14:00:00 + 01:00; ChannelID is: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

URI di esempio:

GET /reporting-metrics/prima risposta

3. Mostrami il numero totale di contatti risolti con almeno una risposta per ieri su Twitter

URI di esempio:

OTTIENI /reporting-metrics/risolve-con-one-reply

4. Mostrami il tempo medio di gestione dell'ultima ora per un canale Twitter nel fuso orario PST

Se l'ora corrente è: 2017-06-22T 14:00:00-07:00; ChannelID è: 'efe3ca3a-9872-4ef2-9895-c948cadced29'

URI di esempio:

GET /reporting-metrics/handle-time

5. Mostrami il numero totale di contatti attualmente in attesa nella nuova coda per tutti i canali

URI di esempio:

GET /queue-metrics/contacts-waiting

 

Non riesci a trovare quello che stai cercando? Siamo qui per aiutarti