HTTP API - 'sendmessage' akcija

Ova HTTP API komanda se može koristiti za slanje SMS poruka putem SMS Gateway-a. Komanda može biti korišćena za slanje tekstualnih SMS poruka ili drugih tipova poruka, kao što su binarni SMS, operator logoi, ringtoni, WAP PUSH, itd... Kada koristite ovu komandu, morate koristiti HTTP API korisničko ime i lozinku, morate navesti broj telefona primaoca i tekst poruke.

Opis

Za slanje SMS-a, koristite sledeći URL format:

https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD


127.0.0.1 je lokalna IP adresa, zato je zamenite sa IP adresom ili imenom računara na kome je instaliran Ozeki SMS Gateway. (Napomena: 127.0.0.1 je lokalna loopback adresa koja se može koristiti kada se povezujete na SMS Gateway sa istog računara.) 9508 je podrazumevani port Ozeki SMS Gateway HTTP API-ja. Ovaj broj porta se može videti i izmeniti u Ozeki 10 SMS Gateway korisničkom interfejsu, klikom na dugme Advanced u alatnoj traci.

"UUUUU" i "PPPPP" treba zameniti sa korisničkim imenom i lozinkom korisnika koji ste kreirali u SMS gateway-u.

Zamenite "NNNNN" sa brojem telefona na koji želite poslati SMS poruku. Možete koristiti lokalni format telefonskog broja kao i internacionalni format telefonskog broja (telefonski brojevi formatirani prema internacionalnom formatu uvek počinju sa '+' znakom). Ako koristite internacionalni format telefonskog broja, imajte u vidu da morate zameniti '+' znak sa '%2B', zbog URL enkoding pravila.

Zamenite "MMMMM" sa tipom poruke. "SMS:TEXT" tip poruke treba koristiti za tekstualne poruke.

Podaci poruke sadrže poruku koju želite poslati. Stavite podatke poruke umesto "DDDDD". Podaci poruke treba da budu u UTF-8 formatu i treba da budu URL enkodirani.

Drugi parametri takođe mogu biti dodati u zahtev.
Za kompletnu listu dostupnih parametara pogledajte tabelu 'Request parameters' ispod:

Primer URL zahteva

https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World

Primer odgovora
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 246

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml">
<response>
   <action>sendmessage</action>
   <data>
      <acceptreport>
         <statuscode>0</statuscode>
         <statusmessage>Poruka prihvaćena za isporuku</statusmessage>
         <messageid>ERFAV23D</messageid>
         <recipient>06203105366</recipient>
      </acceptreport>
   </data>
</response>

HTTP parametri zahteva

Parametar Opis Moguće vrednosti Primer O/N*
action Određuje HTTP API komandu sendmessage action=sendmessage O
username Određuje korisničko ime. Korisničko ime i lozinka se koriste za autentifikaciju korisnika. Kada šaljete poruku, ona će biti poslata u ime autentifikovanog korisnika. Vrednost mora biti url-kodirana. tekstualna vrednost, maksimalna dužina je 16 karaktera username=admin O
password Određuje lozinku. Korisničko ime i lozinka se koriste za autentifikaciju korisnika. Kada šaljete poruku, ona će biti poslata u ime autentifikovanog korisnika. Vrednost mora biti url-kodirana. tekstualna vrednost, maksimalna dužina je 16 karaktera password=abc123 O
originator Određuje adresu pošiljaoca. Ova informacija će biti prikazana na mobilnom telefonu koji prima poruku. Ovo je adresa pošiljaoca. Može biti telefonski broj, kratki kod ili alfanumerička adresa pošiljaoca. Telefonski broj može biti formatiran u lokalnom formatu (npr.06201234567) ili u međunarodnom formatu (npr.+36201234567). Ako koristite alfanumeričku adresu pošiljaoca (npr.ozeki), karakteri moraju biti kodirani u UTF8 i vrednost mora biti url-kodirana. tekstualna vrednost, maksimalna dužina je 16 karaktera originator=%2B36201112222 N
recipient Određuje broj telefona primaoca. Poruka će biti poslata na ovaj telefonski broj. Telefonski broj može biti naveden u lokalnom formatu (npr.06201234567), ili u međunarodnom formatu (npr.+36201234567).
Više adresa primalaca može biti razdvojeno dvotačkom (npr.: +36201234567,+36202222222) ili tačkom-zarezom.
Vrednost mora biti url-kodirana.
tekstualna vrednost, maksimalna dužina je 16 karaktera recipient=%2B36201234567 O
messagetype Određuje tip poruke. Tip SMS poruke zasnovan na Specifikaciji tipa mobilne poruke. Za tekstualne poruke, podaci poruke će biti običan tekst, za druge tipove poruka to će biti XML dokument.
SMS:TEXT
SMS:WAPPUSH
...
Moguće vrednosti se mogu naći u Specifikaciji tipa mobilne poruke
messagetype=SMS:TEXT N
messagedata Određuje tekst ili podatke SMS poruke. Vrednost mora biti kodirana u UTF8 i mora biti url-kodirana. tekstualna vrednost, maksimalna dužina je 32768 karaktera messagedata=Hello+World O
_charset_ Određuje karakter set kodiranih podataka (ako nije navedeno, podrazumeva se utf-8). Noviji pregledači bi trebali automatski postaviti vrednost _charset_. Ako vaš pregledač ne podržava ovu funkciju, možete je ručno postaviti na:
utf-8
windows-1250
iso-8859-1
iso-8859-2
...
(Podržane vrednosti karakter seta)
_charset_=iso-8859-2 N
serviceprovider Određuje naziv GSM modema ili IP SMS provajdera veze koja će se koristiti za slanje poruke. Više informacija o izboru veze sa provajderom usluga je dostupno u HTTP SMS API - vodič za SMS rutiranje.

Vrednost mora odgovarati stringu navedenom u konfiguraciji forme veze sa provajderom usluga.
tekstualna vrednost, maksimalna dužina je 16 karaktera serviceprovider=Vodafone N
sendondate Određuje datum i vreme kada poruka treba da bude poslata.

Vrednost mora koristiti sledeći format datuma: YYYY-MM-DD hh:mm:ss. Vrednost mora biti url-kodirana
vrednost datuma u formatu YYYY-MM-DD hh:mm:ss sendondate=2018-12-12+10%3A07%3A05 N
responseformat Nakon što gateway pošalje SMS poruku, gateway će vratiti veb stranicu koja ukazuje na uspešno slanje poruke. Sadržaj veb stranice je formatiran prema parametru responseformat. Možete imati HTML tekstualni odgovor kako bi bio čitljiv za ljude ili možete imati XML format kako bi bio lakši za obradu softvera. xml (podrazumevano)
html
urlencoded
responseformat=xml N
continueurl Nakon što gateway pošalje SMS poruku, gateway će vratiti veb stranicu koja ukazuje na uspešno slanje poruke. Sadržaj veb stranice je formatiran prema parametru responseformat. Ako je parametar responseformat postavljen na html, veb stranica može sadržati link "Nastavi". Ako navedete URL u ovom parametru, link za nastavak će biti prikazan i pokazivaće na navedeni URL. Vrednost URL-a mora biti url-kodirana.

URL koji navedete može sadržati ključne reči koje će biti zamenjene informacijama o stanju koje odgovara poslatoj poruci. Više informacija o mogućim ključnim rečima možete naći u "Submit URL keywords" vodiču.
tekstualna vrednost, maksimalna dužina je 1024 karaktera continueurl=192.168.1.23

ili

continueurl=http%3A%2F%2Fwww.ozekisms.
com%2Findex.php%3Fowpn%3D159

Napomena: drugi primer sadrži url-kodiran URL.
N
redirecturl Nakon što gateway pošalje SMS poruku, podrazumevano će gateway vratiti veb stranicu koja ukazuje na uspešno slanje poruke. Opciono možete zatražiti od gateway-a da automatski preusmeri pregledač na URL koji navedete. Ako navedete URL u redirect parametru, HTTP odgovor koji vrati SMS gateway će sadržati URL za preusmeravanje u HTTP zaglavlju. Ovo će uputiti veb pregledač da prati link koji ste naveli. Vrednost URL-a mora biti url-kodirana.

URL koji navedete može sadržati ključne reči koje će biti zamenjene informacijama o stanju koje odgovara poslatoj poruci. Više informacija o mogućim ključnim rečima možete naći u "Submit URL keywords" vodiču.
tekstualna vrednost, maksimalna dužina je 1024 karaktera redirecturl=192.168.1.23

ili

redirecturl=http%3A%2F%2F192.168.1.23
%2Findex.php%3Fowpn%3D159

Napomena: drugi primer sadrži url-kodiran URL.
N
reporturl Možete podesiti veb stranicu za obradu informacija o događajima "isporučeno mreži" i "isporučeno uređaju". Ako navedete URL u parametru reporturl, vaša veb stranica će biti pozvana kada se ovi događaji dese. Vrednost URL-a koji navedete u parametru reporturl mora biti URL kodiran.

URL koji navedete može sadržati ključne reči koje će biti zamenjene informacijama o stanju koje odgovara poslatoj poruci.

Dobar primer kako koristiti opciju report URL možete naći u kako poslati zakazani SMS i koristiti reporturl funkcionalnost vodiču.
tekstualna vrednost, maksimalna dužina je 1024 karaktera reporturl=http%3A%2F%2Fwww.ozekisms.
com%2Fproc.php%3Freporttype%3D%24reporttype
%26messageid%3D%24messageid

Napomena: ovo je url-kodirana verzija sledećeg URL-a. Pre nego što ovaj URL bude pozvan od strane SMS gateway-a, parametri $reporttype i $messageid će biti zamenjeni odgovarajućim vrednostima:

http://192.168.1.23/proc.php?reporttype=$reporttype&
messageid=$messageid

biće pozvan kao:
http://192.168.1.23/proc.php?reporttype=deliveredtonetwork& messageid=ERFAV23D

Lista ključnih reči koje možete koristiti u reporturl su:
$reporttype
$messageid
$statuscode
$statusmessage
$fromstation
$fromconnection
$fromaddress
$tostation
$toconnection
$toaddress
$text
$createdate
$submitdate
$receiveddate
N
messagecount Određuje tačan broj poruka koje želite da pošaljete. Ako je postavljeno, potrebno je indeksiranje za parametre 'recipient', 'messagetype' i 'messagedata'. Detaljan 'messagecount' vodič možete naći ovde. broj
(podrazumevana vrednost:
1)
messagecount=6 N
maxresponse Ovaj broj određuje maksimalan broj poruka o kojima ćete dobiti povratnu informaciju. Ako premašite ovaj broj, vaše poruke će biti poslate, ali nećete dobiti povratnu informaciju o njima. Podrazumevano, ovaj parametar je postavljen na 500 poruka. broj maxresponse=1000 N
vp Određuje vreme važenja za vašu poruku.

Vrednost mora koristiti sledeći format datuma: YYYY.MM.DD hh:mm:ss. Vrednost mora biti url-kodirana.
Pročitajte ovaj vodič za više informacija.
vrednost datuma u formatu YYYY.MM.DD hh:mm:ss vp=2019.01.28.+10%3A07%3A05 N

* O = Obavezan parametar, N = Neobavezan parametar

Parametri odgovora
(xml format odgovora)

Parametar Opis Moguće vrednosti Primer
acceptreport Sadrži odgovor na zahtev za slanje za jednu adresu primaoca. Ako je navedeno više primalaca, acceptreport će biti uključen u odgovoru za svakog primaoca. Redosled acceptreport-ova će odgovarati redosledu adresa primalaca.  
<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Poruka prihvaćena za isporuku</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>
acceptreport.statuscode Sadrži celobrojnu vrednost koja označava uspeh ili neuspeh. Ako je vrednost 0, to znači da je poruka prihvaćena za isporuku. Ako je vrednost veća od 0, to znači da je došlo do greške i poruka nije prihvaćena za isporuku. Celobrojna vrednost, veća ili jednaka 0. Manja od 32768. <statuscode>0</statuscode>
acceptreport.statusmessage Sadrži tekstualni prikaz statusnog koda. Ako je poruka prihvaćena, vrednost će biti "Poruka prihvaćena za isporuku". Ako poruka nije prihvaćena za isporuku, u ovom polju možete pronaći poruku o grešci. tekstualna vrednost, maksimalna dužina je 1024 karaktera <statusmessage>Poruka prihvaćena za isporuku</statusmessage>
acceptreport.messageid Sadrži referencu poruke koja se može koristiti za praćenje poruke u SMS gateway-u. Ova referenca poruke se takođe koristi za identifikaciju izveštaja o isporuci u mrežu i na uređaj ili za upit o informacijama o poruci. tekstualna vrednost, maksimalna dužina je 16 karaktera <messageid>ERFAV23D</messageid>
acceptreport.recipient Sadrži adresu primaoca. tekstualna vrednost, maksimalna dužina je 16 karaktera <recipient>06203105366</recipient>
Sažetak

Ovaj članak je bio o HTTP API akciji 'sendmessage'. Sa ovom akcijom, možete slati tekstualne SMS poruke i mnoge druge vrste poruka bilo kom primaocu preko Ozeki SMS Gateway-a. Videli ste primere odgovora i još neke HTTP zahteve sa opisom, mogućim vrednostima i primerima.

Ako želite da saznate više o statusu isporuke vaših poruka, slobodno posetite stranicu o SMS statusima isporuke. Ako želite da dobijete URL šablon, posetite stranicu za to.

Ako želite da koristite ovo rešenje u stvarnim situacijama, preuzmite Ozeki SMS Gateway i počnite da ga koristite odmah!

More information