POST
/
send
/
otp
Envoyer un OTP
curl --request POST \
  --url https://api.example.com/send/otp \
  --header 'Content-Type: application/json' \
  --data '
{
  "service": "<string>",
  "number": "<string>",
  "channel": "<string>",
  "signature": "<string>"
}
'
{
  "statusCode": 400,
  "message": "Solde SMS insuffisant",
  "error": "Bad Request"
}

Description

Cet endpoint permet d’envoyer un code de vérification à 4 chiffres (OTP) à un numéro de téléphone. Le code peut être envoyé par SMS ou par WhatsApp. Le code OTP est valide pendant 15 minutes.

Paramètres de la requête

service
string
required
Le nom de votre service ou application. Ce nom apparaîtra dans le message envoyé au destinataire.Exemple : "MonApplication", "MaBoutique", "ServiceClient"
number
string
required
Le numéro de téléphone du destinataire au format international (sans le +).Exemple : "221771234567"
channel
string
default:"sms"
Le canal d’envoi du code OTP.Valeurs possibles : "sms" ou "whatsapp"
signature
string
La signature personnalisée pour l’envoi (optionnel). Par défaut : "DEXCHANGE".

Exemple de requête

curl -X POST https://api-v2.dexchange-sms.com/api/v1/send/otp \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "service": "MonApplication",
    "number": "221771234567",
    "channel": "sms"
  }'

Réponse

message
string
Message de confirmation de l’envoi
smsID
string
Identifiant unique de l’OTP envoyé (à utiliser pour la vérification si nécessaire)
service
string
Le nom du service pour lequel l’OTP a été envoyé

Exemple de réponse réussie

{
  "message": "Code de vérification envoyé avec succès",
  "smsID": "abc123xyz789",
  "service": "MonApplication"
}

Message reçu par l’utilisateur

Le destinataire recevra un message du type :
Votre code de vérification pour MonApplication est: 1234

Erreurs possibles

{
  "statusCode": 400,
  "message": "Solde SMS insuffisant",
  "error": "Bad Request"
}

Workflow complet

1

Envoi de l'OTP

Appelez POST /send/otp avec le numéro de l’utilisateur
2

L'utilisateur reçoit le code

Un code à 4 chiffres est envoyé par SMS ou WhatsApp
3

L'utilisateur saisit le code

L’utilisateur entre le code dans votre application
4

Vérification du code

Appelez POST /verify/otp pour valider le code

Notes importantes

Expiration : Le code OTP expire après 15 minutes. Passé ce délai, l’utilisateur devra demander un nouveau code.
WhatsApp : L’envoi via WhatsApp peut être plus fiable dans certaines régions et offre une meilleure expérience utilisateur.
Un seul code actif : Si vous envoyez plusieurs OTP au même numéro pour le même service, seul le dernier code sera valide.