Envoyer OTP API

Envoyez un code à usage unique (OTP) à un utilisateur. Veuillez lire Référence Générale de l'API avant de lire ce document.

En utilisant uniquement le numéro de téléphone de l'utilisateur comme seul paramètre dans la configuration par défaut, Unimatrix générera de manière transparente un jeton OTP numérique sécurisé et enverra automatiquement le message de vérification via le canal actuellement actif.

Définitions

Action : otp.send
Méthode HTTP : POST
Content-Type : application/json

Paramètres de la requête

Nom	Type	Requis	Description	Exemple
to	string	Oui	Numéro de téléphone de l'utilisateur pour le code de vérification. Utilisez le format E.164.	+12068800123
digits	integer	Non	Nombre de chiffres pour le code OTP généré. Doit être entre 4-8. Par défaut : `6`	6
intent	string	Non	Intention de l'utilisateur pour demander le code de vérification, utilisé pour différencier les différents scénarios d'authentification. Maximum 36 caractères.	login
channel	string	Non	Canal de messagerie de vérification à utiliser. L'un des suivants : `sms`, `call`, `whatsapp` ou `auto`. Par défaut : `auto` (SMS prioritaire sur les autres canaux)	auto
code	string	Non	Un code personnalisé au lieu d'un code OTP généré automatiquement. Doit être une chaîne de 4 à 8 chiffres. * Non recommandé. L'utilisation de codes personnalisés peut réduire la sécurité de votre programme.	123456
ttl	integer	Non	Durée de vie du code personnalisé en secondes. Max : `1800`. Par défaut : `300` (5 minutes)	300

Exemple de requête

L'exemple suivant générera automatiquement un code de vérification et enverra le code au numéro de téléphone de l'utilisateur.

curl -X POST 'https://api.unimtx.com/?action=otp.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+120688001xx"
}'

Après avoir complété l'envoi de l'OTP, utilisez l'API Vérifier OTP pour vérifier si le code fourni par l'utilisateur est correct.

Paramètres de réponse

Nom	Type	Description	Exemple
code	string	Code de retour	0
message	string	Message de retour	Succès
data	JSON	Résultats

Résultats `data`

Nom	Type	Description	Exemple
id	string	ID du message	e7f51d2e5550131c3acc7fbc84e9901b
to	string	Numéro de téléphone de l'utilisateur (E.164)	+12068800123
iso	string	Code de pays (iso2)	US
cc	string	Code de pays (préfixe international)	1
parts	integer	Nombre de parties du message	1
price	string	Montant de la consommation	0.018900

Exemples de réponse

Exemple de réponse réussie

Code de statut : 200, Corps de la réponse :

{
  "code": "0",
  "message": "Succès",
  "data": {
    "id": "e7f51d2e5550131c3acc7fbc84e9901b",
    "to": "+12068800123",
    "iso": "US",
    "cc": "1",
    "parts": 1,
    "price": "0.018900"
  }
}

Exemple de réponse échouée

Code de statut : 400, Corps de la réponse :

{
  "code": "107111",
  "message": "InvalidPhoneNumbers"
}