PUT
https://api.octopush.com/v1/public/service/otp/validateEncodage : UTF-8
Autentificación
Los identificadores “api-key” y “api-login” deben añadirse en las cabeceras.
Definición
Permite validar un código OTP generado en Octopush.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
phone_number | string | (opcional, obligatorio si otp_request_token está ausente) Número de teléfono internacional +XXZZZZZ: “+33611223344”. |
code | string | Código OTP introducido por su visitante/usuario. |
otp_request_token | string | (opcional, obligatorio si falta phone_number) Token de la OTP que se intenta validar. Si falta este valor, Octopush intentará validar el último código enviado a este destinatario. |
Ejemplo Curl
curl -X PUT \
'https://api.octopush.com/v1/public/service/otp/validate' \
-H 'Content-Type: application/json' \
-H 'api-login: ******@email.org' \
-H 'api-key: ************' \
-H 'cache-control: no-cache' \
-d '
{
"code": "TRQXSDYNJY",
"otp_request_token": "otp_111111dab2222222aaa33333"
}'Copiar y pegar el código
curl -X PUT 'https://api.octopush.com/v1/public/service/otp/validate' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d '{"code": "TRQXSDYNJY", "otp_request_token": "otp_111111dab2222222aaa33333"}'Respuesta Servidor en JSON
Success : 200 Cread0
{
"code": 0,
"message": "success"
}Error : 400 BAD REQUEST
{
"code": 199,
"message": "Wrong OTP code.",
"remaining_number_of_attempts": 3
}Failure : 400 BAD REQUEST
{
"code": 194,
"message": "At least phone number or request token is mandatory."
}Ejemplos de códigos de retorno
| Código | Descripción |
|---|---|
| 194 | Al menos el número de teléfono o el token de solicitud es obligatorio. |
| 195 | cAt least the telephone number or application token is mandatory. |
| 196 | Se ha alcanzado la cantidad máxima de intentos erróneos. |
| 197 | Solicitud de OTP expirada. |
| 198 | Solicitud de OTP no encontrada. |
| 199 | Código otp erróneo. |