HTTP API - akcija 'receivemessage'

Ova akcija se može koristiti za primanje SMS poruka sa SMS Gateway-a koristeći HTTP polling. HTTP polling znači da preuzimate SMS poruke iz inbox foldera gateway-a kao što biste preuzeli veb stranicu. U ovom odeljku možete dobiti informacije o tome kako možete koristiti akciju receivemessage, koji su parametri, i biće vam prikazan primer HTTP zahteva za preuzimanje dolaznih poruka.

Opis

Za preuzimanje dolaznih tekstualnih poruka, koristite sledeći format URL-a:

https://127.0.0.1:9508/api?action=receivemessage&username=UUUUU&password=PPPPP&
folder=inbox&limit=2&afterdownload=delete

Umesto 127.0.0.1, trebate zameniti ime hosta ili IP adresu računara na kome je instaliran vaš SMS gateway. Broj porta 9508 je podrazumevani HTTP port broj Ozeki SMS gateway-a. Njegov broj porta može biti konfigurisan u korisničkom interfejsu Ozeki 10 SMS Gateway-a, klikom na dugme Advanced u alatnoj traci.

Korisničko ime i lozinka trebaju biti zamenjeni umesto "UUUUU" i "PPPPP". Korisničko ime i lozinka identifikuju korisnika kojeg ste kreirali u SMS gateway-u. Kada pozovete akciju receivemessage pozivom URL-a, preuzimaćete poruke iz inbox-a korisnika određenog u upitu sa korisničkim imenom i lozinkom.

Parametar folder poruke treba da bude postavljen na inbox.

Parametar limit određuje broj poruka koje će biti preuzete. Preporučuje se da preuzmete manje od 1000 poruka u jednom zahtevu. Možete preuzeti preostale poruke u narednim zahtevima.

Parametar afterdownload može se koristiti za uklanjanje poruka iz SMS gateway-a nakon što su uspešno preuzete.

Primer URL zahteva

https://127.0.0.1:9508/api?action=receivemessage&username=admin&password=abc123&
folder=inbox&limit=2&afterdownload=delete

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

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/response.xml">
<response>
   <action>receivemessage</action>
   <data>
   <message>
   <messageid>ERFAV23D</messageid>
   <originator>06301234567</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Zdravo svete</messagedata>
         <senttime>2008-01-16 10:04:00</senttime>
         <receivedtime>2008-01-18 20:58:04</receivedtime>
      </message>
      <message>
         <messageid>GYT4455D</messageid>
         <originator>06209994444</originator>
         <recipient>06201112222</recipient>
         <messagetype>SMS:TEXT</messagetype>
         <messagedata>Druga poruka</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>
Parametri zahteva
Parametar Opis Moguće vrednosti Primer O/M*
action Određuje HTTP API komandu receivemessage action=receivemessage M
username Određuje korisničko ime. Korisničko ime i lozinka se koriste za autentifikaciju korisnika. Nakon što je korisnik autentifikovan poruke će biti preuzete iz njegovog inbox-a. Vrednost mora biti url-encoded. string vrednost, maksimalna dužina je 16 karaktera username=admin M
password Određuje lozinku. Korisničko ime i lozinka se koriste za autentifikaciju korisnika. Nakon što je korisnik autentifikovan poruke će biti preuzete iz njegovog inbox-a. Vrednost mora biti url-encoded. string vrednost, maksimalna dužina je 16 karaktera password=abc123 M
folder Određuje ime foldera. Podrazumevano, poruke će biti preuzete iz inbox foldera. Možete koristiti akciju receivemessage za preuzimanje poruka iz drugih foldera takođe. inbox (podrazumevano)
outbox
deliveredtonetwork
deliveredtohandset
deliveryfailed
 folder=inbox O
limit Određuje maksimalan broj poruka koje će biti preuzete sa servera unutar zahteva. Možete preuzeti preostale poruke u narednim zahtevima. celobrojna vrednost, podrazumevani limit je 1000 limit=10 O
afterdownload Određuje način na koji poruke treba da budu obrađene nakon uspešnog preuzimanja. Poruke mogu biti obrisane iz SMS gateway-a; mogu biti označene kao preuzete i mogu ostati nepromenjene. Ako ostanu nepromenjene, sledeći put kada pokrenete zahtev za preuzimanje one će biti ponovo preuzete.
 delete (podrazumevano)
mark
untouch
 afterdownload=delete O
responseformat Možete odrediti format korisnikovih dolaznih poruka. xml, html, url-encoded responseformat=xml O

* M = Obavezni parametar, O = Opcioni parametar

Параметри одговора
(xml формат одговора)

Параметар Опис Могуће вредности Пример
message Садржи једну поруку. Део са подацима може садржати више порука. Број порука у подацима поруке може бити мањи или једнак вредности параметра ограничења   
<message>
    <messageid>ERFAV23D</messageid>
    <originator>06301234567</originator>
    <recipient>06201112222</recipient>
    <messagetype>SMS:TEXT</messagetype>
    <messagedata>Hello world</messagedata>
    <senttime>2028-01-16 10:04:00</senttime>
    <receivedtime>2028-01-18 20:58:04</receivedtime>
</message>
message.messageid Садржи референцу поруке која се може користити за праћење поруке у SMS gateway-у. Ова референца поруке се такође користи за идентификацију извештаја о испоруци на мрежу и испоруци на уређај или за упит информација о поруци. стринг вредност, максимална дужина је 16 знакова <messageid>ERFAV23D</messageid>
message.originator Садржи број телефона пошиљаоца. Ово је број телефона мобилног телефона који је послао поруку. стринг вредност, максимална дужина је 16 знакова <recipient>06301234567</recipient>
message.recipient Садржи адресу примаоца. Ово је број телефона на који је порука послата. стринг вредност, максимална дужина је 16 знакова <recipient>06201112222</recipient>
message.messagetype Садржи идентификатор типа поруке наведен у Спецификацији типа мобилне поруке. У већини случајева ово ће бити SMS:TEXT. стринг вредност, максимална дужина је 1024 знака <recipient>SMS:TEXT</recipient>
message.messagedata Садржи податке поруке. За текстуалне поруке ово је текст SMS поруке. За друге типове порука ово је XML структура наведена у Спецификацији типа мобилне поруке. Подаци поруке су кодирани као UTF8. стринг вредност <messagedata>Hello world</messagedata>
message.senttime Садржи временску ознаку која каже када је порука послата са телефона пошиљаоца. Датум и време у следећем формату: YYYY-MM-DD hh:mm:ss <senttime>2028-01-16 10:04:00</senttime>
message.receivedtime Садржи временску ознаку која каже када је порука примљена од стране SMS gateway-а. Датум и време у следећем формату: YYYY-MM-DD hh:mm:ss <senttime>2028-01-18 20:58:04</senttime>
Резиме

У овом чланку, пронашли сте све информације неопходне за коришћење акције 'receivemessage' са нашим HTTP SMS API-јем.

Са овим решењем, можете искористити предности HTTP polling-а за примање долазних текстуалних порука. Дали смо све од себе да то буде једноставно и да вас проведемо кроз све детаље што је могуће безболније. Ако сте већ завршили кораке, видели сте предности коришћења нашег HTTP SMS API-ја. Ако још увек нисте почели са радом на довршавању вашег SMS система коришћењем API-ја, немојте губити време. Почните сада!

Ако желите да сазнате више корисних увида о предностима других сличних SMS решења, молимо отворите страницу о слању порука са истим системом.

Надам се да ће ова страница бити корисна свим читаоцима, а посебно почетницима.

More information