Introduzione

La REST API di SIP Caller permette alle tue applicazioni di lavorare con il tuo account SIP Caller, così come fai tu dalla Console Web. Usala per collegare SIP Caller al tuo CRM, ERP, helpdesk o a qualsiasi sistema interno, e per automatizzare da cima a fondo le tue operazioni di chiamata in uscita.

Con l'API puoi:

• Gestire le campagne: creare, modificare, duplicare ed eliminare campagne, e avviarle, metterle in pausa o annullarle.
• Alimentare le campagne con numeri: aggiungere numeri uno alla volta o in blocco, con i valori delle variabili che i tuoi flussi di chiamata e agenti IA utilizzano per personalizzare ogni chiamata, oppure copiarli da un elenco di contatti.
• Mantenere sincronizzati i tuoi elenchi: gestire liste nere ed elenchi di contatti dai sistemi in cui risiedono quei dati.
• Leggere i risultati: ottenere i dettagli di ogni chiamata e di ogni numero di una campagna, per aggiornare i tuoi record con l'esito.

L'API è completata dai webhook, che notificano ai tuoi sistemi in tempo reale quando succede qualcosa in SIP Caller, ad esempio quando una campagna viene attivata o termina una chiamata. Insieme, ti permettono di creare integrazioni in cui le campagne vengono create, alimentate e monitorate senza lavoro manuale.

La REST API e i webhook sono disponibili nei piani Enterprise di SIP Caller. Consulta la pagina Prezzi per confrontare i piani e le loro funzionalità.

URL di base

Tutti gli endpoint descritti in questo riferimento sono disponibili al seguente URL di base:

https://api.sipcaller.com/v1

L'API è servita esclusivamente tramite HTTPS. La versione (v1) fa parte dell'URL, e qualsiasi modifica non retrocompatibile verrà rilasciata con una nuova versione, così la tua integrazione continua a funzionare senza cambiamenti.

Richieste e risposte

L'API segue le convenzioni REST:

• Le risorse sono identificate da URL, e le azioni sono espresse con i metodi HTTP standard: GET per leggere, POST per creare, PUT per modificare e DELETE per eliminare.
• I corpi delle richieste e delle risposte sono in JSON, codificati in UTF-8. Invia l'intestazione Content-Type: application/json con ogni richiesta che ha un corpo JSON.
• Le richieste riuscite restituiscono un codice di stato 2xx. Gli errori restituiscono un codice di stato 4xx o 5xx, con un corpo JSON che descrive il problema, come spiegato in Errori.
• Gli identificatori sono UUID (ad esempio 01a0dedd-b9a2-729d-8e0a-4e3ad9197aea), tranne per i numeri delle campagne, delle liste nere e degli elenchi di contatti, che sono identificati da numeri interi.
• Le date utilizzano il formato YYYY-MM-DD, e i timestamp utilizzano il formato ISO 8601 senza fuso orario (ad esempio 2026-09-26T17:57:48.064).

ID dell'account

Ogni endpoint si riferisce al tuo account SIP Caller, il cui ID fa parte dell'URL:

https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns

Puoi copiare l'ID del tuo account dalla Console Web, come mostrato di seguito.

Gli ID delle altre risorse, come le campagne, possono essere ottenuti dall'API stessa, oppure copiati dalla Console Web:

Per iniziare

1. Crea una API Key nella Console Web, con i ruoli di cui ha bisogno la tua integrazione.
2. Leggi come autenticare le tue richieste.
3. Prova l'endpoint Elencare le campagne per verificare che tutto funzioni.
4. Esplora il riferimento usando il menu a sinistra. Ogni endpoint include esempi pronti all'uso in cURL, Python, Java, Node.js e .NET: scegli il tuo linguaggio nel pannello del codice, e la tua scelta verrà ricordata in ogni pagina.

Negli esempi, sostituisci API_KEY_TOKEN, ACCOUNT_ID e gli altri segnaposto in maiuscolo con i tuoi valori.