Documentation API-SMS: OTP / MFA - Enviar un código

POST

https://api.octopush.com/v1/public/service/otp/generate

Encodage : UTF-8

Autentificación

Los identificadores “api-key” y “api-login” deben añadirse en las cabeceras.

Definición

Permite generar y enviar un código OTP a un destinatario, en el canal de su elección.

Parámetros especiales

Nombre	Tipo	Descripción
`phone_number`	string	Números de teléfono del destinatario
`channel`	string	(opcional) Canal para enviar su mensaje [“text_sms”, “voice_sms”, “whatsapp”, “email”, “imessage”]
`text`	string	(opcional) Puede incluir el marcador de posición {code} (el código OTP generado) y/o {hh:mm:ss} (la fecha de caducidad de este código). Deje este campo vacío para que sólo se envíe el código.
`voice_language`	string	(opcional) Idioma de voz utilizado en el caso del canal sms_voice [“en-US”, “en-GB”, “el-GR”, “pl-PL”, “hu-HU”, “sv-SE”, “de-DE”, “es-ES”, “es-LA”, “fr-FR”, “it-IT”, “pt-BR”, “ru-RU”].
`voice_gender`	string	(opcional) Género de la voz [“masculino”, “femenino”].
`sender`	string	(opcional) Remitente de su mensaje.
`code_length`	integer	(opcional) de 3 a 32 caracteres.
`allow_digits`	boolean	(opcional) Permitir números.
`allow_upper_case`	boolean	(opcional) Permite caracteres en mayúsculas.
`allow_lower_case`	boolean	(opcional) Permite los caracteres en minúsculas.
`allow_special_chars`	boolean	(opcional) Permitir caracteres especiales [! # $ % & ? @]
`remove_confusing_characters`	boolean	(opcional) Elimina los caracteres para los que el lector puede dudar:
`validity_period`	integer	(opcional) en segundos. Define el número de segundos después de los cuales el código expirará.
`max_wrong_attempts`	string	(opcional) Número máximo de intentos fallidos.
`recipient_ip`	string	(opcional) IP de su destinatario. Si el valor es distinto de cero, la IP debe ser idéntica cuando se comprueba.

Para cada uno de los campos opcionales, el valor por defecto utilizado será el que haya definido en su interfaz Octopush.

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/service/otp/generate' \ 
-H 'Content-Type: application/json' \ 
-H 'api-login: ******@email.org' \ 
-H 'api-key: ************' \ 
-H 'cache-control: no-cache' \ 
-d '
{
  "phone_number": "+33611223344",
    "text": "Hola, aquí tienes tu código para autentificarte en LESITE.com : {code}, expirará a las {hh:mm:ss}",
    "voice_language": "fr-FR",
    "voice_gender": "female",
    "sender": "OneTimePass",
    "channel": "voice_sms",
    "code_length": 10,
    "allow_digits": true,
    "allow_upper_case": false,
    "allow_lower_case": false,
    "allow_special_chars": false,
    "remove_confusing_characters": true,
    "validity_period": 600,
    "max_wrong_attempts": 3,
    "recipient_ip": "127.0.0.1"
}'

Code à copier-coller

curl -X POST 'https://api.octopush.com/v1/public/service/otp/generate' -H 'Content-Type: application/json' -H 'api-login: ******@email.org' -H 'api-key: ************' -H 'cache-control: no-cache' -d ' {"phone_number": "+33611223344", "text": "Hola, aquí tienes tu código para autentificarte en LESITE.com : {code}, expirará a las {hh:mm:ss}", "voice_language": "fr-FR", "voice_gender": "female", "sender": "OneTimePass", "channel": "voice_sms", "code_length": 10, "allow_digits": true, "allow_upper_case": false, "allow_lower_case": false, "allow_special_chars": false, "remove_confusing_characters": true, "validity_period": 600, "max_wrong_attempts": 3, "recipient_ip": "127.0.0.1"}'

Retour Server en json

Success : 200 Created

{
    "code": 0,
    "message": "success",
    "ticket_number": "sms_1111cccc6666bbb2222233333",
    "otp_request_token": "otp_2222cc888888dd11110000"
}

Failure : 400 BAD REQUEST

{
  "code": 400,
  "message": "Payload validation error.",
  "errors": {
    "phone_number": {
      "code": 410,
      "message": "This value should not be blank."
    }
  }
}

Parámetros devueltos

Campo	Tipo	Descripción
code	interger	Código de retorno de su solicitud. 0 === éxito.
message	string	Mensaje más explícito del error encontrado.
ticket_number	string	Ticket de la campaña
otp_request_token	string	Identificador de su solicitud. Será necesario para comprobar el código introducido por su visitante.

Menu

OTP / MFA – Enviar un código