Référence de l'API SMS
Base : https://api.aureusprime.com/v1 · Authentification : Authorization: Bearer adk_sms_VOTRE_CLE · Format : JSON, UTF-8.
| Méthode | Route | Rôle | Détail |
|---|---|---|---|
POST |
/sms/messages |
Envoyer un SMS, tout de suite ou à une date planifiée | Envoyer, Planifier |
GET |
/sms/messages/:id |
État d'un message | Suivre |
DELETE |
/sms/messages/:id |
Annuler un SMS planifié pas encore parti (crédit rendu) | Planifier |
GET |
/sms/balance |
Solde de crédits et alerte de solde bas | Solde et recharges |
GET |
/sms/price-tiers |
Grille de prix dégressive | Solde et recharges |
GET |
/sms/senders |
Vos expéditeurs et leur statut | Expéditeurs |
POST |
/sms/senders |
Demander un expéditeur propre (organisations) | Expéditeurs |
Objet message
| Champ | Type | Description |
|---|---|---|
id |
string (UUID) | Identifiant du message |
status |
string | QUEUED, SENDING, SENT, DELIVERED, FAILED ou CANCELLED |
to |
string | Numéro masqué (+237*******56) |
operator |
string ou null | MTN, ORANGE… |
senderId |
string | Expéditeur utilisé |
errorCode |
string ou null | Raison d'un échec |
scheduledAt |
string ou null | Date d'envoi planifiée (ISO 8601) |
createdAt, sentAt, deliveredAt |
string ou null | Dates (ISO 8601, UTC) |
likelyUndelivered |
boolean | À l'envoi seulement : opérateur non desservi aujourd'hui |
replayed |
boolean | Présent quand une Idempotency-Key rejoue un message existant |
Le texte d'un message n'est jamais renvoyé.