HTTP API - akcia 'receivemessage'

Táto akcia sa používa na prijímanie SMS správ zo SMS brány pomocou HTTP dotazovania. HTTP dotazovanie znamená, že sťahujete SMS správy z priečinka doručenej pošty brány, podobne ako by ste sťahovali webovú stránku. V tejto časti nájdete informácie o tom, ako môžete použiť akciu receivemessage, aké sú parametre, a bude vám predložený príklad HTTP požiadavky na stiahnutie prichádzajúcich správ.

Popis

Na stiahnutie prichádzajúcich textových správ použite nasledujúci formát URL:

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

Namiesto 127.0.0.1 by ste mali dosadiť názov hostiteľa alebo IP adresu počítača, na ktorom je nainštalovaná vaša SMS brána. Číslo portu 9508 je predvolené HTTP číslo portu Ozeki SMS brány. Jeho číslo portu je možné konfigurovať v užívateľskom rozhraní Ozeki 10 SMS brány, kliknutím na tlačidlo Pokročilé v paneli nástrojov.

Užívateľské meno a heslo by mali byť nahradené za "UUUUU" a "PPPPP". Užívateľské meno a heslo identifikujú užívateľa, ktorého ste vytvorili v SMS bráne. Keď vyvoláte akciu receivemessage volaním URL, budete sťahovať správy z doručenej pošty užívateľa špecifikovaného v dotaze pomocou užívateľského mena a hesla.

Parameter folder správy by mal byť nastavený na inbox.

Parameter limit určuje počet správ, ktoré budú stiahnuté. Odporúča sa stiahnuť menej ako 1000 správ v jednej požiadavke. Zvyšné správy môžete stiahnuť v následných požiadavkách.

Parameter afterdownload môže byť použitý na odstránenie správ z SMS brány po ich úspešnom stiahnutí.

Príklad URL požiadavky

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

Príklad odpovede

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>Ahoj 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>Druhá správa</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Parametre požiadavky