HTTP API - acțiunea 'receivemessage'

Această acțiune poate fi utilizată pentru a primi mesaje SMS de la SMS Gateway folosind sondarea HTTP. Sondarea HTTP înseamnă că descărcați mesaje SMS din dosarul inbox al gateway-ului, la fel cum ați descărca o pagină web. În această secțiune puteți obține informații despre cum puteți utiliza acțiunea receivemessage, care sunt parametrii și vi se va prezenta un exemplu de cerere HTTP pentru a descărca mesajele primite.

Descriere

Pentru a descărca mesaje text primite, utilizați următorul format de URL:

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

Pentru 127.0.0.1, ar trebui să înlocuiți numele gazdei sau adresa IP a computerului pe care este instalat gateway-ul SMS. Numărul de port 9508 este portul HTTP implicit al gateway-ului SMS Ozeki. Numărul său de port poate fi configurat în interfața utilizator a Ozeki 10 SMS Gateway, făcând clic pe butonul Avansat din bara de instrumente.

Numele de utilizator și parola ar trebui înlocuite pentru "UUUUU" și "PPPPP". Numele de utilizator și parola identifică utilizatorul pe care l-ați creat în gateway-ul SMS. Când invocați acțiunea receivemessage prin apelarea URL-ului, veți descărca mesaje din inbox-ul utilizatorului specificat în interogare cu numele de utilizator și parola.

Parametrul folder al mesajului ar trebui setat la inbox.

Parametrul limit specifică numărul de mesaje care vor fi descărcate. Este recomandat să descărcați mai puțin de 1000 de mesaje într-o singură cerere. Puteți descărca mesajele rămase în cereri ulterioare.

Parametrul afterdownload poate fi utilizat pentru a elimina mesajele din gateway-ul SMS după ce au fost descărcate cu succes.

Exemplu de cerere URL

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

Exemplu de răspuns

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>Salut lume</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>Al doilea mesaj</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Parametrii cererii

<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>