Documentation officielle de l'API Axiom TEXT
Intégrez notre service SMS dans vos applications en quelques minutes
Pour utiliser l'API SMS, vous devez d'abord obtenir une clé API. Suivez ces étapes :
Toutes les requêtes à l'API doivent inclure votre token d'authentification dans l'en-tête HTTP.
Authorization: Bearer votre_token_iciL'API impose une limite de 1000 requêtes par heure, par :
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: nombre_restant
X-RateLimit-Reset: timestamp_reset
Retry-After: secondes_avant_prochain_essai # (uniquement si limite dépassée)Nouveau ! Vous n'avez plus besoin d'attendre la validation de votre nom d'entreprise pour commencer à envoyer des SMS. Deux signatures sont disponibles immédiatement dès votre inscription :
Parfait pour l'envoi de codes de vérification OTP
"signature": "OTP"Idéal pour les messages de service et notifications
"signature": "SERVICE SMS"Note importante : Une fois votre nom d'entreprise validé, vous pourrez également utiliser votre signature personnalisée. En attendant, utilisez "OTP" ou "SERVICE SMS" dans le paramètre signature.
Envoyez des SMS à vos utilisateurs avec une signature personnalisée. L'envoi national (au Sénégal) coûte 1 crédit SMS par message, déduit du forfait de l'utilisateur. Pour les envois internationaux, chaque message est facturé 3 crédits.
POST /api/sms/message{
"to": "+221xxxxxxxxx",
"message": "Votre message",
"signature": "OTP" // Optionnel: "OTP", "SERVICE SMS" ou votre nom d'entreprise validé
}Signatures disponibles : "OTP", "SERVICE SMS" (disponibles immédiatement) ou votre nom d'entreprise (une fois validé)
curl -X POST https://api.axiomtext.com/api/sms/message \
-H "Authorization: Bearer votre_token_api" \
-H "Content-Type: application/json" \
-d '{
"to": "+221xxxxxxxxx",
"message": "Votre message",
"signature": "OTP"
}'{
"success": true,
"message": "SMS envoyé avec succès",
"data": {
"messageId": "123456789",
"remainingCredits": 999,
"cost": 1,
"status": "sent"
}
}{
"error": "Numéro de téléphone et message requis",
"status": 400
}{
"error": "Crédits SMS insuffisants",
"status": 403
}Envoyez un code OTP à un numéro de téléphone pour la vérification. L'envoi national (au Sénégal) coûte 1 crédit SMS par message, déduit du forfait de l'utilisateur. Pour les envois internationaux, chaque message est facturé 3 crédits.
POST /api/sms/otp/send{
"phone": "+221xxxxxxxxx",
"signature": "OTP" // Optionnel: "OTP", "SERVICE SMS" ou votre nom d'entreprise validé
}Signatures disponibles : "OTP", "SERVICE SMS" (disponibles immédiatement) ou votre nom d'entreprise (une fois validé)
curl -X POST https://api.axiomtext.com/api/sms/otp/send \
-H "Authorization: Bearer votre_token_api" \
-H "Content-Type: application/json" \
-d '{
"phone": "+221xxxxxxxxx",
"signature": "OTP"
}'{
"success": true,
"message": "Code OTP envoyé avec succès",
"remainingCredits": 999
}{
"error": "Numéro de téléphone requis",
"status": 400
}{
"error": "Solde insuffisant",
"status": 403
}Vérifiez si le code OTP saisi par l'utilisateur est correct.
POST /api/sms/otp/verify{
"phone": "+221xxxxxxxxx",
"code": "123456"
}curl -X POST https://api.axiomtext.com/api/sms/otp/verify \
-H "Authorization: Bearer votre_token_api" \
-H "Content-Type: application/json" \
-d '{
"phone": "+221xxxxxxxxx",
"code": "123456"
}'{
"success": true,
"message": "Code OTP vérifié avec succès"
}{
"error": "Code OTP expiré ou invalide",
"status": 400
}{
"error": "Code OTP incorrect",
"status": 400
}{
"error": "Token d'authentification manquant"
}{
"error": "Limite de requêtes dépassée pour cette IP"
}{
"error": "Crédits SMS insuffisants"
}Chaque réponse inclut des en-têtes pour suivre votre utilisation :
{
"X-RateLimit-Limit": "1000",
"X-RateLimit-Remaining": "999",
"X-RateLimit-Reset": "1625097600000",
"Retry-After": "3600" // Uniquement si limite dépassée
}