Vérification du code de vérification
Adresse d'appel
POST https://otp.api.engagelab.cc/v1/verifications
Authentification
Veuillez consulter Authentification pour savoir comment effectuer l'authentification de l'API.
Exemple de requête
En-tête de la requête
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
POST /v1/verifications HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
Afficher ce bloc de code dans la fenêtre flottante
Corps de la requête
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de requête
| Paramètre | Type | Option | Description |
|---|---|---|---|
| message_id | String | Obligatoire | ID du message correspondant au code de vérification, renvoyé par l'interface /messages |
| verify_code | String | Obligatoire | Code de vérification à vérifier |
Paramètres de réponse
Réponse en cas de succès
| Champ | Type | Option | Description |
|---|---|---|---|
| message_id | String | Obligatoire | ID du message correspondant au code de vérification, renvoyé par l'interface /v1/messages |
| verify_code | String | Obligatoire | Code de vérification à vérifier |
| verified | Boolean | Obligatoire | Résultat de la vérification, true signifie que la vérification a réussi, false qu'elle a échoué |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Afficher ce bloc de code dans la fenêtre flottante
Notez que, pour une requête de vérification du code de vérification d'un même message, si le code de vérification est vérifié avec succès et que cette interface de vérification est de nouveau appelée, l'interface renverra un échec en indiquant que le code de vérification de ce message a déjà été vérifié ; autrement dit, il n'est pas possible de vérifier à nouveau un code de vérification après une vérification réussie.
Réponse en cas d'échec
Le code de statut HTTP est 4xx ou 5xx, et le corps de la réponse contient les champs suivants :
| Champ | Type | Option | Description |
|---|---|---|---|
| code | int | Obligatoire | Code d'erreur, voir la description des codes d'erreur |
| message | String | Obligatoire | Détails de l'erreur |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Afficher ce bloc de code dans la fenêtre flottante
Codes d'erreur
| Code d'erreur | http code | Description |
|---|---|---|
| 1000 | 500 | Erreur interne |
| 2001 | 401 | Échec de l'authentification, token correct non fourni |
| 2002 | 401 | Échec de l'authentification, token expiré ou désactivé |
| 2004 | 403 | Aucune autorisation d'appeler cette API |
| 3001 | 400 | Format des paramètres de requête invalide, veuillez vérifier que le contenu JSON respecte le format des paramètres |
| 3002 | 400 | Paramètres de requête incorrects, veuillez vérifier que les paramètres de requête sont conformes aux exigences |
| 3003 | 400 | Code de vérification expiré ou déjà vérifié ; pour la réponse correspondant à ce code d'erreur, un nouveau message de code de vérification doit être renvoyé |
| 3011 | 400 | Code de vérification expiré |
| 4001 | 400 | Ce message n'existe pas |
