Skip to main content

Documentation de l'API : /api/send-message

Endpoint​

POST /api/send-message

Description​

Permet d'envoyer un SMS à un destinataire mauritanien via l'application Ibtikar OTP. Authentification par clé API requise.

Body attendu (JSON)​

{
  "phoneNumber": "+222XXXXXXXXX",
  "message": "Votre message ici"
}
  • phoneNumber (string, requis) : Numéro de téléphone du destinataire (format international ou local, ex : +222XXXXXXXXX ou 2XXXXXXXX).
  • message (string, requis) : Contenu du SMS.

Réponses possibles​

  • 200 OK
{
  "success": true,
  "message": "Message sent successfully"
}
  • 400 Bad Request
{
  "success": false,
  "message": "Phone number is required"
}
  • 401 Unauthorized
{
  "success": false,
  "message": "Clé API invalide ou manquante."
}
  • 403 Forbidden (App suspendue)
{
  "success": false,
  "message": "App is suspended. Cannot send messages."
}
  • 429 Too Many Requests
{
  "success": false,
  "message": "Limite de requêtes atteinte."
}
  • 500 Internal Server Error
{
  "success": false,
  "message": "Failed to send message"
}

Sécurité​

  • Authentification par clé API (header ou selon la logique du middleware)
  • Limitation de débit appliquée

Exemple de requête cURL​

curl -X POST https://<votre-domaine>/api/send-message \
  -H "Content-Type: application/json" \
  -H "x-api-key: sk_live_xxx" \
  -d '{
    "phoneNumber": "+222600000000",
    "message": "Votre code OTP est : 123456"
  }'