SMS - OTP

SMS OTP via API est le service qui permet de générer et d'envoyer automatiquement des codes OTP (One-Time Password) par SMS, simplifiant ainsi l'intégration de systèmes d'authentification et de vérification dans les sites web, les applications et les plateformes numériques.

Avec une seule requête API, vous pouvez envoyer un code OTP sécurisé, numérique ou alphanumérique, au numéro de téléphone mobile de l'utilisateur et configurer sa longueur en fonction des besoins de votre processus.

Le message est automatiquement traduit en fonction du pays du destinataire, ce qui vous permet d'utiliser le même processus d'authentification à l'international sans avoir à gérer manuellement différents textes et langues.

Le service utilise OTP MOBILE comme expéditeur par défaut et applique les tarifs prévus pour le service SMS Worldwide.

Il est idéal pour intégrer rapidement des processus tels que :

La méthode POST/otp permet de générer automatiquement un code OTP sécurisé et de l'envoyer par SMS au numéro de téléphone mobile indiqué.

Il suffit d'indiquer le destinataire et, si nécessaire, de configurer les caractéristiques du code.

Le code OTP peut être :

Si aucune autre option n'est spécifiée, un code numérique est généré. Vous pouvez choisir une longueur comprise entre 4 et 10 caractères. La valeur par défaut est 5. Le paramètre cacheSeconds permet de définir pendant combien de temps le même OTP doit être réutilisé lorsque plusieurs requêtes sont effectuées pour le même destinataire.

Cette valeur peut être configurée jusqu'à un maximum de 600 secondes. Cette fonctionnalité permet, par exemple, d'éviter la génération de codes différents lorsqu'un utilisateur demande plusieurs fois l'envoi de l'OTP en quelques minutes.

TRADUCTION AUTOMATIQUE

Il n'est pas nécessaire de créer manuellement le texte du SMS. Le service génère automatiquement le message contenant le code OTP et le traduit en fonction du pays associé au numéro de téléphone du destinataire. Vous pouvez ainsi utiliser un seul endpoint pour gérer des processus d'authentification internationaux, tout en réduisant la complexité du développement et de la maintenance.

EXEMPLE DE REQUÊTE

POST/otp

Voici un exemple de requête :

{
  "recipient": "+393331234567",
  "alphanumeric": false,
  "length": 5,
  "cacheSeconds": 0,
  "options": {
    "dryRun": false,
    "failOnMultipleMessages": false
  },
  "callback": {
    "method": "JSON",
    "field": "data",
    "url": "https://www.mysite.com/myEndpoint",
    "retry": 3,
    "headers": {
      "session_id": "9834r5fh589494"
    },
    "custom": {
      "my_custom_id": "123456789"
    }
  }
}

Dans cet exemple, un OTP numérique à 5 chiffres est généré pour le numéro indiqué.

EXEMPLE DE RÉPONSE

POST/otp

La réponse renvoie les informations relatives au message et au code OTP généré :

{
  "data": {
    "id": "633aabe3e4a9a0e69811ad7f",
    "username": "string",
    "state": "NEW",
    "sender": "string",
    "recipient": "string",
    "internationalPrefix": "39",
    "countryCode": "IT",
    "message": "string",
    "encoding": "GSM-7",
    "charactersCount": 0,
    "messageCount": 0,
    "price": 0,
    "totalPrice": 0,
    "blocklisted": true,
    "blocklistedReason": "string",
    "options": {
      "dryRun": false,
      "failOnMultipleMessages": false
    },
    "callback": {
      "method": "JSON",
      "field": "data",
      "url": "https://www.mysite.com/myEndpoint",
      "retry": 3,
      "headers": {
        "session_id": "9834r5fh589494"
      },
      "custom": {
        "my_custom_id":  "123456789"
      }
    },
    "createdAt": "2026-08-24T07:34:19.961Z",
    "updatedAt": "2026-08-24T07:34:19.961Z",
    "sentAt": "2026-08-24T07:34:19.961Z",
    "deliveredAt": "2026-08-24T07:34:19.961Z",
    "isOtp": true,
    "otp": "5F8A2",
    "otpOptions": {
      "length": 5,
      "alphanumeric": false,
      "cacheSeconds": 300
    }
  }
}

Les données renvoyées comprennent le code OTP généré, les paramètres utilisés et les informations relatives au SMS envoyé.

SUIVI DE LA LIVRAISON

Il est possible de suivre l'état du message grâce au système de callback. Openapi enverra automatiquement les mises à jour relatives au statut du SMS à votre endpoint, évitant ainsi d'avoir à effectuer des requêtes en continu. Il est également possible d'utiliser les endpoints de l'API SMS v2 pour consulter la liste des messages envoyés et récupérer les détails d'un message spécifique grâce à son ID.

COÛTS

Le service SMS OTP utilise le modèle tarifaire SMS Worldwide. Le coût de l'envoi varie donc en fonction du pays de destination et de l'opérateur mobile du destinataire.

Pour connaître le coût actuel pour chaque destination, consultez la section dédiée aux tarifs SMS Worldwide.