HTTP API - akcija 'receivemessage'

Ova akcija može se koristiti za primanje SMS poruka putem SMS pristupnika koristeći HTTP anketiranje. HTTP anketiranje znači da preuzimate SMS poruke iz mapi pristupnika kao što biste preuzeli web stranicu. U ovom odjeljku možete dobiti informacije o tome kako možete koristiti akciju receivemessage, koji su parametri, te bit će vam prikazan primjer HTTP zahtjeva za preuzimanje dolaznih poruka.

Opis

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

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

Umjesto 127.0.0.1, trebate zamijeniti ime računala ili IP adresu računala na kojem je instaliran vaš SMS pristupnik. Broj porta 9508 je zadani HTTP broj porta Ozeki SMS pristupnika. Njegov broj porta može se konfigurirati u korisničkom sučelju Ozeki 10 SMS pristupnika, klikom na gumb Napredno u alatnoj traci.

Korisničko ime i lozinka trebaju se zamijeniti umjesto "UUUUU" i "PPPPP". Korisničko ime i lozinka identificiraju korisnika kojeg ste kreirali u SMS pristupniku. Kada pokrenete akciju receivemessage pozivanjem URL-a, preuzet ćete poruke iz pristigle pošte korisnika određenog u upitu s korisničkim imenom i lozinkom.

Parametar folder poruke treba biti postavljen na inbox.

Parametar limit određuje broj poruka koje će biti preuzete. Preporuča se preuzimanje manje od 1000 poruka u jednom zahtjevu. Možete preuzeti preostale poruke u sljedećim zahtjevima.

Parametar afterdownload može se koristiti za uklanjanje poruka iz SMS pristupnika nakon što su uspješno preuzete.

Primjer URL zahtjeva

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

Primjer 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>Pozdrav svijete</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 zahtjeva

Parametar Opis Moguće vrijednosti Primjer O/M*
action Određuje HTTP API naredbu receivemessage action=receivemessage M
username Određuje korisničko ime. Korisničko ime i lozinka koriste se za autentifikaciju korisnika. Nakon što je korisnik autentificiran poruke će se preuzimati iz njegove pristigle pošte. Vrijednost mora biti kodirana u URL-u. niz znakova, maksimalna duljina je 16 znakova username=admin M
password Određuje lozinku. Korisničko ime i lozinka koriste se za autentifikaciju korisnika. Nakon što je korisnik autentificiran poruke će se preuzimati iz njegove pristigle pošte. Vrijednost mora biti kodirana u URL-u. niz znakova, maksimalna duljina je 16 znakova password=abc123 M
folder Određuje naziv mape. Prema zadanim postavkama, poruke će se preuzimati iz mape inbox. Možete koristiti akciju receivemessage za preuzimanje poruka iz drugih mapa također. inbox (zadano)
outbox
deliveredtonetwork
deliveredtohandset
deliveryfailed
 folder=inbox O
limit Određuje maksimalni broj poruka koje će biti preuzete s poslužitelja unutar zahtjeva. Možete preuzeti preostale poruke u sljedećim zahtjevima. cjelobrojna vrijednost, zadani limit je 1000 limit=10 O
afterdownload Određuje način na koji poruke trebaju biti obrađene nakon uspješnog preuzimanja. Poruke mogu biti izbrisane iz SMS pristupnika; mogu biti označene kao preuzete i mogu ostati nepromijenjene. Ako ostanu nepromijenjene, sljedeći put kada pokrenete zahtjev za preuzimanje ponovno će biti preuzete.
 delete (zadano)
mark
untouch
 afterdownload=delete O
responseformat Možete odrediti format dolaznih poruka korisnika. xml, html, url-encoded responseformat=xml O

* M = Obvezan parametar, O = Neobvezan parametar

Parametri odgovora
(xml format odgovora)
Parametar Opis Moguće vrijednosti Primjer
message Sadrži jednu poruku. Odjeljak s podacima može sadržavati više poruka. Broj poruka u podacima poruke može biti manji ili jednak vrijednosti parametra limit   
<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 Sadrži referencu poruke koja se može koristiti za praćenje poruke u SMS pristupniku. Ova referenca poruke također se koristi za identifikaciju izvješća o isporuci u mrežu i isporuci na uređaj ili za upit informacija o poruci. string vrijednost, maksimalna duljina je 16 znakova <messageid>ERFAV23D</messageid>
message.originator Sadrži telefonski broj pošiljatelja. Ovo je telefonski broj mobitela koji je poslao poruku. string vrijednost, maksimalna duljina je 16 znakova <recipient>06301234567</recipient>
message.recipient Sadrži adresu primatelja. Ovo je telefonski broj na koji je poruka poslana. string vrijednost, maksimalna duljina je 16 znakova <recipient>06201112222</recipient>
message.messagetype Sadrži identifikator tipa poruke naveden u Specifikaciji tipa mobilne poruke. U većini slučajeva to će biti SMS:TEXT. string vrijednost, maksimalna duljina je 1024 znaka <recipient>SMS:TEXT</recipient>
message.messagedata Sadrži podatke poruke. Za tekstualne poruke ovo je tekst SMS poruka. Za druge tipove poruka ovo je XML struktura navedena u Specifikaciji tipa mobilne poruke. Podaci poruke su kodirani kao UTF8. string vrijednost <messagedata>Hello world</messagedata>
message.senttime Sadrži vremensku oznaku koja govori kada je poruka poslana s telefona pošiljatelja. Vremenska vrijednost u sljedećem formatu: YYYY-MM-DD hh:mm:ss <senttime>2028-01-16 10:04:00</senttime>
message.receivedtime Sadrži vremensku oznaku koja govori kada je poruka primljena od strane SMS pristupnika. Vremenska vrijednost u sljedećem formatu: YYYY-MM-DD hh:mm:ss <senttime>2028-01-18 20:58:04</senttime>

Sažetak

U ovom članku pronašli ste sve informacije potrebne za korištenje akcije 'receivemessage' s našim HTTP SMS API-jem.

S ovim rješenjem možete iskoristiti prednosti http ankete za primanje dolaznih tekstualnih poruka. Dali smo sve od sebe kako bismo to učinili jednostavnim i kako bismo vas što bezbolnije proveli kroz sve detalje. Ako ste već prošli korake, vidjeli ste prednosti korištenja našeg HTTP SMS API-ja. Ako tek trebate početi raditi na dovršavanju svog SMS sustava pomoću API-ja, nemojte gubiti vrijeme. Počnite sada!

Ako želite saznati više korisnih uvida o prednostima drugih sličnih SMS rješenja, molimo otvorite stranicu o slanju poruka s istim sustavom.

Nadam se da će ova stranica biti korisna svim čitateljima, a posebno početnicima.

More information