Apprendre
Introduction
L’API SMSend envoie vos SMS et vous dit ce qu’est devenu chaque message.
C’est une API JSON sur HTTPS. Vous soumettez un lot de destinataires à un seul point de terminaison, et SMSend le tarife, réserve les fonds, achemine chaque message vers un opérateur et rapporte le résultat — soit à un webhook sur votre propre serveur, soit à un flux que vous interrogez.
Ce que vous pouvez faire
- Soumettre un lot pouvant aller jusqu’à 100 000 destinataires en une seule requête, avec des balises de fusion par destinataire et une planification optionnelle.
- Suivre chaque message de son acceptation jusqu’à un état terminal, par interrogation ou en recevant des webhooks signés.
- Lire les chiffres définitifs et soldés d’un lot — ce qui a été livré, ce qui a échoué et ce qui a été remboursé.
- Consulter le solde de votre portefeuille, lister les identifiants d’expéditeur que vous pouvez utiliser et gérer vos points de terminaison webhook.
La forme de l’API
Chaque point de terminaison vit sous une unique URL de base versionnée. La version fait partie du chemin, jamais d’un en-tête.
Les requêtes et les réponses sont en JSON. Les réponses réussies sont encapsulées dans un objet data ; les échecs le sont dans un objet error. Tous les identifiants sont des ULID de 26 caractères, tous les horodatages sont en ISO 8601 UTC, et tous les montants sont en XOF entiers.
Avant de commencer
Il vous faut un compte SMSend, une clé API dotée des bonnes portées et au moins un identifiant d’expéditeur approuvé et enregistré auprès d’un opérateur. Les clés se créent dans l’espace client — aucun point de terminaison n’en génère, car un point de terminaison public de création de clés transformerait une seule clé divulguée en accès permanent.