Envoi d'OTP
Endpoint
POST /api/send-otp
En-têtes requis
Content-Type: application/json
api-key: VOTRE_CLE_API
Paramètres de la requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
phoneNumber | String | Oui | Numéro de téléphone au format international (ex: +22212345678) |
ipAdress | String | Oui | Adresse IP de l'utilisateur (pour la sécurité) |
channel | String | Non | Canal d'envoi : "sms" (défaut) ou "whatsapp" |
lang | String | Non | Langue du message : "ar" (défaut), "fr", ou "en" |
appName | String | Non | Nom personnalisé de l'application (optionnel) |
hash | String | Non | Hash de l'application pour Android (optionnel) |
Exemple de requête
{
"phoneNumber": "+22212345678",
"ipAdress": "192.168.1.1",
"channel": "sms",
"lang": "ar",
"appName": "Mon Application"
}
Réponse réussie (200)
{
"success": true,
"message": "OTP sent successfully",
"verifToken": "550e8400-e29b-41d4-a716-446655440000"
}
Champs de réponse :
success:truesi l'OTP a été envoyé avec succèsmessage: Message de confirmationverifToken: Token unique à utiliser pour la vérification (à conserver côté client)
Réponses d'erreur
400 - Requête invalide
{
"success": false,
"message": "Phone number is required"
}
401 - Clé API manquante
{
"message": "API key is missing"
}
403 - Clé API invalide
{
"success": false,
"message": "Invalid API key"
}
403 - Application suspendue
{
"success": false,
"message": "App is suspended. Cannot send messages."
}
403 - Trop de tentatives
{
"success": false,
"message": "Too many retries"
}
403 - WhatsApp non disponible (Mauritanie)
{
"success": false,
"message": "Receiving the code via WhatsApp is not available for Mauritanian numbers located in Mauritania"
}
500 - Erreur serveur
{
"success": false,
"message": "Failed to send OTP"
}
Format du numéro de téléphone
- Format international requis :
+22212345678 - Doit commencer par
+ - Doit être un numéro valide selon la norme E.164
Canaux d'envoi
SMS (défaut)
- National (Mauritanie) : Envoi via le service SMS local
- International : Envoi via Twilio pour les numéros hors Mauritanie
WhatsApp
- Disponibilité : Uniquement pour les numéros internationaux
- Restriction : Les numéros mauritaniens (+222) ne peuvent pas recevoir d'OTP par WhatsApp s'ils sont localisés en Mauritanie
- Géolocalisation : Le système vérifie automatiquement la localisation de l'IP
Langues supportées
| Code | Langue | Exemple de message |
|---|---|---|
ar | Arabe | رمز التحقق الخاص بتطبيق MonApp هو : 123456 |
fr | Français | Votre code de vérification MonApp est : 123456 |
en | Anglais | Your MonApp verification code is: 123456 |
Format du code OTP
- Longueur : 6 chiffres (4 chiffres pour certaines applications spéciales)
- Génération : Aléatoire et sécurisé
- Durée de validité : 10 minutes
- Format :
123456(sans espaces)