HTTP API - akcija 'sendmessage'

Ova http api naredba može se koristiti za slanje SMS poruka putem SMS pristupnika. Naredba može se koristiti za slanje tekstualnih SMS poruka ili drugih vrsta poruka, kao što su binarne SMS poruke, logotipi operatera, melodije zvona, WAP PUSH, itd... Kada koristite ovu naredbu, morate koristiti http api korisničko ime i lozinku, morate navesti broj telefona primatelja i tekst poruke.

Opis

Za slanje SMS-a koristite sljedeći format URL-a:

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, stoga je zamijenite s IP adresom ili imenom računala na kojem je instaliran Ozeki SMS pristupnik. (Napomena: 127.0.0.1 je lokalna povratna adresa koja se može koristiti kada se spajate na SMS pristupnik s istog računala.) 9508 je zadani port HTTP API-ja Ozeki SMS pristupnika. Ovaj broj porta može se pregledati i urediti u korisničkom sučelju Ozeki 10 SMS pristupnika, klikom na gumb Napredno u alatnoj traci.

"UUUUU" i "PPPPP" treba zamijeniti korisničkim imenom i lozinkom korisnika kojeg ste kreirali u SMS pristupniku.

Zamijenite "NNNNN" s brojem telefona na koji želite poslati SMS poruku. Možete koristiti lokalni format telefonskog broja kao i međunarodni format telefonskog broja (telefonski brojevi formatirani prema međunarodnom formatu uvijek počinju znakom '+'). Ako koristite međunarodni format telefonskog broja, imajte na umu da morate zamijeniti '+' znak s '%2B', zbog pravila URL kodiranja.

Zamijenite "MMMMM" s vrstom poruke. Za tekstualne poruke koristite vrstu poruke "SMS:TEXT".

Podaci poruke sadrže poruku koju želite poslati. Umjesto "DDDDD" upišite podatke poruke. Podaci poruke trebaju koristiti UTF-8 znakove i trebaju biti URL kodirani.

U zahtjev se mogu dodati i drugi parametri.
Za potpuni popis dostupnih parametara pogledajte tablicu 'Parametri zahtjeva' u nastavku:

Primjer URL zahtjeva

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

Primjer 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>
Parametri HTTP zahtjeva
Parametar Opis Moguće vrijednosti Primjer O/M*
action Određuje HTTP API naredbu sendmessage action=sendmessage O
username Određuje korisničko ime. Korisničko ime i lozinka koriste se za autentifikaciju korisnika. Kada šaljete poruku, bit će poslana u ime autentificiranog korisnika. Vrijednost mora biti url-kodirana. tekstualna vrijednost, maksimalna duljina je 16 znakova username=admin O
password Određuje lozinku. Korisničko ime i lozinka koriste se za autentifikaciju korisnika. Kada šaljete poruku, bit će poslana u ime autentificiranog korisnika. Vrijednost mora biti url-kodirana. tekstualna vrijednost, maksimalna duljina je 16 znakova password=abc123 O
originator Određuje adresu pošiljatelja. Ova informacija će biti prikazana na mobilnom telefonu koji prima poruku. Ovo je adresa pošiljatelja. Može biti telefonski broj, kratki broj ili alfanumerička adresa pošiljatelja. Telefonski broj može biti formatiran u lokalnom brojčanom formatu (npr. 06201234567) ili u međunarodnom brojčanom formatu (npr. +36201234567). Ako koristite alfanumeričku adresu pošiljatelja (npr. ozeki), znakovi moraju biti kodirani u UTF8 i vrijednost mora biti url-kodirana. tekstualna vrijednost, maksimalna duljina je 16 znakova originator=%2B36201112222 M
recipient Određuje telefonski broj primatelja. Poruka će biti poslana na ovaj telefonski broj. Telefonski broj može biti specificiran u lokalnom brojčanom formatu (npr. 06201234567) ili u međunarodnom brojčanom formatu (npr. +36201234567).
Više adresa primatelja može biti odvojeno dvotočkom (npr.: +36201234567,+36202222222) ili točkom-zarezom.
Vrijednost mora biti url-kodirana. 		tekstualna vrijednost, maksimalna duljina je 16 znakova recipient=%2B36201234567 O
messagetype Određuje vrstu poruke. Vrsta podataka SMS poruke temelji se na Specifikaciji vrste mobilne poruke. Za tekstualne poruke podaci poruke bit će običan tekst, za ostale vrste poruka bit će XML dokument.
SMS:TEXT
SMS:WAPPUSH
...
Moguće vrijednosti možete pronaći u Specifikaciji vrste mobilne poruke 		messagetype=SMS:TEXT M
messagedata Određuje tekst ili podatke SMS poruke. Vrijednost mora biti kodirana u UTF8 i mora biti url-kodirana. tekstualna vrijednost, maksimalna duljina je 32768 znakova messagedata=Hello+World O
_charset_ Određuje znakovni skup kodiranih podataka (ako nije specificirano, pretpostavlja se utf-8). Noviji preglednici bi trebali automatski postavljati vrijednost _charset_. Ako vaš preglednik ne podržava ovu mogućnost, možete je ručno postaviti na:
 utf-8
windows-1250
iso-8859-1
iso-8859-2
...
(Podržane vrijednosti znakovnih skupova) 		_charset_=iso-8859-2 M
serviceprovider Određuje naziv GSM modema ili IP SMS pružatelja usluge veze koja će se koristiti za slanje poruke. Više informacija o odabiru veze pružatelja usluge dostupno je u HTTP SMS API - Vodič za usmjeravanje SMS-a.

Vrijednost mora odgovarati nizu specificiranom na konfiguracijskom obrascu veze pružatelja usluge. 		tekstualna vrijednost, maksimalna duljina je 16 znakova serviceprovider=Vodafone M
sendondate Određuje datum i vrijeme kada poruka treba biti poslana.

Vrijednost mora koristiti sljedeći format datuma: YYYY-MM-DD hh:mm:ss. Vrijednost mora biti url-kodirana 		vrijednost datuma u formatu YYYY-MM-DD hh:mm:ss sendondate=2018-12-12+10%3A07%3A05 M
responseformat Nakon što pristupnik pošalje SMS poruku, pristupnik će vratiti web stranicu koja pokazuje da je poruka uspješno poslana. Sadržaj web stranice formatiran je prema parametru responseformat. Možete imati HTML tekstualni odgovor kako bi ga ljudi lakše čitali ili možete imati XML format kako bi softver lakše obradio odgovor. xml (zadano)
html
urlencoded 		responseformat=xml M
continueurl Nakon što pristupnik pošalje SMS poruku, pristupnik će vratiti web stranicu koja pokazuje da je poruka uspješno poslana. Sadržaj web stranice formatiran je prema parametru responseformat. Ako je parametar responseformat postavljen na html, web stranica može sadržavati poveznicu "Nastavi". Ako navedete URL u ovom parametru, poveznica "Nastavi" bit će prikazana i upućivat će na navedeni URL. Vrijednost URL-a mora biti url-kodirana.

URL koji navedete može sadržavati ključne riječi koje će biti zamijenjene informacijama o stanju koje odgovaraju poslanoj poruci. Više informacija o mogućim ključnim riječima možete pronaći u vodiču "Ključne riječi URL-a za slanje". 		tekstualna vrijednost, maksimalna duljina je 1024 znaka continueurl=192.168.1.23

ili

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

Napomena: drugi primjer sadrži url-kodirani URL. 		M
redirecturl Nakon što pristupnik pošalje SMS poruku, prema zadanim postavkama pristupnik će vratiti web stranicu koja pokazuje da je poruka uspješno poslana. Opcionalno možete zatražiti od pristupnika da automatski preusmjeri preglednik na URL koji navedete. Ako navedete URL u parametru redirect, HTTP odgovor koji vrati SMS pristupnik sadržavat će URL za preusmjeravanje u HTTP zaglavlju. Ovo će uputiti web preglednik da slijedi poveznicu koju ste naveli. Vrijednost URL-a mora biti url-kodirana.

URL koji navedete može sadržavati ključne riječi koje će biti zamijenjene informacijama o stanju koje odgovaraju poslanoj poruci. Više informacija o mogućim ključnim riječima možete pronaći u vodiču "Ključne riječi URL-a za slanje". 		tekstualna vrijednost, maksimalna duljina je 1024 znaka redirecturl=192.168.1.23

ili

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

Napomena: drugi primjer sadrži url-kodirani URL. 		M
reporturl Možete postaviti web stranicu za obradu informacija o događajima "dostavljeno u mrežu" i "dostavljeno na uređaj". Ako navedete URL u parametru reporturl, vaša web stranica bit će pozvana kada se ti događaji dogode. Vrijednost URL-a koji navedete u parametru reporturl mora biti URL kodirana.

URL koji navedete može sadržavati ključne riječi koje će biti zamijenjene informacijama o stanju koje odgovaraju poslanoj poruci.

Dobar primjer kako koristiti opciju report URL možete pronaći u vodiču kako poslati zakazani SMS i koristiti funkcionalnost reporturl. 		tekstualna vrijednost, maksimalna duljina je 1024 znaka reporturl=http%3A%2F%2Fwww.ozekisms.
com%2Fproc.php%3Freporttype%3D%24reporttype
%26messageid%3D%24messageid

Napomena: ovo je url-kodirana verzija sljedećeg URL-a. Prije nego što SMS pristupnik pozove ovaj URL, parametri $reporttype i $messageid bit će zamijenjeni odgovarajućim vrijednostima:

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

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

Popis ključnih riječi koje možete koristiti u reporturl:
$reporttype
$messageid
$statuscode
$statusmessage
$fromstation
$fromconnection
$fromaddress
$tostation
$toconnection
$toaddress
$text
$createdate
$submitdate
$receiveddate
 		M
messagecount Određuje točan broj poruka koje želite poslati. Ako je postavljeno, potrebno je indeksiranje za parametre 'recipient', 'messagetype' i 'messagedata'. Detaljan vodič o 'messagecount' možete pronaći ovdje. broj
(zadana vrijednost:
1)		 messagecount=6 M
maxresponse Ovaj broj određuje maksimalni broj poruka o kojima ćete dobiti povratne informacije. Ako premašite ovaj broj, vaše poruke će biti poslane, ali nećete dobiti povratne informacije o njima. Prema zadanim postavkama, ovaj parametar je postavljen na 500 poruka. broj maxresponse=1000 M
vp Određuje vrijeme valjanosti za vašu poruku.

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

* O = Obvezni parametar, M = Neobvezni parametar

Parametri odgovora
(xml format odgovora)
Parametar Opis Moguće vrijednosti Primjer
acceptreport Sadrži odgovor na zahtjev za slanje za jednu adresu primatelja. Ako je navedeno više primatelja, acceptreport će biti uključen u odgovoru za svakog primatelja. Redoslijed acceptreport-a odgovarat će redoslijedu adresa primatelja.   
<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Poruka prihvaćena za dostavu</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>
acceptreport.statuscode Sadrži cjelobrojnu vrijednost koja označava uspjeh ili neuspjeh. Ako je vrijednost 0, znači da je poruka prihvaćena za dostavu. Ako je vrijednost veća od 0, znači da je došlo do greške i poruka nije prihvaćena za dostavu. Cjelobrojna vrijednost, veća ili jednaka 0. Manja od 32768. <statuscode>0</statuscode>
acceptreport.statusmessage Sadrži tekstualni prikaz statusnog koda. Ako je poruka prihvaćena, vrijednost će biti "Poruka prihvaćena za dostavu". Ako poruka nije prihvaćena za dostavu, u ovom polju možete pronaći poruku o grešci. tekstualna vrijednost, maksimalna duljina je 1024 znaka <statusmessage>Poruka prihvaćena za dostavu</statusmessage>
acceptreport.messageid Sadrži referencu poruke koja se može koristiti za praćenje poruke u SMS gateway-u. Ova referenca poruke također se koristi za identifikaciju izvješća o dostavi na mrežu i dostavi na uređaj ili za upit o informacijama o poruci. tekstualna vrijednost, maksimalna duljina je 16 znakova <messageid>ERFAV23D</messageid>
acceptreport.recipient Sadrži adresu primatelja. tekstualna vrijednost, maksimalna duljina je 16 znakova <recipient>06203105366</recipient>

Sažetak

Ovaj članak govori o HTTP API akciji 'sendmessage'. S ovom akcijom možete poslati tekstualne SMS poruke i mnoge druge vrste poruka bilo kojim primateljima putem Ozeki SMS Gateway-a. Vidjeli ste primjere odgovora i neke dodatne HTTP zahtjeve s opisom, mogućim vrijednostima i primjerima.

Ako želite saznati više o statusu dostave vaših poruka, slobodno posjetite stranicu o statusima SMS dostave. Ako želite dobiti URL predložak, posjetite stranicu za njega.

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

More information