Documentation de Passer à l’API v2
Passer à l’API v2
Passer à l’API v2
Passer à l’API v2
Une authentification par jeton pour votre intégration existante
Votre intégration appelle l’API SparkTG sur /api/v1 en envoyant un identifiant et un mot de passe SparkTG à chaque requête. L’authentification de l’API passe à des jetons d’API signés, disponibles pour les mêmes endpoints sur /api/v2. Les endpoints, paramètres et réponses restent identiques : pour la plupart des intégrations, seuls l’URL de base et l’en-tête Authorization changent.
Pourquoi passer à la v2
Générer un jeton d’API
- 1Ouvrez Admin → Settings → API Access Tokens dans le tableau de bord SparkTG.
- 2Sous Generate a new token, choisissez où recevoir le mot de passe à usage unique (SMS, WhatsApp ou Email) et demandez-le.
- 3Saisissez l’OTP, ajoutez si vous le souhaitez un libellé (par exemple le nom de votre intégration) et générez le jeton.
- 4Copiez le jeton et conservez-le en lieu sûr. Il n’est affiché qu’une fois et reste valable un an.
C’est l’administrateur de votre service qui génère le jeton. Le même écran liste vos jetons et permet d’en révoquer un. Avant qu’un jeton n’expire, générez-en un nouveau et basculez votre intégration dessus.
Ce qui change
Les réponses réussies et les erreurs propres à chaque endpoint sont les mêmes qu’en v1. Chaque requête v2 est enregistrée pour la facturation de l’usage de l’API.
Exemples
curl -u '<username>:<password>' \
'https://telephonycloud.co.in/api/v1/calls?service-id=<SERVICE_ID>&number=9XXXXXXXXX&agent-id=<AGENT_ID>'curl -H 'Authorization: Bearer <YOUR_TOKEN>' \
'https://telephonycloud.co.in/api/v2/calls?number=9XXXXXXXXX&agent-id=<AGENT_ID>'Remplacez <YOUR_TOKEN> par votre jeton d’API
Erreurs de jeton
Le jeton est vérifié avant l’exécution de l’endpoint : toute requête v2 peut donc les renvoyer.
{"status":"error","code":401,"message":"invalid or missing JWT"}{"status":"error","code":401,"message":"token revoked or unknown"}{"status":"error","code":403,"message":"service inactive (svcId=<id>)"}{"status":"error","code":403,"message":"svc-id does not match token's service"}Endpoints v2
Ces API sont déjà disponibles en v2. Les autres API SparkTG passeront bientôt à la v2.
Passer un appel (v2)
Lancez un appel sortant ou planifié
Click to call (v2)
Demandes de rappel vérifiées par OTP
Supprimer des appels planifiés (v2)
Annulez des appels planifiés
Créer des appels planifiés par lot (v2)
Planifiez jusqu’à 500 appels en une requête
Envoyer un message WhatsApp (v2)
Envoyez un message depuis votre service
Récupérer le détail des appels en masse (v2)
Les enregistrements d’appels d’une période
Rapport de connexion / déconnexion (v2)
Heures de connexion et de déconnexion des agents
Lister les agents (v2)
Tous les agents du service du jeton
Mettre à jour un agent (v2)
Connexion, déconnexion, pauses et modifications du profil
Obtenir les pauses effectives (v2)
Statuts de pause utilisables par les agents, éventuellement pour un agent
Rapport CDR (v2)
Enregistrements détaillés des appels sur une période
Rapport de performance des agents (v2)
Nombre d'appels par agent et durées de conversation, de traitement, d'attente et de décrochage
Rapport brut de connexion / déconnexion (v2)
Chronologie des connexions et pauses, une ligne par segment de statut
Rapport récapitulatif de connexion / déconnexion (v2)
Durées d'inactivité, de conversation, de pause et de déconnexion par agent
Lister les services (v2)
Le service du jeton
Liste des DID LeadSquared (v2)
Les DID de l’intégration LeadSquared
