Documentation API-SMS : OTP / MFA - Envoyer un code

POST

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

Encodage : UTF-8

Authentification

La api-key et le api-login doivent être ajoutés dans un header.

Définition

Permet de générer et envoyer un code OTP à un destinataire, sur le canal de votre choix.

Paramètres

Nom	Type	Description
`phone_number`	string	Numéros de téléphone du destinataire
`channel`	string	(optionnel) Canal d’envoi de votre message [« text_sms », « voice_sms », « whatsapp », « email », « imessage »]
`text`	string	(optionnel) Vous pouvez y inclure les place holder {code} (le code OTP généré) et/ou {hh:mm:ss} (la date d’expiration de ce code). Laissez ce champ vide pour que seul le code soit envoyé.
`voice_language`	string	(optionnel) Langue de la voix utilisée dans le cas du 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	(optionnel) Genre de la voix [« male », « female »]
`sender`	string	(optionnel) Emetteur de votre message.
`code_length`	integer	(optionnel) de 3 à 32 caractères.
`allow_digits`	boolean	(optionnel) Autorise les chiffres.
`allow_upper_case`	boolean	(optionnel) Autorise les caractères majuscules.
`allow_lower_case`	boolean	(optionnel) Autorise les caractères minuscules.
`allow_special_chars`	boolean	(optionnel) Autorise les caractères spéciaux [! # $ % & ? @]
`remove_confusing_characters`	boolean	(optionnel) Supprime les caractères pour lesquels le lecteur peut hésiter :
`validity_period`	integer	(optionnel) en secondes. Définit le nombre de secondes après lequel le code sera expiré.
`max_wrong_attempts`	string	(optionnel) Nombre maximum de tentatives échouées.
`recipient_ip`	string	(optionnel) IP de votre destinataire. Si la valeur est non nulle, il faudra que l’IP soit identique lors de la vérification.

Pour chacun des champs optionnels, la valeur par défaut utilisée sera celle que vous avez défini sur votre interface Octopush.

Exemples 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": "Bonjour, voici votre code pour vous authentifier sur LESITE.com : {code}, il esxpira à {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": "Bonjour,  voici votre code pour vous authentifier sur LESITE.com : {code},  il expirrea à {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."
    }
  }
}

Paramètres retournés

Field	Type	Description
code	interger	Code retour de votre requête. 0 === succès.
message	string	Message plus explicite de l’erreur rencontrée.
ticket_number	string	Ticket de la campagne
otp_request_token	string	Identifier of your request. It will be needed to check the code entered by your visitor.

OTP / MFA – Envoyer un code