Signaler le résultat de vérification
Après l'envoi d'un code de vérification par EngageLab, si vous effectuez la vérification dans votre propre système, vous pouvez appeler cette API pour signaler le résultat de vérification réussi pour les statistiques de backfill.
Cette API est gratuite et n'accepte que les résultats de vérification réussis.
Adresse d'appel
POST https://otp.api.engagelab.cc/v1/backfill
Authentification
Veuillez consulter Authentification pour savoir comment effectuer l'authentification de l'API.
Utilisez l'API Key configurée pour l'application qui a envoyé le message, et assurez-vous que cette API Key dispose de l'autorisation de vérification (verify).
Exemple de requête
En-tête de la requête
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
Corps de la requête
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
Paramètres de requête
Le corps de la requête utilise le format JSON. Définissez l'en-tête Content-Type: application/json.
| Paramètre | Type | Option | Description |
|---|---|---|---|
| message_id | String | Obligatoire | ID du message correspondant au code de vérification, renvoyé par l'API d'envoi |
| verified_at | Integer | Obligatoire | Heure de la vérification réussie, sous forme d'horodatage Unix en secondes |
Paramètres de réponse
Réponse en cas de succès
Le code de statut HTTP 200 indique que la plateforme a enregistré ce résultat de vérification réussi.
| Champ | Type | Option | Description |
|---|---|---|---|
| code | Integer | Obligatoire | 0 en cas de succès |
| message | String | Obligatoire | Description du résultat. success en cas de succès |
{
"code": 0,
"message": "success"
}
Réponse en cas d'échec
Le code de statut HTTP est 4xx ou 5xx, et le corps de la réponse contient un code d'erreur et une description de l'erreur. Par exemple, lorsque le message a déjà été vérifié avec succès, l'API renvoie HTTP 400 :
| Champ | Type | Option | Description |
|---|---|---|---|
| code | Integer | Obligatoire | Code d'erreur. Voir les codes d'erreur ci-dessous |
| message | String | Obligatoire | Description de l'erreur |
{
"code": 3012,
"message": "verify code has already validated"
}
Codes d'erreur
| Code d'erreur | http code | Description |
|---|---|---|
| 1000 | 500 | Erreur interne du service. Veuillez réessayer plus tard |
| 2001 | 401 | Les informations d'authentification sont absentes ou non valides |
| 2002 | 401 | L'API Key a expiré ou a été désactivée |
| 2002 | 403 | L'application actuelle n'est pas disponible |
| 2004 | 403 | L'API Key n'a pas l'autorisation d'appeler cette API |
| 3001 | 400 | Le JSON de la requête n'est pas valide ou le type d'un paramètre est incorrect |
| 3002 | 400 | Une valeur de paramètre n'est pas valide, l'heure est hors de la plage autorisée, ou le message ne prend pas en charge le backfill |
| 3012 | 400 | Le message a déjà été vérifié avec succès et n'a pas besoin d'être signalé à nouveau |
| 4001 | 400 | Le message n'existe pas ou n'appartient pas à l'application actuelle |
Traitez les erreurs selon code. message indique la raison précise.
Consignes d'utilisation
- Seuls les messages de code de vérification envoyés avec succès sont pris en charge. Les messages dont la vérification sur la plateforme a précédemment échoué ou expiré peuvent encore être signalés si vous les avez vérifiés avec succès de votre côté.
- Le premier signalement doit être effectué moins de 30 jours après l'envoi du message d'origine. L'heure de réception de la requête par la plateforme fait foi.
- L'heure de vérification réussie ne peut pas être antérieure à l'heure d'envoi du message d'origine, ni postérieure à l'heure de réception de cette requête par la plateforme.
- Lorsqu'un message est enregistré comme vérifié avec succès via cette API ou l'API Vérification du code de vérification, tout nouveau signalement ou toute nouvelle vérification renvoie
3012.
Une fois le backfill réussi, la plateforme envoie l'état du message correspondant selon la Configuration des callbacks de l'application.
