Documentation API

Guide complet pour intégrer l'API PlexiSMS. Suivez ces étapes pour envoyer votre premier SMS en quelques minutes.
Version 1.0.0 • Base URL: https://server.plexisms.com

Démarrage Rapide

Avant de commencer, vous aurez besoin d'un compte PlexiSMS et d'une clé API. Suivez ce guide étape par étape.

Étape 1: Créer un compte

Inscrivez-vous sur PlexiSMS et complétez votre profil.

2. Authentification

Toutes les requêtes API doivent inclure votre token dans l'en-tête Authorization...

3. Envoyer un SMS

Endpoint principal pour envoyer des SMS. L'API gère automatiquement la concaténa...

2. Authentification

Toutes les requêtes API doivent inclure votre token dans l'en-tête Authorization.

Authentification Requise

Connectez-vous pour voir votre token API et tester les endpoints.

Important: Ne partagez jamais votre token. Ne l'exposez pas côté client (navigateur, applications mobiles). Utilisez-le uniquement côté serveur.

Bibliothèques & SDKs

Intégrez PlexiSMS dans votre application en quelques minutes avec nos bibliothèques officielles.

Python SDK

v1.0.1

pip install plexisms

Node.js SDK

v1.0.2

npm install plexisms

PHP SDK

v1.0.0

composer require plexisms/plexisms

Dart SDK

v1.0.0

dart pub add plexisms

C# .NET SDK

v1.0.0

dotnet add package Plexisms.Net

3. Envoyer un SMS

Endpoint principal pour envoyer des SMS. L'API gère automatiquement la concaténation des longs messages et l'encodage.

POSTPOST /api/sms/send/

curl -X POST https://api.plexisms.com/v1/sms/send \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+243970000000",
    "message": "Hello from PlexiSMS!",
    "sender_id": "MyApp",
    "sms_type": "transactional"
  }'

Paramètres (JSON)

Champ	Type	Requis	Description
phone_number	string	YES	Numéro au format international E.164 (ex: +243970000000)
message	string	YES	Contenu du SMS. Max 1600 caractères.
sender_id	string	NO	Identifiant expéditeur (3-11 car.). Optionnel, utilise le défaut du compte si omis.
sms_type	string	NO	Type de SMS: 'transactional' ou 'promotional'. Défaut: 'transactional'.

Exemple de Réponse (201 Created)

{
  "id": 123,
  "message_id": "msg_abc123",
  "status": "sent",
  "phone_number": "+243970000000",
  "sender_id": "MyApp",
  "parts": 1,
  "cost_usd": "0.05",
  "provider": "dream_digital",
  "balance": {
    "remaining_usd": "99.95",
    "remaining_sms": 1999
  }
}

4. Vérifier Votre Solde

Consultez votre solde disponible avant d'envoyer des campagnes.

GETGET /api/sms/balance/

Réponse JSON (200 OK)

{
  "amount": "100.00",
  "currency": "USD",
  "provider": "dream_digital"
}

Gestion des Erreurs

L'API utilise les codes HTTP standards. Voici les erreurs courantes:

Code HTTP	Description	Solution
401	Token manquant ou invalide	Vérifiez l'en-tête Authorization: Token
402	Solde insuffisant	Rechargez votre compte pour continuer
422	Données invalides (numéro, message, etc.)	Vérifiez le format de vos données (E.164 pour les numéros)
429	Limite de taux dépassée	Ralentissez vos requêtes (limite: 1000/jour par défaut)
500	Erreur serveur	Réessayez plus tard ou contactez le support

Prochaines Étapes

Envoi en Masse

Utilisez POST /api/sms/send-bulk/ pour envoyer à plusieurs destinataires

POST /api/sms/send-bulk/

Templates SMS

Créez des templates réutilisables avec GET/POST /api/sms/templates/

GET/POST /api/sms/templates/

Historique

Consultez l'historique de vos envois avec GET /api/sms/history/

GET /api/sms/history/

Dashboard Web

Gérez vos campagnes, consultez les statistiques et rechargez votre compte