Verificación de OTP
Dirección de la llamada
POST https://otp.api.engagelab.cc/v1/verifications
Autenticación de llamadas
Consulte Autenticación de llamadas para saber cómo autenticar la API.
Ejemplo de solicitud
Encabezados de la solicitud
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
Este bloque de código se muestra en una ventana flotante
Cuerpo de la solicitud
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
{
"message_id": "1725407449772531712",
"verify_code": "667090"
}
Este bloque de código se muestra en una ventana flotante
Parámetros de la solicitud
| Parámetro | Tipo | Opción | Descripción |
|---|---|---|---|
| message_id | String | Obligatorio | ID del mensaje correspondiente al código de verificación, devuelto por la interfaz /messages |
| verify_code | String | Obligatorio | El código de verificación que se va a comprobar |
Parámetros de la respuesta
Respuesta exitosa
| Campo | Tipo | Opción | Descripción |
|---|---|---|---|
| message_id | String | Obligatorio | ID del mensaje correspondiente al código de verificación, devuelto por la interfaz /v1/messages |
| verify_code | String | Obligatorio | El código de verificación que se va a comprobar |
| verified | Boolean | Obligatorio | Resultado de la comprobación; true indica que se verificó correctamente, false indica que la comprobación falló |
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
{
"message_id": "1725407449772531712",
"verify_code": "667090",
"verified": true
}
Este bloque de código se muestra en una ventana flotante
Tenga en cuenta que, al realizar una solicitud de comprobación del código de verificación de un mismo mensaje, si la comprobación es correcta y se vuelve a llamar a esta interfaz de comprobación, la interfaz devolverá un fallo con el aviso de que el código de comprobación de este mensaje ya se ha comprobado; es decir, no se admite volver a verificar un código de verificación tras una verificación correcta.
Respuesta de error
El código de estado HTTP es 4xx o 5xx, y el cuerpo de la respuesta contiene los siguientes campos:
| Campo | Tipo | Opción | Descripción |
|---|---|---|---|
| code | int | Obligatorio | Código de error; véase la descripción de los códigos de error |
| message | String | Obligatorio | Detalles del error |
{
"code": 3003,
"message": "verify code has expired"
}
{
"code": 3003,
"message": "verify code has expired"
}
Este bloque de código se muestra en una ventana flotante
Códigos de error
| Código de error | http code | Descripción |
|---|---|---|
| 1000 | 500 | Error interno |
| 2001 | 401 | Error de autenticación; no se incluyó un token correcto |
| 2002 | 401 | Error de autenticación; el token ha expirado o ha sido deshabilitado |
| 2004 | 403 | Sin permiso para llamar a esta API |
| 3001 | 400 | Formato de los parámetros de la solicitud no válido; compruebe que el contenido JSON cumple el formato de los parámetros |
| 3002 | 400 | Parámetros de la solicitud incorrectos; compruebe que los parámetros de la solicitud cumplen los requisitos |
| 3003 | 400 | El código de verificación ha expirado o ya se ha verificado; ante este código de error en la respuesta, es necesario volver a enviar un nuevo mensaje de código de verificación |
| 3011 | 400 | El código de verificación ha expirado |
| 4001 | 400 | Este mensaje no existe |
