API de Vérification OTP

Vérifiez la validité du code à usage unique (OTP) qu'un utilisateur a fourni. Veuillez lire la Référence Générale de l'API avant de lire ce document.

Après avoir utilisé l'API d'Envoi d'OTP pour envoyer un code de vérification à l'utilisateur, vous pouvez rapidement vérifier si le code fourni est correct en soumettant simplement le code reçu et le numéro de téléphone de l'utilisateur, sans nécessiter de mise en cache des données.

Définitions

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

Paramètres de requête

Nom	Type	Requis	Description	Exemple
to	string	Oui	Numéro de téléphone de l'utilisateur pour la vérification. Utiliser le format E.164.	+12068800123
code	string	Oui	Code pour la vérification. Doit être une chaîne de 4 à 8 chiffres.	123456
intent	string	Non	Intention de l'utilisateur pour la vérification, doit être la même que celle passée avec l'API d'Envoi d'OTP. Maximum 36 caractères.	login
ttl	integer	Non	Durée de vie du code en secondes. Max : `1800`. Par défaut : `300` (5 minutes) * Applicable uniquement aux codes OTP générés automatiquement, n'affecte pas les codes personnalisés.	300

Exemple de requête

L'exemple suivant vérifie et retourne si le code de vérification fourni par l'utilisateur est correct.

curl -X POST 'https://api.unimtx.com/?action=otp.verify&accessKeyId=VOTRE_ID_DE_CLÉ_D'ACCÈS' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+120688001xx",
  "code": "123456"
}'

Paramètres de réponse

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

Résultats `data`

Nom	Type	Description	Exemple
to	string	Numéro de téléphone de l'utilisateur (E.164)	+12068800123
valid	boolean	Indique si le code fourni est valide	true

Exemples de réponse

Exemple de réponse réussie

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

{
  "code": "0",
  "message": "Success",
  "data": {
    "to": "+12068800123",
    "valid": true
  }
}

Exemple de réponse d'échec

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

{
  "code": "104001",
  "message": "MissingParams"
}