Développeurs

API publique

Envoyez SMS, email et WhatsApp, lancez des campagnes, vérifiez des OTP et consultez votre solde via une API HTTP simple. Chaque erreur est lisible par machine avec un code stable. La référence complète est ci-dessous.

Ouvrir la console de test Référence interactive (Swagger)

Démarrage

Tous les endpoints sont servis sous :

https://api-s1.textdigo.com/api/v0

Les requêtes et réponses sont en JSON (hors téléversements multipart). Envoyez l’en-tête x-locale: fr ou en pour localiser les messages d’erreur.

Authentification

Authentifiez chaque requête en HTTP Basic avec votre apiLogin comme identifiant et votre apiKey comme mot de passe (dans Paramètres → Organisation → API).

curl -u "apiLogin:apiKey" \
  -H "Content-Type: application/json" \
  -d '{"phoneNumber":"+237670000000","message":"Hello"}' \
  https://api-s1.textdigo.com/api/v0/sms/message

Réponses & erreurs

Les erreurs partagent une même forme. statusCode est le statut HTTP, errorCode une chaîne stable lisible par machine (voir la référence), message est lisible par un humain, et details[] liste les problèmes par champ pour les erreurs de validation.

{
  "statusCode": 422,
  "errorCode": "PUBLIC_API_INVALID_PHONE_NUMBER",
  "message": "The phone number 0670 is not a valid international number",
  "details": [],
  "timestamp": "2026-06-10T10:00:00.000Z",
  "path": "/api/v0/sms/message"
}

Envoi de messages

POST/sms/messageenvoi de test

Envoyer un SMS à un numéro.

Champ	Type	Dans	Description
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`message`*	string (≤2000)	body	Contenu du message.
`senderName`	string (≤50)	body	Nom d'expéditeur approuvé.
`smsType`	enum TRANSACTIONAL\|MARKETING	body	Catégorie de facturation (défaut TRANSACTIONAL).
`externalId`	string	body	Votre référence, renvoyée dans les webhooks.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_UNSUPPORTED_PHONE_NUMBER (422)

GET/sms/messageenvoi de test

Envoyer un SMS (variante query).

Champ	Type	Dans	Description
`phoneNumber`*	string (E.164)	query	Numéro du destinataire au format international, ex. +237670000000.
`message`*	string	query	Contenu du message.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_UNSUPPORTED_PHONE_NUMBER (422)

POST/email/messagefacturé

Envoyer un email.

Champ	Type	Dans	Description
`email`*	string (email)	body	Adresse email du destinataire.
`subject`*	string (≤998)	body	Objet de l'email.
`htmlMessage`	string	body	Corps HTML.
`textMessage`	string	body	Corps texte.

Erreurs possibles : PUBLIC_API_INVALID_EMAIL (422)

POST/email/template/messagefacturé

Envoyer un email depuis un modèle.

Champ	Type	Dans	Description
`email`*	string (email)	body	Adresse email du destinataire.
`subject`*	string	body	Objet de l'email.
`templateId`*	string	body	Identifiant du modèle.
`parameters`	object<string,string>	body	Valeurs des variables du modèle.

Erreurs possibles : PUBLIC_API_INVALID_EMAIL (422), PUBLIC_API_TEMPLATE_NOT_FOUND (404)

POST/whatsapp-business/messagefacturé

Envoyer un message WhatsApp Business.

Champ	Type	Dans	Description
`whatsappBusinessPhoneNumberId`*	string	body	Identifiant de l'expéditeur WhatsApp.
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`message`	string (≤4096)	body	Corps texte (dans la fenêtre 24 h).
`mediaUrl`	string (url)	body	URL publique d'une pièce jointe.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/whatsapp-business/otp/messagefacturé

Envoyer un OTP WhatsApp.

Champ	Type	Dans	Description
`whatsappBusinessPhoneNumberId`*	string	body	Identifiant de l'expéditeur WhatsApp.
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/whatsapp-business/template/messagefacturé

Envoyer un message modèle WhatsApp.

Champ	Type	Dans	Description
`whatsappBusinessPhoneNumberId`*	string	body	Identifiant de l'expéditeur WhatsApp.
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`templateId`*	string	body	Identifiant du modèle approuvé.
`bodyParameters`	object<string,string>	body	Valeurs des variables du corps.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_TEMPLATE_NOT_FOUND (404), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/api-campaign/send-smsfacturé

Envoyer un SMS à plusieurs contacts (lot).

Champ	Type	Dans	Description
`message`*	string	body	Contenu du message.
`contacts`*	string[] (≤1000)	body	Numéros destinataires ; les invalides sont ignorés et reportés.
`senderName`	string	body	Nom d'expéditeur approuvé.

Erreurs possibles : PUBLIC_API_INVALID_RECIPIENTS (422)

GET/api-campaign/send-smsfacturé

SMS en lot (variante query).

Champ	Type	Dans	Description
`message`*	string	query	Contenu du message.
`contacts`*	string (comma-separated)	query	Numéros séparés par des virgules.

Erreurs possibles : PUBLIC_API_INVALID_RECIPIENTS (422)

Statut de livraison

GET/message/{channel}/status/{msgId}lecture seule

Statut de livraison d’un message.

Champ	Type	Dans	Description
`channel`*	enum sms\|email\|whatsapp	path	Canal du message.
`msgId`*	string	path	Le msgId renvoyé à l'envoi.

Erreurs possibles : PUBLIC_API_MESSAGE_NOT_FOUND (404)

GET/message/sms/{msgId}lecture seule

Détails complets d’un SMS.

Champ	Type	Dans	Description
`msgId`*	string	path	Le msgId renvoyé à l'envoi.

Erreurs possibles : PUBLIC_API_MESSAGE_NOT_FOUND (404)

Compte & usage

GET/integration/usagelecture seule

Aperçu usage & quotas.

GET/integration/walletlecture seule

Solde du portefeuille & transactions récentes.

GET/integration/canalslecture seule

Lister vos canaux.

Champ	Type	Dans	Description
`type`	enum CanalType	query	Filtrer par type de canal.
`limit`	number	query	Taille de page (défaut 50).

Ressources

POST/integration/campaignsfacturé

Créer et lancer une campagne.

Champ	Type	Dans	Description
`campaignSpecId`*	uuid	body	Identifiant du modèle de message.
`profileIds`*	uuid[]	body	Identifiants des listes de contacts.
`frequency`*	enum CampaignFrequency	body	Cadence d’envoi.

POST/integration/campaign-specsfacturé

Créer un modèle de message.

Champ	Type	Dans	Description
`name`*	string (≤200)	body	Nom du modèle.
`type`*	enum CampaignSpecType	body	Type de canal (SMS, EMAIL…).
`config`	object	body	Configuration propre au canal.

POST/integration/campaign-profilesfacturé

Créer une liste de contacts.

Champ	Type	Dans	Description
`name`*	string (≤200)	body	Nom de la liste.
`type`*	enum CampaignProfileType	body	Type de source de la liste.
`campaignSpecType`*	enum CampaignSpecType	body	Canal ciblé par la liste.

POST/integration/campaign-profiles/{id}/contacts/importfacturé

Importer des contacts dans une liste.

Champ	Type	Dans	Description
`id`*	uuid	path	Identifiant de la liste.
`contacts`*	object[] (≤10000)	body	Tableau de { phoneNumber?, email?, parameters? }.

POST/integration/ticketsfacturé

Créer un ticket.

Champ	Type	Dans	Description
`canalType`*	enum TicketCanalType	body	Canal du ticket.
`description`	string (≤2000)	body	Description du ticket.

POST/integration/contactsfacturé

Créer un contact.

Champ	Type	Dans	Description
`name`	string	body	Nom du contact.
`phoneNumbers`	string[]	body	Numéros de téléphone.
`emails`	string[] (email)	body	Adresses email.

POST/integration/groupsfacturé

Créer un groupe de contacts.

Champ	Type	Dans	Description
`name`*	string	body	Nom du groupe.

Codes à usage unique

POST/otp/smsfacturé

Envoyer un OTP par SMS.

Champ	Type	Dans	Description
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`numberOfDigits`	int 4–8	body	Longueur du code (valeur par défaut).

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422)

POST/otp/sms/verifylecture seule

Vérifier un OTP SMS.

Champ	Type	Dans	Description
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`otpCode`*	string (3–10)	body	Le code reçu par l'utilisateur.

Erreurs possibles : PUBLIC_API_OTP_CONTACT_NOT_FOUND (404), OTP_NOT_FOUND (404), OTP_CONTACT_NOT_FOUND (404), OTP_EXPIRED (400), OTP_TOO_MANY_ATTEMPTS (400), OTP_INVALID_CODE (400)

POST/otp/whatsappfacturé

Envoyer un OTP WhatsApp.

Champ	Type	Dans	Description
`whatsappBusinessPhoneNumberId`*	string	body	Identifiant de l'expéditeur WhatsApp — requis pour choisir le WABA qui envoie le code.
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.

Erreurs possibles : PUBLIC_API_INVALID_PHONE_NUMBER (422), PUBLIC_API_WAB_ACCOUNT_NOT_FOUND (404)

POST/otp/whatsapp/verifylecture seule

Vérifier un OTP WhatsApp.

Champ	Type	Dans	Description
`phoneNumber`*	string (E.164)	body	Numéro du destinataire au format international, ex. +237670000000.
`otpCode`*	string (3–10)	body	Le code reçu par l'utilisateur.

Erreurs possibles : PUBLIC_API_OTP_CONTACT_NOT_FOUND (404), OTP_NOT_FOUND (404), OTP_CONTACT_NOT_FOUND (404), OTP_EXPIRED (400), OTP_TOO_MANY_ATTEMPTS (400), OTP_INVALID_CODE (400)

POST/otp/emailfacturé

Envoyer un OTP par email.

Champ	Type	Dans	Description
`email`*	string (email)	body	Adresse email du destinataire.

Erreurs possibles : PUBLIC_API_INVALID_EMAIL (422)

POST/otp/email/verifylecture seule

Vérifier un OTP email.

Champ	Type	Dans	Description
`email`*	string (email)	body	Adresse email du destinataire.
`otpCode`*	string (3–10)	body	Le code reçu par l'utilisateur.

Erreurs possibles : PUBLIC_API_OTP_CONTACT_NOT_FOUND (404), OTP_NOT_FOUND (404), OTP_CONTACT_NOT_FOUND (404), OTP_EXPIRED (400), OTP_TOO_MANY_ATTEMPTS (400), OTP_INVALID_CODE (400)

Fichiers & tickets

POST/file/uploadlecture seule

Téléverser un fichier média (multipart).

Champ	Type	Dans	Description
`file`*	binary	multipart	Le fichier à téléverser.

Erreurs possibles : PUBLIC_API_FILE_REQUIRED (422), PUBLIC_API_FILE_TOO_LARGE (413)

POST/issuefacturé

Créer un ticket de support (multipart).

Champ	Type	Dans	Description
`email`*	string (email)	multipart	Adresse email du destinataire.
`issueCanalType`*	enum SMS\|WHATSAPP\|EMAIL	multipart	Canal de réponse.
`issueMessage`	string	multipart	Le texte de la demande.
`file`	binary	multipart	Pièce jointe optionnelle.

Erreurs possibles : PUBLIC_API_INVALID_EMAIL (422), PUBLIC_API_FILE_TOO_LARGE (413)

Webhooks

Configurez des URL de rappel par canal dans Paramètres → Organisation → API. Chaque appel est un POST signé avec X-TextDigo-Signature: sha256=HMAC_SHA256(webhookSecret, rawBody). Vérifiez-le avec votre webhookSecret.

Rapports de livraison

{ "msgId": "...", "from": "...", "status": "DELIVERED",
  "partCount": 1, "amount": 0.02, "operator": "...",
  "externalId": "...", "currency": "XAF", "subject": "dlr", "type": "sms" }

status ∈ DELIVERED | UNDELIVERED | SENT | FAILED

Messages entrants

{ "event": "inbound-message", "type": "sms", "lineId": "...",
  "phoneNumber": "...", "chatId": "...", "message": "...", "medias": [] }

Codes d'erreur

Branchez sur errorCode, pas sur le message humain (qui est localisé). Les codes issus de l’ancienne API Meteor affichent leur ancien code numérique.

Authentification

Code	HTTP	Signification	Résolution
`API_KEY_MISSING_CREDENTIALS`	401	Identifiants API manquants.Aucun en-tête Authorization (ou token) n'a été fourni.	Envoyez Authorization: Basic base64(apiLogin:apiKey).
`API_KEY_INVALID_CREDENTIALS`	401	Identifiants API invalides.Le couple apiLogin/apiKey ne correspond à aucun compte.	Recopiez les clés depuis Paramètres → Organisation → API.
`API_KEY_ORG_NOT_ACTIVE`	403	L'organisation n'est pas active.Le compte est suspendu ou résilié.	Réactivez le compte ou contactez le support.

Validation

Code	HTTP	Signification	Résolution
`VALIDATION_FAILED`	422	Un ou plusieurs champs sont invalides.Un champ est manquant, du mauvais type, trop long ou inconnu.	Consultez le tableau details[] par champ dans la réponse.
`PUBLIC_API_INVALID_PHONE_NUMBER`ex- #3001	422	Le numéro n'est pas un numéro international valide.Le numéro n’est pas analysable en E.164.	Utilisez la forme internationale complète, ex. +237670000000.
`PUBLIC_API_UNSUPPORTED_PHONE_NUMBER`ex- #3002	422	Aucun opérateur actif ne dessert ce numéro.Le pays/opérateur de destination n'est pas activé sur votre compte.	Vérifiez votre couverture activée ou contactez le support.
`PUBLIC_API_INVALID_EMAIL`ex- #3003	422	L'adresse email n'est pas valide.L’adresse a échoué à la validation de format.	Fournissez une adresse syntaxiquement valide.
`PUBLIC_API_INVALID_RECIPIENTS`	422	Aucun des destinataires fournis n'est valide.Tous les numéros d’un envoi en lot ont échoué à la validation.	Envoyez au moins un numéro E.164 valide.
`OTP_EXPIRED`	400	Le code OTP a expiré.La fenêtre de validité a expiré avant la vérification.	Demandez un nouvel OTP et vérifiez-le plus tôt.
`OTP_TOO_MANY_ATTEMPTS`	400	Trop de tentatives OTP échouées.Le code a été saisi incorrectement trop de fois.	Demandez un nouvel OTP pour réinitialiser le compteur.
`OTP_INVALID_CODE`	400	Code OTP invalide.Le code soumis ne correspond pas à l'OTP en attente.	Resaisissez le code exact qui a été envoyé.
`PUBLIC_API_FILE_REQUIRED`ex- #101	422	Un fichier est requis.La requête multipart ne contenait aucun fichier.	Joignez le fichier sous le champ « file ».
`PUBLIC_API_FILE_TOO_LARGE`	413	Le fichier dépasse la taille maximale.Le téléversement dépasse la limite par fichier.	Compressez ou divisez le fichier sous la limite.

Ressources

Code	HTTP	Signification	Résolution
`PUBLIC_API_MESSAGE_NOT_FOUND`	404	Message introuvable.Le msgId n'appartient pas à votre compte.	Utilisez le msgId renvoyé par l'appel d'envoi.
`PUBLIC_API_OTP_CONTACT_NOT_FOUND`	404	Aucun OTP en attente pour ce contact.Aucun OTP n'a été envoyé, ou il a expiré.	Envoyez un nouvel OTP avant de vérifier.
`OTP_NOT_FOUND`	404	Aucun OTP trouvé.Aucun OTP n'a été généré pour ce contact, ou il a déjà été consommé.	Envoyez un nouvel OTP avant de vérifier.
`OTP_CONTACT_NOT_FOUND`	404	Le contact est introuvable.Le contactId fourni n'appartient pas à votre compte.	Omettez contactId pour cibler par téléphone/email, ou utilisez un identifiant valide.
`PUBLIC_API_WAB_ACCOUNT_NOT_FOUND`	404	Aucun expéditeur WhatsApp Business ne correspond à l'identifiant.whatsappBusinessPhoneNumberId est erroné ou non connecté.	Utilisez un identifiant de vos canaux WhatsApp connectés.
`PUBLIC_API_TEMPLATE_NOT_FOUND`	404	Modèle introuvable.Le templateId est inconnu dans votre compte.	Listez vos modèles et utilisez un identifiant valide.
`PUBLIC_API_CANAL_NOT_ACTIVE`ex- #501	422	Le canal ciblé n'est pas actif.Le canal existe mais est désactivé.	Activez le canal dans le tableau de bord.

Limitation de débit

Code	HTTP	Signification	Résolution
`RATE_LIMITED`	429	Trop de requêtes.Vous avez dépassé le budget de requêtes par clé.	Patientez puis réessayez après un court délai.

Serveur

Code	HTTP	Signification	Résolution
`INTERNAL_ERROR`ex- #100	500	Erreur serveur inattendue.Une défaillance est survenue de notre côté.	Réessayez plus tard ; contactez le support si cela persiste.

Limites & quotas

Limitation de débit : les requêtes sont limitées par clé API. Patientez en cas de 429 (RATE_LIMITED).
SMS en lot : jusqu’à 1000 contacts par appel /api-campaign/send-sms.
Import de contacts : jusqu’à 10 000 contacts par appel.
Les téléversements sont plafonnés par la taille maximale par fichier (sinon PUBLIC_API_FILE_TOO_LARGE).