API di chiamata di callback

Le chiamate di callback sono chiamate richieste da un utente finale. Con l'API per le chiamate di richiamo, puoi pianificare in modo programmatico le chiamate di richiamo e annullare le chiamate pianificate. Con queste funzionalità, puoi creare applicazioni che consentono agli utenti finali di richiedere richiami da una coda specificata. Gli utenti finali possono anche annullare le chiamate che hanno pianificato in precedenza. Per informazioni sull'autenticazione con l'API di chiamata di callback, vedi Autenticazione di base.

Utilizzare l'API di chiamata di callback

Puoi utilizzare l'API di chiamata di callback per pianificare le chiamate di callback e annullare le chiamate pianificate.

Pianificare una chiamata

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": "[phone]",
    "scheduled_at": "2025-09-02T14:30:00Z"
}

Una richiesta riuscita restituisce un oggetto chiamata, incluso l'ID chiamata.

Annullare una chiamata pianificata

Per annullare una chiamata pianificata, chiama il numero 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 pianificate, chiama il numero PATCH https://<subdomain>.<domain>/apps/api/v1/calls/scheduled/cancel. Includi un corpo della richiesta che contenga un array call_ids degli ID chiamata per le chiamate da annullare.

Vedi il seguente esempio di codice:

{
    "call_ids": [123, 456, 789]
}

Una richiesta riuscita restituisce una risposta con un'intestazione di risposta che contiene un URL Location per controllare lo stato dell'annullamento.

Utilizzare le richiamate con i CRM

Puoi utilizzare l'API per le chiamate di richiamo con le integrazioni CRM di Salesforce, Zendesk e ServiceNow.

Comportamento generale del callback

Se utilizzi uno dei CRM supportati (Salesforce, Zendesk o ServiceNow), le seguenti condizioni influiscono sul comportamento del richiamo pianificato:

• Un record è aperto e ha già una chiamata programmata attiva: se una ricerca dell'ID ticket indica che il record è aperto e ha già una chiamata programmata attiva, la chiamata non viene programmata. Il seguente commento è allegato al record CRM: A scheduled call was not created because the record already has an active scheduled call.

• Impossibile raggiungere il CRM: se una ricerca dell'ID ticket indica che il CRM non è raggiungibile, la chiamata viene annullata. Il seguente commento è allegato al record CRM: A scheduled call was canceled because the CRM was unreachable.

Comportamento dei richiami con i record chiusi

Il modo in cui vengono gestite le richiamate per i record chiusi varia a seconda del CRM che utilizzi:

• Utenti di Zendesk e ServiceNow: se una ricerca dell'ID ticket indica che il record è chiuso, la chiamata non viene pianificata. Il seguente commento è allegato al record CRM: A scheduled call was not created because the record is closed.

• Utenti Salesforce:consulta Chiamate di richiamo con Salesforce per configurare il modo in cui la tua istanza gestisce le chiamate pianificate per i record chiusi.

Chiamate di richiamo con Salesforce

Se hai integrato la piattaforma CCAI con Salesforce, puoi configurare il modo in cui la tua istanza gestisce le chiamate pianificate per i record chiusi. Di seguito sono riportate le opzioni di configurazione per le integrazioni di Salesforce:

• Non controllare lo stato del record.

• Controlla lo stato del record e riapri i record chiusi.

• Controlla lo stato della registrazione e annulla le chiamate pianificate per le registrazioni chiuse.

Nota: la ricerca dell'ID ticket per il controllo dello stato del record avviene cinque minuti prima dell'inizio del conto alla rovescia della chiamata programmata. Il conto alla rovescia per la chiamata programmata è il numero di minuti che intercorrono tra il momento in cui una chiamata viene assegnata a un agente e il momento in cui inizia la chiamata programmata. Per saperne di più, consulta Configura le chiamate pianificate.

Non controllare lo stato del record

Puoi configurare CCAI Platform in modo che non controlli lo stato del record prima di effettuare una chiamata pianificata. Con questa configurazione, la chiamata viene effettuata come pianificato, indipendentemente dal fatto che il record sia aperto o chiuso.

Per configurare CCAI Platform in modo che non controlli lo stato del record, segui questi passaggi:

1. Nel portale della piattaforma CCAI, fai clic su Impostazioni > Gestione operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.

2. Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata pianificata tramite API.

3. Seleziona Non controllare lo stato del record. Inizia sempre la chiamata pianificata dell'API.

4. 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 pianificata 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.

• Il seguente commento è allegato al record CRM: The record was reopened at the time of a scheduled call.

Per configurare CCAI Platform in modo che controlli lo stato dei record e riapra quelli chiusi, segui questi passaggi:

1. Nel portale della piattaforma CCAI, fai clic su Impostazioni > Gestione operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.

2. Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata pianificata tramite API.

3. Seleziona Controlla lo stato della registrazione. Se il record è chiuso > riaprilo.

4. Fai clic su Salva generale.

Controllare lo stato del record e annullare le chiamate pianificate per i record chiusi

Puoi configurare CCAI Platform per controllare lo stato del record prima di effettuare una chiamata pianificata e annullare le chiamate pianificate per i record chiusi. Con questa configurazione, se lo stato del record è chiuso, si verificano le seguenti azioni:

• La chiamata pianificata è stata annullata.

• Il seguente commento è allegato al record CRM: A scheduled call was canceled because the record is closed.

Per configurare la piattaforma CCAI in modo che controlli lo stato del record e annulli le chiamate pianificate per i record chiusi, segui questi passaggi:

1. Nel portale della piattaforma CCAI, fai clic su Impostazioni > Gestione operazioni. Se non vedi il menu Impostazioni, fai clic su Menu.

2. Vai a Dettagli creazione record CRM > Opzioni record chiusi quando si avvia una chiamata pianificata tramite API.

3. Seleziona Controlla lo stato della registrazione. Se il record è chiuso > Annulla la chiamata programmata.

4. Fai clic su Salva generale.