<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > JamioPlug > JamioPlug Message > SendOTPBySMS |
Invia un messaggio SMS contenente un Codice OTP di 6 cifre a un numero telefonico, dopo aver verificato la validità di un numero cellulare.
Metodo
PlugMessage/SendOTPBySMS
Input |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
token |
Token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto). |
String |
Y |
mobilePhoneNumber |
Testo che contiene il numero di telefono a cui inviare il messaggio, con prefisso internazionale (+39 per l'Italia). |
String |
|
senderId |
Identificativo del chiamante. Il valore di default è Jamio PaaS. |
String |
Y |
startMessage |
Testo che contiene la parte iniziale del messaggio da inviare. Il valore di default è “Per confermare il tuo numero di telefono 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.
Se il parametro testMode è true e il numero indicato nel parametro mobilePhoneNumber è valido, il messaggio sms non viene inviato e il returnValue restituisce una stringa random, invece dell'identificativo di verifica.
Il metodo si comporta come segue:
Restituisce |
Condizione |
Errore PLUG_WrongPhoneNumber |
Se il numero telefonico indicato nel parametro mobilePhoneNumber non è mobile.
|