API REST pour l'envoi de SMS depuis vos applications
L'API SMS BOOST vous permet d'intégrer l'envoi de SMS directement dans vos applications, sites web ou logiciels. Tous les endpoints utilisent la méthode HTTP POST et sont accessibles à l'URL de base :
Toutes les requêtes nécessitent une authentification par token API
Chaque appel API doit inclure votre token API. Vous pouvez le générer depuis votre espace client dans Mon compte > Token API.
En cas de token invalide, l'API retourne :
POST /ApiSmsPro.php
Envoie un SMS Pro avec en-tête personnalisé. Le SMS est mis en file d'attente puis expédié immédiatement (ou à la date programmée). Débite 1 crédit SMS Pro.
| Paramètre | Type | Description | |
|---|---|---|---|
api_key |
string | requis | Votre token API (ou utilisez le header Authorization: Bearer). Voir Authentification |
texte |
string | requis | Contenu du SMS (160 caractères max) |
numero |
string | requis | Numéro de téléphone mobile du destinataire (format français) |
signature |
string | optionnel | Nom de l'expéditeur. Si absent, utilise l'en-tête par défaut de votre compte. |
date |
string | optionnel | Date d'envoi programmé au format YYYY-MM-DD HH:MM:SS |
route |
string | optionnel | Type de route : m = Marketing, sinon Transactionnel (par défaut). En mode Marketing, STOP #SMS# est ajouté automatiquement. |
pression_marketing |
integer | optionnel | Mettre à 1 pour activer le contrôle de pression marketing. Si le numéro a déjà reçu un SMS de votre compte récemment, l'envoi est refusé (aucun crédit débité). |
pression_jours |
integer | optionnel | Nombre de jours de recul pour la pression marketing (défaut : 30, min 1, max 365). Utilisé uniquement si pression_marketing=1. |
| Réponse | Signification |
|---|---|
| Envoi OK | SMS envoyé avec succès |
| Mauvais Paramètres | Identifiants invalides |
| Message vide | Le paramètre texte est vide |
| Credit insuffisant | Pas assez de crédits SMS Pro |
| Format de date invalide | Le format de date ne correspond pas à YYYY-MM-DD HH:MM:SS |
| Erreur sur le numéro | Le numéro de téléphone est invalide |
| EXCLUDED | Numéro exclu par pression marketing (déjà contacté récemment). Réponse JSON. Aucun crédit débité. |
POST /ApiSmsProSolde.php
Retourne le nombre de crédits SMS Pro restants sur votre compte. C'est le seul endpoint qui retourne du JSON.
| Paramètre | Type | Description | |
|---|---|---|---|
api_key |
string | requis | Votre token API (ou utilisez le header Authorization: Bearer). Voir Authentification |
Seuls les numéros mobiles français sont acceptés
Les numéros sont automatiquement normalisés au format international. Les caractères non numériques sont supprimés avant validation.
| Format accepté | Exemple | Normalisé en |
|---|---|---|
06XXXXXXXX |
0612345678 | 33612345678 |
07XXXXXXXX |
0712345678 | 33712345678 |
6XXXXXXXX |
612345678 | 33612345678 |
336XXXXXXXX |
33612345678 | 33612345678 |
Intégrez l'API dans votre langage préféré