SendOTPByEmail

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Message >

SendOTPByEmail

Invia a un indirizzo di posta elettronica un messaggio email, contenente un Codice OTP di 6 cifre.

 

Metodo

PlugMessage/SendOTPByEmail

 

Input

Nome

Descrizione

Tipo

Opzionale

token

Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

emailAddress

Testo che contiene l'indirizzo email a cui inviare il messaggio.

String

 

senderId

Identificativo del chiamante. Il valore di default è Jamio PaaS.

String

Y

subject

Testo che contiene l'oggetto del messaggio da inviare. Il valore di default è "Codice di conferma mail".

String

Y

startMessage

Testo che contiene la parte iniziale del messaggio da inviare.

Il valore di default è “Per confermare la tua mail utilizza il codice ''

String

Y

endMessage

Testo che contiene la parte finale del messaggio da inviare.

String

Y

fields

Dato strutturato che consente di sostituire eventuali placeholder, presenti nei parametri startMessage e endMessage, con il corrispondente elemento presente nella struttura dati, avente nome uguale a quello del placeholder.

Dataset

Y

testMode

True se il messaggio non deve essere inviato realmente. Il valore di default è false.

Boolean

Y

Output

 

Nome

Descrizione

Tipo

 

returnValue

Testo che contiene l'identificativo di verifica.

String

 

 

Commenti

Il messaggio inviato è strutturato nella forma <StartMessage> Code <EndMessage>, ove StartMessage e EndMessage sono le stringhe passate ai parametri startMessage e endMessage e Code è il codice OTP aggiunto dal metodo nel messaggio.

Il codice OTP è di 6 caratteri e la sua validità è 10 min.

Il mittente del messaggio è quello impostato nella configurazione del plug (di solito notify@jamio.com).

 

Se il parametro testMode è true, il messaggio email non viene inviato e il returnValue restituisce una stringa random invece dell' identificativo di verifica.