Informar resultado de verificación
Después de que EngageLab envíe un código de verificación, si completa la verificación en su propio sistema, puede llamar a esta API para informar el resultado de verificación correcto para las estadísticas de backfill.
Esta API es gratuita y solo acepta resultados de verificación correctos.
Dirección de la llamada
POST https://otp.api.engagelab.cc/v1/backfill
Autenticación de llamadas
Consulte Autenticación de llamadas para saber cómo autenticar la API.
Utilice la API Key configurada para la aplicación que envió el mensaje y asegúrese de que esa API Key tenga el permiso de verificación (verify).
Ejemplo de solicitud
Encabezados de la solicitud
POST /v1/backfill HTTP/1.1
Content-Type: application/json
Authorization: Basic ${base64_auth_string}
Cuerpo de la solicitud
{
"message_id": "1725407449772531712",
"verified_at": 1793116800
}
Parámetros de la solicitud
El cuerpo de la solicitud usa JSON. Establezca el encabezado Content-Type: application/json.
| Parámetro | Tipo | Opción | Descripción |
|---|---|---|---|
| message_id | String | Obligatorio | ID del mensaje correspondiente al código de verificación, devuelto por la API de envío |
| verified_at | Integer | Obligatorio | Hora en la que la verificación se realizó correctamente, como marca de tiempo Unix en segundos |
Parámetros de la respuesta
Respuesta exitosa
El código de estado HTTP 200 indica que la plataforma ha registrado este resultado de verificación correcto.
| Campo | Tipo | Opción | Descripción |
|---|---|---|---|
| code | Integer | Obligatorio | 0 cuando la operación es correcta |
| message | String | Obligatorio | Descripción del resultado. success cuando la operación es correcta |
{
"code": 0,
"message": "success"
}
Respuesta de error
El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene un código de error y una descripción del error. Por ejemplo, si el mensaje ya se verificó correctamente, la API devuelve HTTP 400:
| Campo | Tipo | Opción | Descripción |
|---|---|---|---|
| code | Integer | Obligatorio | Código de error. Consulte los códigos de error siguientes |
| message | String | Obligatorio | Descripción del error |
{
"code": 3012,
"message": "verify code has already validated"
}
Códigos de error
| Código de error | http code | Descripción |
|---|---|---|
| 1000 | 500 | Error interno del servicio. Inténtelo de nuevo más tarde |
| 2001 | 401 | Falta la información de autenticación o no es válida |
| 2002 | 401 | La API Key ha caducado o se ha deshabilitado |
| 2002 | 403 | La aplicación actual no está disponible |
| 2004 | 403 | La API Key no tiene permiso para llamar a esta API |
| 3001 | 400 | El JSON de la solicitud no es válido o el tipo de un parámetro es incorrecto |
| 3002 | 400 | Un valor de parámetro no es válido, la hora está fuera del intervalo permitido o el mensaje no admite backfill |
| 3012 | 400 | El mensaje ya se verificó correctamente y no es necesario informarlo de nuevo |
| 4001 | 400 | El mensaje no existe o no pertenece a la aplicación actual |
Gestione los errores según code. message explica el motivo concreto.
Instrucciones de uso
- Solo se admiten mensajes de código de verificación enviados correctamente. Los mensajes cuya verificación en la plataforma falló o superó el tiempo de espera aún se pueden informar si usted los verificó correctamente por su cuenta.
- El primer informe debe completarse en menos de 30 días después del envío del mensaje original. Se toma como referencia la hora en que la plataforma recibe la solicitud.
- La hora de verificación correcta no puede ser anterior a la hora de envío del mensaje original ni posterior a la hora en que la plataforma recibe esta solicitud.
- Cuando un mensaje queda registrado como verificado correctamente mediante esta API o la API Verificación de OTP, los informes o verificaciones posteriores devuelven
3012.
Tras un backfill correcto, la plataforma envía el estado del mensaje correspondiente según la Configuración de callbacks de la aplicación.
