HTTP API - akce 'receivemessage'

Tato akce může být použita k přijímání SMS zpráv ze SMS Gateway pomocí HTTP dotazování. HTTP dotazování znamená, že stahujete SMS zprávy ze složky doručené pošty brány, jako byste stahovali webovou stránku. V této části získáte informace o tom, jak můžete použít akci receivemessage, jaké jsou parametry, a bude vám předveden příklad HTTP požadavku pro stažení příchozích zpráv.

Popis

Pro stažení příchozích textových zpráv použijte následující formát URL:

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

Místo 127.0.0.1 byste měli dosadit název hostitele nebo IP adresu počítače, na kterém je vaše SMS brána nainstalována. Číslo portu 9508 je výchozí HTTP port Ozeki SMS brány. Jeho číslo lze konfigurovat v uživatelském rozhraní Ozeki 10 SMS Gateway kliknutím na tlačítko Pokročilé v panelu nástrojů.

Uživatelské jméno a heslo by měly být dosazeny za "UUUUU" a "PPPPP". Uživatelské jméno a heslo identifikují uživatele, kterého jste vytvořili v SMS bráně. Když vyvoláte akci receivemessage voláním URL, stáhnete zprávy z doručené pošty uživatele specifikovaného v dotazu pomocí uživatelského jména a hesla.

Parametr folder zprávy by měl být nastaven na inbox.

Parametr limit určuje počet zpráv, které budou staženy. Doporučuje se stáhnout méně než 1000 zpráv v jednom požadavku. Zbývající zprávy můžete stáhnout v následujících požadavcích.

Parametr afterdownload lze použít k odstranění zpráv z SMS brány po jejich úspěšném stažení.

Příklad URL požadavku

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

Příklad odpovědi

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>Hello world</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>Second message</messagedata>
         <senttime>2008-01-16 10:08:00</senttime>
         <receivedtime>2008-01-18 20:58:05</receivedtime>
      </message>
   </data>
</response>

Parametry požadavku

Parametr Popis Možné hodnoty Příklad P/V*
action Určuje příkaz HTTP API receivemessage action=receivemessage P
username Určuje uživatelské jméno. Uživatelské jméno a heslo se používají k ověření uživatele. Po ověření uživatele budou zprávy staženy z jeho doručené pošty. Hodnota musí být url-encoded. řetězcová hodnota, maximální délka je 16 znaků username=admin P
password Určuje heslo. Uživatelské jméno a heslo se používají k ověření uživatele. Po ověření uživatele budou zprávy staženy z jeho doručené pošty. Hodnota musí být url-encoded. řetězcová hodnota, maximální délka je 16 znaků password=abc123 P
folder Určuje název složky. Ve výchozím nastavení budou zprávy staženy ze složky doručené pošty. Akci receivemessage můžete použít také ke stažení zpráv z jiných složek. inbox (výchozí)
outbox
deliveredtonetwork
deliveredtohandset
deliveryfailed
 folder=inbox V
limit Určuje maximální počet zpráv, které mají být staženy ze serveru v rámci požadavku. Zbývající zprávy můžete stáhnout v následujících požadavcích. celočíselná hodnota, výchozí limit je 1000 limit=10 V
afterdownload Určuje způsob, jakým by měly být zprávy zpracovány po úspěšném stažení. Zprávy mohou být smazány z SMS brány; mohou být označeny jako stažené a mohou být ponechány beze změny. Pokud jsou ponechány beze změny, při příštím spuštění požadavku na stažení budou staženy znovu.
 delete (výchozí)
mark
untouch
 afterdownload=delete V
responseformat Můžete určit formát příchozích zpráv uživatele. xml, html, url-encoded responseformat=xml V

* P = Povinný parametr, V = Volitelný parametr

Parametry odpovědi
(formát odpovědi xml)
Parametr Popis Možné hodnoty Příklad
message Obsahuje jednu zprávu. Sekce dat může obsahovat mnoho zpráv. Počet zpráv v datech zprávy je menší nebo roven hodnotě parametru 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 Obsahuje referenci zprávy, kterou lze použít ke sledování zprávy v SMS bráně. Tato reference zprávy se také používá k identifikaci doručených zpráv do sítě a do ruky nebo k dotazování informací o zprávě. řetězcová hodnota, maximální délka je 16 znaků <messageid>ERFAV23D</messageid>
message.originator Obsahuje telefonní číslo odesílatele. Toto je telefonní číslo mobilního telefonu, který zprávu odeslal. řetězcová hodnota, maximální délka je 16 znaků <recipient>06301234567</recipient>
message.recipient Obsahuje adresu příjemce. Toto je telefonní číslo, na které byla zpráva odeslána. řetězcová hodnota, maximální délka je 16 znaků <recipient>06201112222</recipient>
message.messagetype Obsahuje identifikátor typu zprávy specifikovaný v Specifikaci typu mobilní zprávy. Ve většině případů to bude SMS:TEXT. řetězcová hodnota, maximální délka je 1024 znaků <recipient>SMS:TEXT</recipient>
message.messagedata Obsahuje data zprávy. Pro textové zprávy je to text SMS zprávy. Pro jiné typy zpráv je to XML struktura specifikovaná v Specifikaci typu mobilní zprávy. Data zprávy jsou kódována jako UTF8. řetězcová hodnota <messagedata>Hello world</messagedata>
message.senttime Obsahuje časové razítko, které udává, kdy byla zpráva odeslána z telefonu odesílatele. Datum a čas ve formátu: YYYY-MM-DD hh:mm:ss <senttime>2028-01-16 10:04:00</senttime>
message.receivedtime Obsahuje časové razítko, které udává, kdy byla zpráva přijata SMS bránou. Datum a čas ve formátu: YYYY-MM-DD hh:mm:ss <senttime>2028-01-18 20:58:04</senttime>

Shrnutí

V tomto článku jste našli všechny informace potřebné k použití akce ‘receivemessage’ s naším HTTP SMS API.

S tímto řešením můžete využít výhod http dotazování k přijímání příchozích textových zpráv. Udělali jsme vše pro to, aby to bylo jednoduché a abychom vás provedli všemi detaily co nejpříjemněji. Pokud jste již kroky dokončili, viděli jste výhody používání našeho HTTP SMS API. Pokud jste ještě nezačali pracovat na dokončení vašeho SMS systému pomocí API, neztrácejte čas. Začněte nyní!

Pokud byste se chtěli dozvědět více užitečných informací o výhodách dalších podobných SMS řešení, navštivte stránku o odesílání zpráv se stejným systémem.

Doufám, že tato stránka bude užitečná pro všechny čtenáře a zejména pro začátečníky.

More information