Introduction

L’API REST de SIP Caller permet à vos propres applications de travailler avec votre compte SIP Caller, de la même manière que vous le faites depuis la Console Web. Utilisez-la pour connecter SIP Caller à votre CRM, votre ERP, votre outil de support ou tout système interne, et automatiser de bout en bout vos opérations d’appels sortants.

Avec l’API, vous pouvez :

• Gérer les campagnes : créer, modifier, dupliquer et supprimer des campagnes, et les démarrer, les mettre en pause ou les annuler.
• Alimenter les campagnes en numéros : ajouter des numéros un par un ou en masse, avec les valeurs de variables que vos flux d’appel et agents IA utilisent pour personnaliser chaque appel, ou les copier depuis une liste de contacts.
• Synchroniser vos listes : tenir à jour les listes noires et les listes de contacts depuis les systèmes où se trouvent ces données.
• Consulter les résultats : obtenir les détails de chaque appel et de chaque numéro d’une campagne, afin de mettre à jour vos propres enregistrements avec le résultat.

L’API est complétée par les webhooks, qui notifient vos systèmes en temps réel lorsqu’un événement se produit dans SIP Caller, par exemple lorsqu’une campagne est activée ou qu’un appel se termine. Ensemble, ils vous permettent de créer des intégrations où les campagnes sont créées, alimentées et suivies sans intervention manuelle.

L’API REST et les webhooks sont disponibles dans les plans Enterprise de SIP Caller. Consultez la page Prix pour comparer les plans et leurs fonctionnalités.

URL de base

Tous les points de terminaison décrits dans cette référence sont disponibles à l’URL de base suivante :

https://api.sipcaller.com/v1

L’API est servie uniquement en HTTPS. La version (v1) fait partie de l’URL, et toute modification non rétrocompatible sera publiée dans une nouvelle version, afin que votre intégration continue de fonctionner telle quelle.

Requêtes et réponses

L’API suit les conventions REST :

• Les ressources sont identifiées par des URL, et les actions sont exprimées avec les méthodes HTTP standard : GET pour lire, POST pour créer, PUT pour modifier et DELETE pour supprimer.
• Les corps des requêtes et des réponses sont en JSON, encodés en UTF-8. Envoyez l’en-tête Content-Type: application/json avec chaque requête comportant un corps JSON.
• Les requêtes réussies renvoient un code de statut 2xx. Les erreurs renvoient un code de statut 4xx ou 5xx, avec un corps JSON décrivant le problème, comme expliqué dans Erreurs.
• Les identifiants sont des UUID (par exemple 01a0dedd-b9a2-729d-8e0a-4e3ad9197aea), sauf pour les numéros des campagnes, des listes noires et des listes de contacts, qui sont identifiés par des entiers.
• Les dates utilisent le format YYYY-MM-DD, et les horodatages utilisent le format ISO 8601 sans fuseau horaire (par exemple 2026-09-26T17:57:48.064).

ID du compte

Chaque point de terminaison est rattaché à votre compte SIP Caller, dont l’ID fait partie de l’URL :

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

Vous pouvez copier l’ID de votre compte depuis la Console Web, comme indiqué ci-dessous.

Les ID des autres ressources, comme les campagnes, peuvent être obtenus via l’API elle-même, ou copiés depuis la Console Web :

Prise en main

1. Créez une clé API dans la Console Web, avec les rôles dont votre intégration a besoin.
2. Découvrez comment authentifier vos requêtes.
3. Essayez le point de terminaison Lister les campagnes pour vérifier que tout fonctionne.
4. Parcourez la référence à l’aide du menu de gauche. Chaque point de terminaison inclut des exemples prêts à l’emploi en cURL, Python, Java, Node.js et .NET : choisissez votre langage dans le panneau de code, et votre choix sera mémorisé sur toutes les pages.

Dans les exemples, remplacez API_KEY_TOKEN, ACCOUNT_ID et les autres valeurs en majuscules par vos propres valeurs.