Aller au contenu
e-MC

Développeurs

Une HTTP API (REST) et SMPP pour connecter vos systèmes à la plateforme e-MC, ainsi qu'une API Phone Number Checker. Les aperçus ci-dessous montrent leur structure avec des valeurs fictives ; l'URL de base, les identifiants et la documentation complète sont transmis lors de l'intégration.

  • HTTP API (REST)
  • SMPP
  • Rapports de livraison
  • API Phone Number Checker

API SMS (HTTP / REST)

L'API REST d'e-MC envoie vos SMS depuis votre serveur et en restitue le statut de livraison. Voici la structure d'un envoi, avec des valeurs fictives.

  • HTTP API. API REST en JSON, appelée depuis votre serveur.
  • Envoi de SMS. Un message à un destinataire, ou un lot vers plusieurs destinataires en une requête. Le solde du compte est consultable par l'API.
  • Authentification. Authentification HTTP Basic avec les identifiants fournis par e-MC. Sans identifiants valides, l'API répond 401.
  • Rapports de livraison. Statut d'un message (DELIVERED, UNDELIV, EXPIRED, PENDING), ou de 100 messages au maximum en une seule requête.
  • Gestion des erreurs. Codes HTTP explicites (par exemple 401, 404, 429 en cas de dépassement de la limite de débit, 503) et code d'erreur détaillé pour les échecs de livraison.
Envoyer un SMSHTTP
POST {{baseUrl}}/sms
Authorization: Basic YOUR_ENCODED_CREDENTIALS
Content-Type: application/json

{
  "from": "YOUR_SENDER_ID",
  "to": "229XXXXXXXXX",
  "content": "Your verification code is 482913"
}
RéponseJSON
HTTP 200

{
  "data": {
    "Success": "Please save this id",
    "messageId": "YOUR_MESSAGE_ID"
  }
}
Consulter le statut de livraisonHTTP
GET {{baseUrl}}/sms/YOUR_MESSAGE_ID/status
Authorization: Basic YOUR_ENCODED_CREDENTIALS

{
  "data": {
    "msgid": "YOUR_MESSAGE_ID",
    "status": "DELIVERED",
    "destination_addr": "229XXXXXXXXX",
    "created_at": "YYYY-MM-DD HH:MM:SS",
    "status_at": "YYYY-MM-DD HH:MM:SS"
  }
}

{{baseUrl}} — URL de base fournie par e-MC lors de l'intégration. Toutes les valeurs affichées sont fictives.

API Phone Number Checker (e-PNC)

L'API e-PNC valide un numéro de téléphone international et renvoie, en un seul appel, son pays, son opérateur et son type de ligne. Elle s'appelle depuis votre backend, par exemple avant d'envoyer un OTP.

  • Validité. Indique si le numéro est valide et mobile ; sinon, un motif : numéro invalide, ligne non mobile ou format illisible.
  • Pays. Code pays ISO et nom du pays.
  • Opérateur. Réseau de l'opérateur (MTN, Orange, Airtel…), ou unknown s'il n'est pas identifié.
  • Type de ligne. mobile, fixed_or_mobile, fixed_line, voip ou unknown.
  • Formats acceptés. E.164 (recommandé), préfixe 00 ou chiffres seuls avec l'indicatif pays ; les espaces sont ignorés.
  • Authentification et erreurs. Clé transmise dans l’en-tête x-api-key, appel depuis votre serveur uniquement. Codes HTTP 400, 401, 402 (crédit épuisé) et 429 (limite de débit).
Valider un numéroHTTP
POST {{baseUrl}}/[resource]
x-api-key: YOUR_API_KEY
Content-Type: application/json

{
  "phone": "+229XXXXXXXXX"
}
Réponse : numéro mobile valideJSON
HTTP 200

{
  "valid": true,
  "phone_e164": "+229XXXXXXXXX",
  "phone_local": "229XXXXXXXXX",
  "country_code": "BJ",
  "country": "Benin",
  "network": "MTN",
  "type": "mobile",
  "recommended_action": "proceed"
}
Réponse : numéro invalideJSON
HTTP 200

{
  "valid": false,
  "reason": "invalid_number"
}

{{baseUrl}} — URL de base fournie par e-MC. Le chemin de la ressource figure dans la documentation. Toutes les valeurs affichées sont fictives.

HTTP API ou SMPP ?

HTTP API (REST)

Pensée pour les applications web, mobiles et métiers : votre code appelle l'API au moment où un événement doit déclencher un SMS (inscription, paiement, alerte).

  • Envoi de SMS
  • Collecte des rapports de livraison
  • Vérification d'un numéro avec l'API e-PNC
  • Réception des SMS entrants

SMPP

Protocole standard de connexion système à système avec un centre de messages courts. Il s'adresse aux plateformes et aux systèmes de messagerie, aux entreprises qui disposent déjà d'une infrastructure SMPP et aux volumes importants.

  • Connexion système à système, pour plateformes et systèmes de messagerie
  • Intégration directe dans une infrastructure SMPP existante
  • Session continue avec notre SMSC, adaptée aux volumes importants

Illustration : maquette indicative, non contractuelle.

En un coup d'œil

CritèreHTTP API (REST)SMPP
ConnexionRequêtes HTTP émises par votre applicationSession continue de système à système
Usage typiqueApplications web, mobiles et métiers : OTP, alertes, notificationsPlateformes d'envoi, revendeurs, trafic important
Envoi de SMSOuiOui
Rapports de livraisonOuiOui
SMS entrantsOuiOui
Vérification de numéroOui, avec l'API e-PNCOui, avec l'API e-PNC
Compte et documentationFournis sur demandeFournis sur demande

Ce que permet l'intégration

  • Envoyer des SMS

    Par HTTP API (REST) ou par SMPP, vers l'Afrique et l'international.

  • Rapports de livraison

    Collectez le statut de chaque message.

  • Vérifier un numéro

    Avec l'API Phone Number Checker (e-PNC) : validité, pays, opérateur et type de ligne.

  • Recevoir des SMS

    Récupérez les SMS entrants de vos contacts.

Comment se déroule un envoi

  1. 1

    Votre système soumet le message

    Destinataire, expéditeur et texte, par HTTP API ou par SMPP.

  2. 2

    La plateforme le prend en charge

    e-MC choisit la route vers l'opérateur du destinataire selon le routage configuré.

  3. 3

    L'opérateur le délivre ou le refuse

    Chaque message reçoit un statut et, en cas d'échec, un code d'erreur.

  4. 4

    Vous récupérez le résultat

    Le statut arrive par rapport de livraison ; les réponses des destinataires remontent sous forme de SMS entrants.

Les aperçus de cette page sont volontairement simplifiés : les paramètres complets, les formats de réponse et les exemples de code figurent dans la documentation fournie avec le compte.

Accès et authentification

L'accès à la plateforme passe par un compte dédié, ouvert après échange avec notre équipe.

  • Un compte dédié

    Les comptes HTTP API et SMPP sont ouverts sur demande, en fonction de votre cas d'usage et de votre volume mensuel estimé.

  • Identifiants et documentation

    Vos identifiants de connexion et la documentation technique vous sont transmis à l'ouverture du compte. La méthode d'authentification y est détaillée.

  • Compte test

    Un test de l'API SMS peut être mis en place sur demande, avant le passage en production.

Statuts et codes d'erreur

Un message passe par plusieurs états avant d'être délivré ou rejeté. En cas d'échec, un code d'erreur en précise la cause. Extrait de la référence, actuellement en cours de relecture.

CodeGroupeNomDescription
0OKNO_ERRORNo Error
1HANDSET ERROREC_UNKNOWN_SUBSCRIBERUnknown Subscriber
5HANDSET ERROREC_UNIDENTIFIED_SUBSCRIBERUnidentified Subscriber
6HANDSET ERROREC_ABSENT_SUBSCRIBER_SMAbsent Subscriber
9HANDSET ERROREC_ILLEGAL_SUBSCRIBERIllegal Subscriber
10OPERATORS_ERRORSEC_BEARER_SERVICE_NOT_PROVISIONEDBearer Service Not Provisioned
Voir tous les codes

De l'aperçu à la production

  1. 1

    Parcourez l'aperçu

    Les exemples de cette page montrent la structure de nos APIs.

  2. 2

    Demandez la documentation

    Par le formulaire de contact, en décrivant votre cas d'usage.

  3. 3

    Qualification

    Nous validons avec vous le service adapté, vos pays de destination et votre volume mensuel estimé.

  4. 4

    Compte test

    Un compte test est mis en place sur demande pour valider votre intégration.

  5. 5

    Intégration

    Vous raccordez vos applications en HTTP API ou en SMPP, avec l'assistance de notre équipe.

  6. 6

    Production

    Vous lancez vos envois et suivez chaque message grâce aux rapports de livraison.

Questions fréquentes

Puis-je tester avant de m'engager ?

Oui. Un test de l'API SMS peut être mis en place sur demande, pour valider votre projet avant de vous engager. Utilisez le formulaire en choisissant « Demander un compte test ».

Quels modes d'intégration proposez-vous ?

Une HTTP API (REST) et une connexion SMPP.

Où trouver la documentation technique ?

Les comptes HTTP API et SMPP, ainsi que la documentation, sont fournis sur demande. Contactez-nous en précisant votre cas d'usage.

Peut-on recevoir des réponses par SMS ?

Oui, avec le SMS bidirectionnel : il peut s'appuyer sur un short code, un numéro long ou un numéro virtuel. Voir la page dédiée.

Besoin d'un avis technique ?

Notre équipe vous assiste pour l'interopérabilité avec vos bases de données et votre système d'information. Décrivez votre architecture, nous vous disons quel mode de connexion convient.