Documentation API

API Zomloa SMS

Intégrez l’envoi de SMS et le suivi de solde en quelques minutes. Endpoints clairs, exemples prêts à copier, réponses JSON prévisibles.

REST

API v1

<15s

OTP typique

HMAC

Webhooks signés

24/7

Support

+1 000

Développeurs & entreprises

I. Premiers pas

De zéro à votre premier SMS

Trois étapes pour brancher Zomloa SMS à votre application.

Base URL https://api.sms.zomloa.app

II. Endpoints & ressources

Ressources HTTP

Toutes les opérations acceptent POST ou GET. Préférez POST pour les données sensibles.

II.1 Opération d’envoi de SMS

GET/POSThttps://api.sms.zomloa.app/api/v1/gateway/sms/send

II.1.1 Requête

ParamètreType
X-Api-Keyobligatoire

Clé API (zs_live_…). Alternative : query/form api_key ou Authorization: ApiKey …

header
senderid

Identifiant expéditeur (max. 11 car.). Défaut : « FlowSMS ». Les SID personnalisés doivent être approuvés. Casse conservée.

string
smsobligatoire

Contenu du message (facturé par segment de 160 caractères).

string
mobilesobligatoire

Numéros séparés par des virgules. Préfixe "237" facultatif. Ex. : 237XXXXXXXXX,XXXXXXXXX

string
https://api.sms.zomloa.app/api/v1/gateway/sms/send
curl -X POST "https://api.sms.zomloa.app/api/v1/gateway/sms/send" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: zs_live_xxxxxxxx" \
  -d '{
    "senderid": "FlowSMS",
    "sms": "Votre code : 482913",
    "mobiles": "237670000000,670000001"
  }'

II.1.2 Réponse

ParamètreType
responsecode

"200" si succès.

string
responsedescription

Description du traitement.

string
organizationId

UUID de l’organisation.

string
senderid

Sender ID effectivement utilisé.

string
sms

Contenu envoyé.

string
mobiles

Destinataires.

string
balance

Solde SMS restant.

integer
application/json
{
  "responsecode": "200",
  "responsedescription": "Accepted",
  "organizationId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "senderid": "FlowSMS",
  "sms": "Votre code : 482913",
  "mobiles": "237670000000,670000001",
  "balance": 1017
}

II.2 Vérification du solde de SMS

GET/POSThttps://api.sms.zomloa.app/api/v1/gateway/sms/credit

II.2.1 Requête

ParamètreType
X-Api-Keyobligatoire

Clé API générée depuis votre compte Zomloa SMS.

header
https://api.sms.zomloa.app/api/v1/gateway/sms/credit
curl -X POST "https://api.sms.zomloa.app/api/v1/gateway/sms/credit" \
  -H "X-Api-Key: zs_live_xxxxxxxx"

II.2.2 Réponse

ParamètreType
responsecodeobligatoire

"200" si succès.

string
responsemessageobligatoire

Description de la requête.

string
organizationIdobligatoire

UUID de l’organisation.

string
creditobligatoire

Solde SMS disponible.

integer
packnameobligatoire

Dernier pack crédité, ou none.

string
application/json
{
  "responsecode": "200",
  "responsemessage": "Success",
  "organizationId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "credit": 1017,
  "packname": "Pack 3 000"
}

III. Gestion des erreurs

Codes & messages

En cas d’échec, la réponse JSON contient code, message, path et timestamp.

Codes d’erreur

  • ERR_INVALID_API_KEYClé API manquante ou invalide (HTTP 401)
  • ERR_VALIDATION_FAILEDParamètres invalides (HTTP 400)
  • ERR_INVALID_SENDER_IDFormat SID invalide (max 11, alphanumérique)
  • ERR_SENDER_ID_NOT_APPROVEDSID non approuvé pour cette organisation
  • ERR_INSUFFICIENT_SMS_BALANCESolde SMS insuffisant
  • ERR_FORBIDDENAccès refusé
  • ERR_INTERNAL_SERVER_ERRORErreur serveur inattendue (HTTP 500)

Messages d’erreur fréquents

  • API key is required
  • API key is invalid
  • Sender ID must be at most 11 characters
  • Sender ID is not approved for this organization
  • Insufficient SMS balance
  • Validation failed
application/json
{
  "code": "ERR_INVALID_API_KEY",
  "message": "API key is invalid",
  "path": "/api/v1/gateway/sms/send",
  "timestamp": "2026-07-25T18:00:00.000Z"
}

Prêt à intégrer Zomloa SMS ?

Créez un compte, générez votre clé et envoyez votre premier SMS en moins de 5 minutes.

Docs live · sms.zomloa.app

Commencez avec des SMS gratuits

SMS offerts pour tester l’API, packs volume et support — tout pour lancer sans friction.

Une seule API. Tous les opérateurs. Des SMS qui arrivent.