Documentation API

Endpoints

Introduction

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 :

https://www.smsboost.com
2
Endpoints disponibles
POST
Méthode HTTP
login/pass
Authentification

Authentification

Toutes les requêtes nécessitent une authentification

Chaque appel API doit inclure vos identifiants de connexion (les mêmes que ceux utilisés pour vous connecter à votre espace client). En cas d'identifiants invalides, l'API retourne :

Mauvais Paramètres

Envoyer un SMS Pro

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ètres
Paramètre Type Description
login string requis Votre identifiant de connexion
password string requis Votre mot de passe
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éponses
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é.
Exemple cURL
curl -X POST https://www.smsboost.com/ApiSmsPro.php \ -d login=votre_login \ -d password=votre_mot_de_passe \ -d texte=Bonjour, votre commande est prête ! \ -d numero=0612345678 \ -d signature=MaBoutique

Consulter le solde SMS Pro

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ètres
Paramètre Type Description
login string requis Votre identifiant de connexion
password string requis Votre mot de passe
Réponse JSON — Succès
{ "status": "ok", "solde": 1500 }
Réponse JSON — Erreur
{ "status": "error", "message": "Mauvais Parametres" }
Exemple cURL
curl -X POST https://www.smsboost.com/ApiSmsProSolde.php \ -d login=votre_login \ -d password=votre_mot_de_passe

Format des numéros de téléphone

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

Exemples de code

Intégrez l'API dans votre langage préféré

<?php // Envoi d'un SMS Pro via l'API SMSBOOST $params = [ 'login' => 'votre_login', 'password' => 'votre_mot_de_passe', 'texte' => 'Bonjour, votre commande est prête !', 'numero' => '0612345678', 'signature' => 'MaBoutique', ]; $ch = curl_init('https://www.smsboost.com/ApiSmsPro.php'); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; // "Envoi OK" en cas de succès
// Envoi d'un SMS Pro via l'API SMSBOOST (Node.js / fetch) const params = new URLSearchParams({ login: 'votre_login', password: 'votre_mot_de_passe', texte: 'Bonjour, votre commande est prête !', numero: '0612345678', signature: 'MaBoutique', }); const response = await fetch('https://www.smsboost.com/ApiSmsPro.php', { method: 'POST', body: params, }); const result = await response.text(); console.log(result); // "Envoi OK" en cas de succès
# Envoi d'un SMS Pro via l'API SMSBOOST import requests response = requests.post('https://www.smsboost.com/ApiSmsPro.php', data={ 'login': 'votre_login', 'password': 'votre_mot_de_passe', 'texte': 'Bonjour, votre commande est prête !', 'numero': '0612345678', 'signature': 'MaBoutique', }) print(response.text) # "Envoi OK" en cas de succès