Contact Center AI Platform (CCAI Platform) fornisce una serie di endpoint API per supportare l'integrazione con la piattaforma. L'API Manager estende le funzionalità relative alle impostazioni e alla configurazione del sistema, nonché a eventi e attività.
Gli endpoint API di gestione rientrano in uno dei seguenti gruppi:
Agente: risorse per singoli agenti
Attività dell'agente: ogni volta che un widget dell'agente modifica lo stato dell'utente o riceve una notifica
Campagne: gli eventi associati al dialer in uscita
Chiamate: una singola risorsa di chiamata
Chat: una singola risorsa di chat
Email: una singola risorsa email
Menu: le code a cui sono assegnati gli agenti e a cui accedono gli utenti finali per ricevere assistenza da un agente.
Team: i team a cui appartiene un agente
Stato utente: i singoli stati in cui può trovarsi il widget dell'agente
Autenticazione di base
Le richieste utilizzano l'autenticazione di base. Per creare le credenziali API, segui questi passaggi:
Vai al portale della piattaforma CCAI.
Vai a Impostazioni > Impostazioni sviluppatore > Credenziali API.
Aggiungi nuove credenziali API e fornisci un nome.
Le credenziali per le chiamate API sono le seguenti:
Il sottodominio viene utilizzato come variabile
{username}.Il token viene utilizzato come variabile
{password}.
Ogni installazione ha il proprio sottodominio. Per trovare il sottodominio, individua l'URL nel browser. Dovrebbe avere un aspetto simile al seguente:
https://customer.uc1.ccaiplatform.com
Sostituisci il sottodominio (customer, in questo esempio) con la variabile \{subdomain\}. Sostituisci il resto dell'URL (rest.of.url.com, in questo
esempio) con la variabile \{domain\}.
URL di base
L'API utilizza il seguente URL di base per tutte le richieste API
https://{subdomain}.{domain}/apps/api/v1
dove un riferimento a /calls significa https://{subdomain}.{domain}/manager/api/v1/calls
Limitazioni di frequenza
Il sistema limita le richieste a una frequenza di 10 richieste al secondo per cliente.