SparkTG

Documentation de Documentation de l'API

Documentation de l'API

v1.0Passe à la v2

Les API SparkTG passent à la v2

Ces pages décrivent l’API v1. Toutes les API SparkTG passent à l’API v2, avec des jetons d’API signés au lieu d’un identifiant et d’un mot de passe : utilisez la v2 partout où elle est disponible.

Passer à l’API v2

Documentation de l'API

Référence de l'API de téléphonie cloud SparkTG

Vue d'ensemblev1.0

API de téléphonie cloud SparkTG

Introduction

SparkTG est un fournisseur de services de téléphonie cloud. La téléphonie cloud est un service à la demande qui offre des fonctionnalités de téléphonie robustes et fiables aux organisations qui fournissent des produits et des services.

Accès réseau : Les fonctionnalités sont disponibles via le réseau et accessibles par des mécanismes standard. Les utilisateurs peuvent se connecter de n'importe où et contrôler leur service.

Mutualisation des ressources : Les ressources de télécommunications sont mutualisées pour servir plusieurs clients selon un modèle multi-locataire, avec des ressources physiques et virtuelles attribuées et réattribuées dynamiquement en fonction de la demande. Cela réduit le coût de développement d'un service de téléphonie propre et permet de ne payer que les ressources réellement utilisées.

Élasticité : Les ports de téléphonie peuvent être provisionnés de manière rapide et élastique, dans certains cas automatiquement, pour monter en charge rapidement et être libérés tout aussi vite pour réduire la capacité.

Service mesuré : Le système cloud contrôle et optimise automatiquement l'utilisation des ressources grâce à une capacité de mesure, avec un niveau d'abstraction adapté au type de service (par exemple, nombre d'appels entrants, d'appels sortants et d'appels indésirables). L'utilisation des ressources peut être surveillée, contrôlée et rapportée, ce qui garantit la transparence tant pour le fournisseur que pour le consommateur du service. Dans cette optique, SparkTG met à disposition des API pour la plupart de ses services, afin que les clients puissent les tester et les intégrer facilement dans leurs applications (web, de bureau ou mobiles).

Prérequis

Ce document s'adresse aux développeurs et suppose une connaissance de base de la plateforme de téléphonie cloud SparkTG. Le service d'API doit être provisionné au préalable par SparkTG pour chaque client avant que celui-ci puisse l'utiliser dans ses applications.

Envoi des en-têtes d'authentification de base : Nous proposons des API REST qui utilisent l'authentification de base. Vous devez envoyer vous-même les en-têtes d'authentification de base. Pour cela, vous devez transmettre une chaîne au format username:password.

Téléphonie cloud

Service de téléphonie à la demande offrant de manière fiable des fonctionnalités robustes aux organisations. Accédez aux fonctionnalités via le réseau, de n'importe où.

Mutualisation des ressources

Modèle multi-locataire avec allocation dynamique des ressources. Ne payez que ce que vous utilisez et réduisez vos coûts de développement interne.

Élasticité

Provisionnez automatiquement et rapidement des ports de téléphonie pour monter en charge, puis libérez-les aussitôt pour réduire la capacité selon vos besoins.

Service mesuré

Contrôle automatique des ressources avec fonctions de mesure. Suivez la consommation en toute transparence, pour le fournisseur comme pour le client.

Authentification de base

Nous utilisons des API REST avec authentification de base. Vous devez envoyer vous-même les en-têtes d'authentification de base. Pour cela, vous devez transmettre une chaîne au format username:password.

Format d'authentification:

username:password

Transmettez-le dans l'en-tête Authorization ou utilisez l'option -u de curl

Prérequis pour les développeurs

• Connaissance de base de la plateforme de téléphonie cloud SparkTG requise

• SparkTG doit activer à l'avance le service API pour chaque client

• API de type REST avec prise en charge de l'authentification de base

• Compatible avec les applications web, de bureau et mobiles

Premiers pas

1. Demander l'accès à l'API

Contactez SparkTG pour activer le service API sur votre compte client.

2. Obtenir vos identifiants

Recevez vos identifiants au format nom d'utilisateur:mot de passe pour l'authentification de base.

3. Choisir les API

Choisissez parmi la gestion des appels, les API agents, la messagerie et bien plus.

4. Intégrer

Utilisez les points de terminaison REST dans vos applications web, de bureau ou mobiles.

Catégories d'API disponibles

Gestion des agents

Connexion, statut, pauses et configuration des agents

Gestion des appels

Émission d'appels, transferts, planification et contrôle des appels

Messagerie et OTP

Services SMS et de vérification par OTP

Analytique

Historique des appels, rapports et données de tableau de bord

Événements en temps réel

Événements WebSocket et intégration de webhooks

Configuration

Paramètres de transfert et configuration du service