Documentation API

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 :

Chaque appel API doit inclure votre token API. Vous pouvez le générer depuis votre espace client dans Mon compte > Token API.

Méthode 1 : Header Authorization (recommandé)

Méthode 2 : Paramètre POST

En cas de token invalide, l'API retourne :

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ètres

Réponses

Exemple cURL

Raccourcir les liens du message

Avec lien_court=1, chaque URL http:// ou https:// présente dans le texte est remplacée par un lien court go6.fr. Chaque destinataire reçoit un code différent : les clics sont donc attribuables au numéro, et pas seulement comptés globalement.

Le SMS effectivement envoyé devient : Promo -20% : go6.fr/aB3xY9

• Le lien est créé automatiquement dans votre espace Liens courts, où vous retrouvez ses statistiques. Si un lien actif de votre compte pointe déjà sur la même URL, il est réutilisé plutôt que dupliqué.
• 3 URL au maximum sont raccourcies par message ; les suivantes sont laissées telles quelles.
• Seuls http:// et https:// sont pris en charge. Les autres schémas et les URL de plus de 2 048 caractères sont ignorés, sans erreur.
• Le raccourcissement ne bloque jamais l'envoi : s'il échoue, le SMS part avec l'URL d'origine.
• Un lien go6.fr occupe 13 caractères : le message raccourci est généralement plus court qu'avec l'URL d'origine.

Retourne le statut de livraison d'un SMS à partir de son identifiant (ID). Cet ID est retourné par l'endpoint d'envoi (réponse « Envoi OK ID:12345 »). Vous ne pouvez consulter que les messages envoyés depuis votre propre compte.

Paramètres

Valeurs possibles du champ statut

Réponse JSON — Succès

Réponse JSON — Erreur

Exemple cURL

Plutot que d'interroger /ApiSmsProStatut.php, configurez une URL de callback dans Mon compte > Webhooks. Des qu'un accuse de reception (DLR) arrive, SMSBoost envoie une requete POST signee a votre URL (HTTPS obligatoire). En cas d'echec, la livraison est re-essayee automatiquement (backoff : 1 min, 5 min, 30 min, 2 h, 6 h).

Corps de la requete (JSON)

Le champ statut prend les memes valeurs que l'endpoint Statut de livraison (delivre, non_delivre, …). Votre endpoint doit repondre avec un code HTTP 2xx ; tout autre code declenche un re-essai.

En-tetes de signature

Verification de la signature (PHP)

Plusieurs webhooks par compte

Un compte peut avoir jusqu'a 20 webhooks (par exemple un par magasin). Chaque statut est envoye a tous les webhooks actifs, chacun signe avec son propre secret. Un webhook qui recoit le statut d'un SMS qu'il ne connait pas doit simplement repondre 200.

Installer un webhook par l'API — POST /ApiSmsProWebhook.php

Votre application installe son webhook elle-meme quand le client saisit son token API : plus besoin de copier l'URL et le secret a la main. Parametres : api_key (ou en-tete Authorization: Bearer), action (installer par defaut, supprimer, lister), url (HTTPS), nom (optionnel, ex. le nom du magasin). installer est idempotent : la meme URL renvoie le meme webhook et le meme secret. lister ne renvoie jamais les secrets.

Erreurs : AUTH_FAILED, RATE_LIMITED, INVALID_PARAMS (URL refusee ou action inconnue), LIMIT_REACHED (20 webhooks deja configures), NOT_FOUND (supprimer : aucun webhook sur cette URL).

Soumet une campagne complète en un seul appel, au lieu de boucler sur /ApiSmsPro.php. La campagne est créée dans votre espace client et reste consultable dans Statistiques > Campagnes. Route marketing : la mention STOP est ajoutée automatiquement. Maximum 20 000 destinataires par appel.

Paramètres

Réponses

Toutes les réponses sont en JSON avec un champ status.

Conservez id_campagne : c'est la clé à passer à ApiSmsProCampagne.php pour suivre la délivrabilité. En mode simulation (simulation=1), la même structure est renvoyée avec "status": "simulation", id_campagne et id_liste à null, et credits_necessaires à la place de credits_debites : rien n'est envoyé, rien n'est débité. La réponse ajoute alors sans_valeur : un objet JSON {"CLE": nombre_de_contacts_sans_valeur, ...}, une entrée par balise de champ utilisée dans texte (toujours un objet, {} si aucune balise n'est utilisée).

Exemple cURL

Exemple avec champs personnalisés par contact

Exemple avec un filtre sur une liste

Renvoie les compteurs agrégés d'une campagne soumise via ApiSmsProMailing.php, sans avoir à interroger chaque message un par un.

Paramètres

Réponse JSON — Succès

Tant que tous les accusés de réception ne sont pas revenus, nb_delivres + nb_echecs + nb_en_attente = nb_destinataires. Seule exception connue : une campagne rejetée par la modération (premier mailing refusé) voit ses SMS supprimés sans que nb_destinataires soit recalculé — les trois compteurs renvoient alors 0 alors que nb_destinataires garde son volume d'origine.

Réponse JSON — Erreur

Une campagne appartenant à un autre compte renvoie la même réponse qu'un identifiant inexistant.

Exemple cURL

Retourne le nombre de crédits SMS Pro restants sur votre compte. C'est le seul endpoint qui retourne du JSON.

Paramètres

Réponse JSON — Succès

Réponse JSON — Erreur

Exemple cURL

Ajoute ou met à jour des contacts (et leurs champs personnalisés) dans une liste existante de votre compte, au fil de l'eau (après chaque passage en caisse, chaque commande...). Cet appel n'envoie aucun SMS, ne débite aucun crédit et ne passe pas par la modération : c'est uniquement de la donnée.

Mode « ajouter ou mettre à jour » uniquement : un contact absent de l'appel n'est pas touché. Un contact est identifié par son numéro mobile dans la liste, quelle que soit la forme sous laquelle il y a été enregistré (0612345678, 33612345678 ou 612345678) : il est alors mis à jour, pas créé en double. Un nouveau contact est enregistré au format 0612345678, comme depuis l'espace client. Un contact désabonné reste désabonné : ses champs et son nom sont mis à jour, mais il n'est jamais réabonné par cette API. Un numéro blacklisté est accepté et enregistré normalement, seulement signalé dans la réponse.

Paramètres

numero : mobile français, 06/07, 6/7, 336/337, +33 ou 0033, espaces, points et tirets acceptés (06.12.34.56.78). nom : texte, 60 caractères maximum après nettoyage (balises HTML retirées, sauts de ligne remplacés par une espace) ; absent ou null, il reste inchangé pour un contact existant (vide pour un nouveau) ; "" l'efface.

Une clé de champ inconnue, ou une valeur invalide pour le type du champ, refuse l'appel entier (tout ou rien) : rien n'est écrit. null ou "" efface la valeur existante, une clé absente la laisse inchangée. Formats : texte 255 caractères maximum ; nombre JSON ou chaîne avec virgule ou point ; date JJ/MM/AAAA, JJ-MM-AAAA ou AAAA-MM-JJ ; date et heure, les mêmes suivis de HH:MM, ou AAAA-MM-JJTHH:MM. Une même clé écrite deux fois à la casse près ("prenom" et "PRENOM") est acceptée si les deux valeurs sont identiques, refusée sinon.

Réponse JSON — Succès

Réponses

Exemple cURL — création de 2 contacts avec PRENOM et DATE_DERNIERE_COMMANDE

Exemple cURL — mise à jour de DATE_DERNIERE_COMMANDE après une commande

--data-urlencode encode le JSON : un & ou un + dans un nom ou une valeur arrive intact (avec -d, il couperait ou modifierait le paramètre).

Renvoie la liste des champs personnalisés définis sur votre compte (clé de balise, nom, type). Utile pour construire dynamiquement un mapping dans une intégration tierce (Zapier, Make, CRM...) sans coder vos clés en dur.

Paramètres

Réponse JSON — Succès

Réponses

Exemple cURL

Les numéros sont automatiquement normalisés au format international. Les caractères non numériques sont supprimés avant validation.

• PHP
• JavaScript
• Python