Le chiamate di richiamo sono chiamate richieste da un utente finale. Con l'API per le chiamate di richiamo, puoi programmare a livello di codice le chiamate di richiamo e annullare le chiamate programmate. Grazie a queste funzionalità, puoi creare applicazioni che consentono agli utenti finali di richiedere chiamate di richiamo da una coda che specifichi. Gli utenti finali possono anche annullare le chiamate che hanno programmato in precedenza. Per informazioni sull'autenticazione con l'API per le chiamate di richiamo, consulta Autenticazione di base.
Utilizzare l'API per le chiamate di richiamo
Puoi utilizzare l'API per le chiamate di richiamo per programmare le chiamate di richiamo e annullare le chiamate programmate.
Programmare una chiamata
Se la tua istanza è integrata con Salesforce, controlla l'impostazione Opzioni record chiusi quando si avvia una chiamata programmata tramite API in Impostazioni > Gestione delle operazioni > Dettagli creazione record CRM. Le richieste di programmazione vengono
rifiutate con 422 quando è selezionata l'opzione Non controllare lo stato del record. Questo non si applica a Zendesk o ServiceNow.
Per programmare una chiamata, chiama POST https://<subdomain>.<domain>/apps/api/v1/calls
e includi un corpo della richiesta simile al seguente:
{
"call_type": "ScheduledCall",
"menu_id": 12345,
"end_user_number": "+18005550100",
"scheduled_at": "2025-09-02T14:30:00Z"
}
Una richiesta riuscita restituisce un oggetto call, incluso l'ID della chiamata.
Annullare una chiamata programmata
Per annullare una chiamata programmata, chiama PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/{id}/cancel. Specifica l'ID della chiamata che vuoi annullare.
Una richiesta riuscita restituisce informazioni sulla chiamata annullata.
Annullare più chiamate programmate
Per annullare più chiamate programmate, chiama PATCH
https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel. Includi un corpo della richiesta contenente un array call_ids degli ID delle chiamate, come numeri interi, da annullare. Un valore che non è un array o che contiene una voce non intera viene rifiutato con 400.
Vedi l'esempio di codice che segue:
{
"call_ids": [123, 456, 789]
}
Una richiesta riuscita restituisce una risposta con un'intestazione della risposta che contiene un URL Location per controllare lo stato dell'annullamento.
Utilizzare le chiamate di richiamo con i CRM
Puoi utilizzare l'API per le chiamate di richiamo con le integrazioni CRM di Salesforce, Zendesk e ServiceNow.
Comportamento generale delle chiamate di richiamo
Se utilizzi un CRM supportato (Salesforce, Zendesk o ServiceNow), le seguenti condizioni influiscono sul comportamento delle chiamate di richiamo programmate:
Un record è aperto e ha già una chiamata programmata attiva: se una ricerca dell'ID del ticket indica che il record è aperto e ha già una chiamata programmata attiva, la chiamata non viene programmata. Al record CRM viene aggiunto il seguente commento:
A scheduled call was not created because the record already has an active scheduled call.Non è possibile raggiungere il CRM: se una ricerca dell'ID del ticket indica che non è possibile raggiungere il CRM, la chiamata viene annullata. Al record CRM viene aggiunto il seguente commento:
A scheduled call was canceled because the CRM was unreachable.
Comportamento delle chiamate di richiamo con i record chiusi
Il modo in cui vengono gestite le chiamate di richiamo per i record chiusi varia a seconda del CRM che utilizzi:
Utenti di Zendesk e ServiceNow: se una ricerca dell'ID del ticket indica che il record è chiuso, la chiamata non viene programmata. Al record CRM viene aggiunto il seguente commento:
A scheduled call was not created because the record is closed.Utenti di Salesforce: consulta Chiamate di richiamo con Salesforce per configurare il modo in cui la tua istanza gestisce le chiamate programmate per i record chiusi.
Chiamate di richiamo con Salesforce
Se hai integrato CCAI Platform con Salesforce, puoi configurare il modo in cui la tua istanza gestisce le chiamate programmate per i record chiusi. Di seguito sono riportate le opzioni di configurazione per le integrazioni di Salesforce:
Non controllare lo stato del record
Puoi configurare CCAI Platform in modo che non controlli lo stato del record prima di effettuare una chiamata programmata. Quando questa opzione è selezionata, le richieste di programmazione di una chiamata tramite l'API per le chiamate di richiamo vengono rifiutate con 422.
Per configurare CCAI Platform in modo che non controlli lo stato del record:
Nel portale di CCAI Platform, fai clic su Impostazioni > Gestione delle operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.
Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata programmata tramite API.
Seleziona Non controllare lo stato del record. Avvia sempre la chiamata programmata tramite API.
Fai clic su Salva generale.
Controllare lo stato del record e riaprire i record chiusi
Puoi configurare CCAI Platform in modo che controlli lo stato del record prima di effettuare una chiamata programmata e riapra i record chiusi. Con questa configurazione, se lo stato del record è chiuso, vengono eseguite le seguenti azioni:
La chiamata viene effettuata come programmato.
Il record viene riaperto.
Al record CRM viene aggiunto il seguente commento:
The record was reopened at the time of a scheduled call.
Per configurare CCAI Platform in modo che controlli lo stato del record e riapra i record chiusi:
Nel portale di CCAI Platform, fai clic su Impostazioni > Gestione delle operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.
Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata programmata tramite API.
Seleziona Controlla lo stato del record. Se il record è chiuso > Riapri il record.
Fai clic su Salva generale.
Controllare lo stato del record e annullare le chiamate programmate per i record chiusi
Puoi configurare CCAI Platform in modo che controlli lo stato del record prima di effettuare una chiamata programmata e annulli le chiamate programmate per i record chiusi. Con questa configurazione, se lo stato del record è chiuso, vengono eseguite le seguenti azioni:
La chiamata programmata viene annullata.
Al record CRM viene aggiunto il seguente commento:
A scheduled call was canceled because the record is closed.
Per configurare CCAI Platform in modo che controlli lo stato del record e annulli le chiamate programmate per i record chiusi:
Nel portale di CCAI Platform, fai clic su Impostazioni > Gestione delle operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.
Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata programmata tramite API.
Seleziona Controlla lo stato del record. Se il record è chiuso > Annulla la chiamata programmata.
Fai clic su Salva generale.