Parametri spedizione sms con chiamata diretta dello script

Transcript

Parametri spedizione sms con chiamata diretta dello script
INVIO SMS CON CHIAMATA DIRETTA ALLO SCRIPT
La chiamata diretta allo script può essere effettuata in modo GET o POST. Il metodo POST è il più
sicuro dal punto di vista della sicurezza.
Invio sms a un numero o a una serie di numeri
url: http://www.gatewaysms.it/gateway.php?login=xxxxxxx&pwd=xxxxxxx
&testo=xxxxxxxxxxxxxxx&numero=xxxxxxxxx&mittente=xxxxxxxxxxxx
è possibile anche la chiamata tramite ssl con gli stessi parametri:
url: https://www.gatewaysms.it/gateway.php?login=xxxxxxx&pwd=xxxxxxx
&testo=xxxxxxxxxxxxxxx&numero=xxxxxxxxx&mittente=xxxxxxxxxxxx
Poiché si passano via internet le proprie credenziali di accesso, si consiglia di utilizzare la chiamata
https (crittata a 2048 bit)
PARAMETRI
login: login assegnato
pwd: password assegnata
testo: messaggio da inviare (max 160 caratteri) url encoded
numero: numero di cellulare nel formato zzzxxxyyyyyyyy dove zzz è il prefisso internazionale
(senza lo 0 e senza il + davanti al prefisso internazionale) xxx è il prefisso è yyyyyyy è il numero. E'
possibile inviare lo stesso messaggio a più numeri telefonici inserendo più numeri telefonici
separati dalla virgola. Si consiglia di non superare i 20 numeri per ogni chiamata dello script.
mittente: testo alfanumerico di 11 caratteri (non usare spazi e caratteri sopra ascii 128. Si
suggerisce di utilizzare solo lettere e numeri), oppure numero di cellulare compreso di prefisso
internazionale senza zeri iniziali e con il + iniziale. Se utilizzate il mittente numerico, poichè va
utilizzato il carattere '+', il mittente va passato url encoded.
PARAMETRI OPZIONALI
longtext: se settato a 1 permette di spedire messaggi fino a 480 caratteri. I testi più lunghi di 480
caratteri vengono troncati dopo il 480esimo carattere. Il costo viene calcolato con 1 credito sms
ogni 160 caratteri o frazione. Esempio un testo di 190 caratteri viene tariffato con 2 crediti.
è possibile aggiungere un campo per definire la data/ora di spedizione:
date=aaaammgghhii
dove:
aaaa=anno di 4 cifre
mm=mese di 2 cifre
gg=giorno di 2 cifre
hh=ora di 2 cifre
ii=minuti di 2 cifre
Vanno sempre rispettate le lunghezze indicate, altrimenti la spedizione del messaggio avverrà a una
data/ora non corretta. Per esempio per spedire un messaggio il 5 aprile 2009 alle ore 8 e 2 minuti, il
valore della variabile date è: 200904050802
credit: se settato a 1 ritorna oltre all'OK il numero di crediti disponibili nel formato Credit=xxx
dove xxx rappresenta il numero di crediti disponibili
ref: permette di inserire un indentificatore per la spedizione in formato alfanumerico di massimo 20
caratteri
Invio sms a un gruppo
E' possibile inviare un sms a un intero gruppo precedentemente configurato sul server. Il gruppo
deve essere stato creato tramite interfaccia web e deve contenere almeno un numero di telefono. Si
consiglia di non utilizzare lettere accentate nella definizione del nome del gruppo.
La sintassi è simile alla precedente:
url: https://www.gatewaysms.it/gateway.php?login=xxxxxxx&pwd=xxxxxxx
&testo=xxxxxxxxxxxxxxx&gruppo=xxxxxxxxx&mittente=xxxxxxxxxxxx
login: login assegnato
pwd: password assegnata
testo: messaggio da inviare (max 160 caratteri) url encoded
gruppo: nome esatto definito tramite interfaccia utente. Il sistema NON fa differenza tra maiuscolo
e minuscolo. La spedizione degli sms di un intero gruppo potrebbe comportare parecchio tempo. Si
consiglia pertanto di aumentare il tempo di latenza dello script chiamante per evitare perdite di sms
spediti.
mittente: testo alfanumerico di 11 caratteri (non usare spazi e caratteri sopra ascii 128. Si
suggerisce di utilizzare solo lettere e numeri), oppure numero di cellulare compreso di prefisso
internazionale senza zeri iniziali e con il + iniziale. Se utilizzate il mittente numerico, poichè va
utilizzato il carattere '+', il mittente va passato url encoded.
PARAMETRI OPZIONALI
longtext: se settato a 1 permette di spedire messaggi fino a 480 caratteri. I testi più lunghi di 480
caratteri vengono troncati dopo il 480esimo carattere. Il costo viene calcolato con 1 credito sms
ogni 160 caratteri o frazione. Esempio un testo di 190 caratteri viene tariffato con 2 crediti.
è possibile aggiungere un campo per definire la data/ora di spedizione:
date=aaaammgghhii
dove:
aaaa=anno di 4 cifre
mm=mese di 2 cifre
gg=giorno di 2 cifre
hh=ora di 2 cifre
ii=minuti di 2 cifre
Vanno sempre rispettate le lunghezze indicate, altrimenti la spedizione del messaggio avverrà a una
data/ora non corretta. Per esempio per spedire un messaggio il 5 aprile 2009 alle ore 8 e 2 minuti, il
valore della variabile date è: 200904050802
ref: permette di inserire un indentificatore per la spedizione in formato alfanumerico di massimo 20
caratteri
RISPOSTE
ERROR=1702 mancanza di crediti
ERROR=1703 login e/o password errate
ERROR=1704 manca il testo del messaggio
ERROR=1705 manca il numero di cellulare
ERROR=1706 gruppo non trovato
ERROR=1707 nessun numero telefonico presente nel gruppo richiesto
ERROR=1708 data di spedizione errata
ERROR=1709 sms verso una nazione/gestore non raggiungibile
ERROR=1710 il testo dell' sms contiene parole non consentite
OK messaggio spedito
NOTE
1) Per il mittente utilizzate solo le lettere e i numeri. Lo spazio NON è ammesso e viene
eliminato in fase di spedizione. Non usate lettere accentate o simboli !!!!!!!!
2) Non utilzzate accenti, trattini, apostofi eccetera nel mittente che alcuni gateway non
accettano: il messaggio non verrà consegnato ma verrà ugualmente addebitato in quanto
ricevuto dal gateway di spedizione.
3) Se utilizzate un mittente numerico ricordatevi di mettere anche il prefisso internazionale
preceduto dal '+'. Un mittente numerico senza il '+' iniziale genererà un errore a livello
gateway di ricezione: sms non spedito ma credito tolto perchè il rifiuto avviene a livello del
destinatario. Se utilizzate il mittente numerico, poichè va utilizzato il carattere '+', il mittente
va passato url encoded.
4) Se utilizzate caratteri diversi da 0-9A-z, dovete inviare il messaggio in UTF-8 altrimenti i
gateway riceventi potrebbero rifiutare/troncare il messaggio
5) Se è indispensabile la spedizione di caratteri accentati, assicuratevi della corretta codifica. In
caso contrario il messaggio può non essere accettato dal gateway di destinazione o essere
spedito troncato. Tenete presente che i caratteri accentati e i simboli sono calcolati come 2
caratteri, pertanto se utilizzate tutti i 160 caratteri, vi verrà un credito extra per la parte
eccedente i 160 caratteri o multipli. La tabella dei caratteri calcolati doppi è in fondo a
questo documento.
CONTROLLO DEI CREDITI DISPONIBILI
url: https://www.gatewaysms.it/gateway.php?login=xxxxxxx&pwd=xxxxxxx&t=3
RISPOSTA
Credit=xxxx dove xxxx è il numero di sms disponibili
REPORT DEGLI SMS SPEDITI
url: https://www.gatewaysms.it/report.php?
login=xxxxxxx&pwd=xxxxxxx&datestart=aaaammgg&dateend=aaaammgg
Tramite il programma report.php è possibile richiedere la lista degli sms spediti nell'intervallo di
due date. Per ragioni di banda e di occupazione server, l'intervallo massimo tra le due date deve
essere di 7 giorni.
I parametri da passare per la richiesta sono i seguenti:
login: login assegnato
pwd: password assegnata
datestart: data di inizio del report nel formato AAAAMMGG
dateend: data di fine del report nel formato AAAAMMGG
dove:
AAAA rappresenta l'anno con 4 cifre
MM rappresenta il mese di due cifre (per mesi inferiori a 10 aggiungere uno 0 prima del numero del
mese)
GG rappresenta il giorno di due cifre (per giorni inferiori a 10 aggiungere uno 0 prima del numero
del mese)
Anche se si desiderta il report di un solo giorno, dateend deve comunque essere presente. Nel caso
di singolo giorno, datestart e dateend conterranno gli stessi dati.
Il risultato viene inviato via web con una struttura XML come la seguente:
<Risposta>
<Line>
<Data>xxxxxxxxx</Data>
<Testo>xxxxxxxxxxxxxxxx</Testo>
<Destinatario>xxxxxxxxx</Destinatario>
<Esito>Consegnato</Esito> (*)
<Ref>xxxxxxxxxxxxx</Ref>
</Line>
</Risposta>
(*) il valore può essere:
Consegnato: sms ricevuto dal destinatario
NON CONSEGNATO: sms non ricevuto (numero errato, numero non attivo,eccetera)
In attesa di DR: sms acquisito per la spedizione ma non ancora consegnato (cellulare spento o fuori
copertura. Se sono passate più di 24 ore il messaggio non verrà più consegnato).
LA MANCATA CONSEGNA DI UN SMS NON COMPORTA NESSUN DIRITTO DI
RIACCREDITO IN QUANTO L'ADDEBITO REALTIVO ALLA SPEDIZIONE A NOI
VIENE COMUNQUE EFFETTUATO DAI GESTORI
ERRORI
1701 = manca la data di inizio
1702 = manca la data di fine
1703 = data di inizio errata
1704 = data di fine errata
1705 = intervallo tra le date superiore ai 7 giorni
1706 = data di fine inferiore alla data di inizio
1707 = login/pwd errati
1708 = nessun messaggio spedito nell'intervallo di date richiesto
INVIO SMS TRAMITE EMAIL
Va inviata una email a [email protected]
xxxxxxxxxx viene comunicato all’atto della configurazione
La struttura del messaggio deve essere la seguente:
oggetto: TEL=zzxxxyyyyyy
dove
zz è il prefisso internazionale (a richiesta possiamo forzare noi 39 per l’Italia). Il prefisso deve
essere passato SENZA lo 0 iniziale e senza il +
xxx prefisso
yyyyyyyy numero di celluare
corpo del messaggio: testo da spedire (massimo 160 caratteri), i caratteri oltre i 160 vengono
ignorati.
Non viene inviato nessun codice di risposta.
Si rammenta di spedire il messaggio in plain text altrimenti i primi 160 caratteri sono la definizione
del tipo di messaggio e NON il messaggio stesso !
La spedizione di sms tramite email è attivata solo su richiesta. Scriveteci indicando la vostra login
(nome utente) e vi verrà attivata gratuitamente questa funzione.
NOTE GENERALI
Nei limiti del possibile conviene NON utilizzare le lettere accentate in quanto non tutti i telefoni
visualizzano i caratteri accentati nello stesso modo. Si fa presente che il carattere & tronca il
testo del messaggio su molti cellulari. La parte che segue il carattere & non verrà visualizzata sul
cellulare del destinatario.
L'utilizzo dei caratteri accentati a causa delle diverse codifiche potrebbe non venire accettata dal
gestore. Si suggersice pertanto di effettuare un test sulla corretta codifica dei caratteri accentati
inviati per email utilizzando un sms di test sul vostro cellulare di servizio.Tenete presente che i
caratteri accentati e i simboli sono calcolati come 2 caratteri, pertanto se utilizzate tutti i 160
caratteri, vi verrà addebitato un credito extra per la parte eccedente i 160 caratteri o multipli. La
tabella dei caratteri calcolati doppi è in fondo a questo documento.
Elenco dei carattari calcolati doppi
Questa è la lista dei caratteri che i gateway calcolano doppio. Ogni carattere viene calcolato come 2
caratteri, pertanto dovete tenerne conto all'atto della spedizione: se utilizzate tutti i 160 caratteri il
sistema addebiterà un credito in più.
L'elevamento a potenza
^
codice ascii 94
La parentesi graffa aperta
{
codice ascii 123
La parentesi graffa chiusa
}
codice ascii 125
Il backslash
\
codice ascii 92
La parentesi quadra aperta
[
codice ascii 91
La parentesi quadra chiusa
]
codice ascii 93
La tilde
~
codice ascii 126
Il pipe
|
codice ascii 124
Il simbolo dell'euro
€
codice ascii 164
© 2013 gatewaysms.it a Servitel Limited division