HTTP API - akcija 'receivemessage'

To akcijo lahko uporabite za prejemanje SMS sporočil preko SMS prehoda z uporabo HTTP anketiranja. HTTP anketiranje pomeni, da prenesete SMS sporočila iz mapi prejeto v prehodu, kot bi prenesli spletno stran. V tem razdelku lahko dobite informacije o tem, kako lahko uporabite akcijo receivemessage, katere so parametri, in predstavljen vam bo primer HTTP zahteve za prenos dohodnih sporočil.

Opis

Za prenos dohodnih besedilnih sporočil uporabite naslednjo obliko URL-ja:

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

Namesto 127.0.0.1 morate vstaviti ime gostitelja ali IP naslov računalnika, na katerem je nameščen vaš SMS prehod. Številka vrata 9508 je privzeta HTTP številka vrata Ozeki SMS prehoda. Njegovo številko vrat lahko konfigurirate v uporabniškem vmesniku Ozeki 10 SMS prehoda, s klikom na gumb Napredno v orodni vrstici.

Uporabniško ime in geslo morate nadomestiti z "UUUUU" in "PPPPP". Uporabniško ime in geslo identificirata uporabnika, ki ste ga ustvarili v SMS prehodu. Ko pokličete akcijo receivemessage z klicem URL-ja, boste prenesli sporočila iz nabiralnika uporabnika, določenega v poizvedbi z uporabniškim imenom in geslom.

Parameter folder sporočila mora biti nastavljen na inbox.

Parameter limit določa število sporočil, ki bodo prenesena. Priporočljivo je, da v eni zahtevi prenesete manj kot 1000 sporočil. Preostala sporočila lahko prenesete v nadaljnjih zahtevah.

Parameter afterdownload lahko uporabite za odstranjevanje sporočil iz SMS prehoda, ko so bila uspešno prenesena.

Primer URL zahteve

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

Primer odziva

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>Pozdravljen svet</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>Drugo sporočilo</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Parametri zahteve

Parameter	Opis	Možne vrednosti	Primer	O/M*
action	Določa ukaz HTTP API	receivemessage	action=receivemessage	M
username	Določa uporabniško ime. Uporabniško ime in geslo se uporabljata za overitev uporabnika. Ko je uporabnik overjen, se sporočila prenesejo iz njegovega nabiralnika. Vrednost mora biti kodirana v URL-ju.	nizna vrednost, največja dolžina je 16 znakov	username=admin	M
password	Določa geslo. Uporabniško ime in geslo se uporabljata za overitev uporabnika. Ko je uporabnik overjen, se sporočila prenesejo iz njegovega nabiralnika. Vrednost mora biti kodirana v URL-ju.	nizna vrednost, največja dolžina je 16 znakov	password=abc123	M
folder	Določa ime mape. Privzeto se sporočila prenesejo iz mape inbox. Akcijo receivemessage lahko uporabite tudi za prenos sporočil iz drugih map.	inbox (privzeto) outbox deliveredtonetwork deliveredtohandset deliveryfailed	folder=inbox	O
limit	Določa največje število sporočil, ki jih je mogoče prenesti s strežnika v eni zahtevi. Preostala sporočila lahko prenesete z nadaljnjimi zahtevami.	celoštevilska vrednost, privzeta omejitev je 1000	limit=10	O
afterdownload	Določa način ravnanja s sporočili po uspešnem prenosu. Sporočila lahko izbrišete iz SMS prehoda; lahko jih označite kot prenesena in jih lahko pustite nespremenjena. Če jih pustite nespremenjene, se bodo ob naslednji zahtevi za prenos znova prenesla.	delete (privzeto) mark untouch	afterdownload=delete	O
responseformat	Lahko določite obliko dohodnih sporočil uporabnika.	xml, html, url-encoded	responseformat=xml	O

* M = Obvezen parameter, O = Izbirni parameter

Odgovorni parametri
(oblika xml odgovora)

Parameter	Opis	Možne vrednosti	Primer
message	Vsebuje eno samo sporočilo. Podatkovni del lahko vsebuje več sporočil. Število sporočil v podatkih sporočila je manjše ali enako vrednosti 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	Vsebuje referenco sporočila, ki se lahko uporablja za sledenje sporočilu v SMS prehodu. Ta referenca se uporablja tudi za identifikacijo poročil o dostavi v omrežje in dostavi na napravo ali za poizvedovanje informacij o sporočilu.	nizna vrednost, največja dolžina je 16 znakov	<messageid>ERFAV23D</messageid>
message.originator	Vsebuje telefonsko številko pošiljatelja. To je telefonska številka mobilnega telefona, ki je poslal sporočilo.	nizna vrednost, največja dolžina je 16 znakov	<recipient>06301234567</recipient>
message.recipient	Vsebuje naslov prejemnika. To je telefonska številka, na katero je bilo sporočilo poslano.	nizna vrednost, največja dolžina je 16 znakov	<recipient>06201112222</recipient>
message.messagetype	Vsebuje identifikator vrste sporočila, določen v Specifikaciji vrste mobilnih sporočil. V večini primerov bo to SMS:TEXT.	nizna vrednost, največja dolžina je 1024 znakov	<recipient>SMS:TEXT</recipient>
message.messagedata	Vsebuje podatke sporočila. Za besedilna sporočila je to besedilo SMS sporočila. Za druge vrste sporočil je to XML struktura, določena v Specifikaciji vrste mobilnih sporočil. Podatki sporočila so kodirani kot UTF8.	nizna vrednost	<messagedata>Hello world</messagedata>
message.senttime	Vsebuje časovni žig, ki pove, kdaj je bilo sporočilo poslano s telefona pošiljatelja.	Datum in čas v naslednjem formatu: YYYY-MM-DD hh:mm:ss	<senttime>2028-01-16 10:04:00</senttime>
message.receivedtime	Vsebuje časovni žig, ki pove, kdaj je bilo sporočilo prejeto s strani SMS prehoda.	Datum in čas v naslednjem formatu: YYYY-MM-DD hh:mm:ss	<senttime>2028-01-18 20:58:04</senttime>

Povzetek

V tem članku ste našli vse informacije, potrebne za uporabo akcije 'receivemessage' z našim HTTP SMS API.

S to rešitvijo lahko izkoristite prednosti http pollinga za prejemanje dohodnih besedilnih sporočil. Trudili smo se, da bi bilo čim bolj enostavno in da vas čim bolj brez težav popeljemo skozi vse podrobnosti. Če ste že dokončali korake, ste videli prednosti uporabe našega HTTP SMS API. Če še niste začeli z izdelavo vašega SMS sistema z uporabo API, ne zapravljajte časa. Začnite zdaj!

Če želite izvedeti več koristnih vpogledov o prednostih drugih podobnih SMS rešitev, odprite stran o pošiljanju sporočil z istim sistemom.

Upam, da bo ta stran koristna vsem bralcem in še posebej začetnikom.