HTTP API - 'sendmessage' művelet
Ez a http api parancs SMS üzenetek küldésére használható az SMS Gateway-en keresztül. A parancs szöveges SMS üzenetek vagy más típusú üzenetek küldésére is használható, például bináris SMS üzenetek, operátor logók, csengőhangok, WAP PUSH stb... A parancs használatához egy http api felhasználónév és jelszó szükséges, valamint meg kell adni a címzett telefonszámot és az üzenet szövegét.
Leírás
SMS küldéséhez használja a következő URL formátumot:
https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD
A 127.0.0.1 egy helyi IP cím, ezért kérjük, cserélje le az Ozeki SMS Gateway telepítését tartalmazó számítógép
IP címére vagy hosztnevére. (Megjegyzés: a 127.0.0.1 egy helyi
loopback cím, amely akkor használható, ha ugyanarról a számítógépről csatlakozik az SMS Gateway-hez.) 9508 az Ozeki SMS
Gateway HTTP API alapértelmezett portja. Ez a portszám megtekinthető és módosítható az Ozeki 10 SMS Gateway
felhasználói felületén, az Eszköztárban lévő Advanced gombra kattintva.
Az "UUUUU" és "PPPPP" helyére az SMS gatewayben létrehozott felhasználónév és jelszó kerüljön.
Az "NNNNN" helyére a címzett telefonszáma kerüljön, amelyre az SMS üzenetet küldeni szeretné.
Használhat helyi telefonszámformátumot, valamint nemzetközi telefonszámformátumot is (a nemzetközi formátumban megadott telefonszámok mindig '+' jellel kezdődnek). Ha nemzetközi telefonszámformátumot használ,
figyeljen arra, hogy a '+' karakter helyett '%2B'-t kell használni az URL kódolási szabályok miatt.
Az "MMMMM" helyére az üzenet típusa kerüljön. A "SMS:TEXT" üzenettípus használható szöveges üzenetekhez.
Az üzenet adata tartalmazza a küldendő üzenetet. Az üzenet adatot helyezze a "DDDDD" helyére. Az üzenet adatnak
UTF-8 karakterkészletet kell használnia, és URL kódoltnak kell lennie.
További paraméterek is hozzáadhatók a kéréshez.
A rendelkezésre álló paraméterek teljes listáját az alábbi 'Kérés paraméterei' táblázatban találja:
Példa URL kérés
https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World
Példa válasz
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: 246 <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE smsapi PUBLIC "-//OZEKI//DTD XML 1.0//EN" "http://www.ozekisms.com/DTD/smsapi.xml"> <response> <action>sendmessage</action> <data> <acceptreport> <statuscode>0</statuscode> <statusmessage>Message accepted for delivery</statusmessage> <messageid>ERFAV23D</messageid> <recipient>06203105366</recipient> </acceptreport> </data> </response>
HTTP kérés paraméterei
Paraméter | Leírás | Lehetséges értékek | Példa | K/O* |
action | Meghatározza a HTTP API parancsot | sendmessage | action=sendmessage | K |
username | Meghatározza a felhasználónevet. A felhasználónév és jelszó paraméterek a felhasználó hitelesítésére szolgálnak. Az üzenet a hitelesített felhasználó nevében lesz elküldve. Az értéknek URL kódoltnak kell lennie. | szöveges érték, maximális hossza 16 karakter | username=admin | K |
password | Meghatározza a jelszót. A felhasználónév és jelszó paraméterek a felhasználó hitelesítésére szolgálnak. Az üzenet a hitelesített felhasználó nevében lesz elküldve. Az értéknek URL kódoltnak kell lennie. | szöveges érték, maximális hossza 16 karakter | password=abc123 | K |
originator | Meghatározza a feladó címet. Ez az információ jelenik meg a mobiltelefonon, amely az üzenetet fogadja. Ez a feladó címe. Ez lehet telefonszám, rövid kód vagy alfanumerikus feladói cím. A telefonszám helyi formátumban (pl.06201234567) vagy nemzetközi formátumban (pl.+36201234567) adható meg. Ha alfanumerikus feladói címet használ (pl.ozeki), a karaktereknek UTF8-ban kell lenniük, és az értéknek URL kódoltnak kell lennie. | szöveges érték, maximális hossza 16 karakter | originator=%2B36201112222 | O |
recipient | Meghatározza a címzett telefonszámát.
Az üzenet erre a telefonszámra lesz elküldve. A telefonszám
helyi formátumban (pl.06201234567) vagy nemzetközi formátumban (pl.+36201234567) adható meg. Több címzett cím pontosvesszővel vagy vesszővel elválasztva is megadható (pl.: +36201234567,+36202222222). Az értéknek URL kódoltnak kell lennie. |
szöveges érték, maximális hossza 16 karakter | recipient=%2B36201234567 | K |
messagetype | Meghatározza az üzenet típusát.
Az SMS üzenet adatának típusa a Mobil Üzenet Típus Specifikáció alapján.
Szöveges üzenetek esetén az üzenet adat sima szöveg lesz, más üzenettípusok esetén XML dokumentum.
|
SMS:TEXT SMS:WAPPUSH ... A lehetséges értékek a Mobil Üzenet Típus Specifikációban találhatók. |
messagetype=SMS:TEXT | O |
messagedata | Meghatározza az SMS üzenet szövegét vagy adatát. Az értéknek UTF8-ban kell lennie, és URL kódoltnak kell lennie. | szöveges érték, maximális hossza 32768 karakter | messagedata=Hello+World | K |
_charset_ | Meghatározza a kódolt adat karakterkészletét (ha nincs megadva, az alapértelmezett az utf-8).
Az újabb böngészők automatikusan beállítják a _charset_ értékét. Ha a böngészője nem támogatja ezt a funkciót,
manuálisan is beállíthatja a következő értékekre: |
utf-8 windows-1250 iso-8859-1 iso-8859-2 ... (Támogatott karakterkészlet értékek) |
_charset_=iso-8859-2 | O |
serviceprovider | Meghatározza a GSM Modem vagy IP SMS szolgáltató kapcsolat nevét,
amelyet az üzenet küldéséhez használni kíván.
További információ a szolgáltató kapcsolat kiválasztásáról a
HTTP SMS API - SMS útválasztási útmutatóban található.
Az értéknek meg kell egyeznie a szolgáltató kapcsolat konfigurációs űrlapján megadott sztringgel. |
szöveges érték, maximális hossza 16 karakter | serviceprovider=Vodafone | O |
sendondate | Meghatározza azt a dátumot és időt, amikor az üzenetet el kell küldeni.
Az értéknek a következő dátumformátumot kell használnia: ÉÉÉÉ-HH-NN óó:pp:mm. Az értéknek URL kódoltnak kell lennie. |
dátum érték ÉÉÉÉ-HH-NN óó:pp:mm formátumban | sendondate=2018-12-12+10%3A07%3A05 | O |
responseformat | Miután a gateway elküldte az SMS üzenetet, a gateway egy weboldalt ad vissza, amely jelzi, hogy az üzenet sikeresen elküldésre került. A weboldal tartalma a responseformat paraméter szerint formázódik. HTML szöveges választ kaphat, hogy emberi olvasásra könnyen legyen, vagy XML formátumot, hogy szoftver számára könnyen feldolgozható legyen. |
xml (alapértelmezett) html urlencoded |
responseformat=xml | O |
continueurl | Miután a gateway elküldte az SMS üzenetet, a gateway egy weboldalt ad vissza, amely jelzi, hogy az üzenet sikeresen elküldésre került. A weboldal tartalma a responseformat paraméter szerint formázódik. Ha a responseformat paraméter html-re van állítva, a weboldal tartalmazhat egy "Folytatás" linket. Ha megad egy URL-t ebben a paraméterben, a folytatás link megjelenik, és a megadott URL-re mutat. Az URL értékének URL kódoltnak kell lennie.
A megadott URL tartalmazhat kulcsszavakat, amelyeket az elküldött üzenethez tartozó állapotinformációkra cserélnek. További információ a lehetséges kulcsszavakról a "Submit URL kulcsszavak" útmutatóban található. |
szöveges érték, maximális hossza 1024 karakter | continueurl=192.168.1.23 vagy continueurl=http%3A%2F%2Fwww.ozekisms. com%2Findex.php%3Fowpn%3D159 Megjegyzés: a második példa egy URL kódolt URL-t tartalmaz. |
O |
redirecturl | Miután a gateway elküldte az SMS üzenetet, alapértelmezés szerint a gateway egy weboldalt ad vissza, amely jelzi, hogy az üzenet sikeresen elküldésre került. Opcionálisan kérheti a gateway-t, hogy automatikusan átirányítsa a böngészőt egy megadott URL-re. Ha megad egy URL-t a redirect paraméterben, az SMS gateway által visszaadott HTTP válasz tartalmaz egy átirányítási URL-t a HTTP fejlécben. Ez arra utasítja a webböngészőt, hogy kövesse a megadott linket. Az URL értékének URL kódoltnak kell lennie.
A megadott URL tartalmazhat kulcsszavakat, amelyeket az elküldött üzenethez tartozó állapotinformációkra cserélnek. További információ a lehetséges kulcsszavakról a "Submit URL kulcsszavak" útmutatóban található. |
szöveges érték, maximális hossza 1024 karakter | redirecturl=192.168.1.23 vagy redirecturl=http%3A%2F%2F192.168.1.23 %2Findex.php%3Fowpn%3D159 Megjegyzés: a második példa egy URL kódolt URL-t tartalmaz. |
O |
reporturl | Beállíthat egy weboldalt a "kézbesítve a hálózatnak" és "kézbesítve a készüléknek" események feldolgozására. Ha megad egy URL-t a reporturl paraméterben, a weboldalát meghívják, amikor ezek az események bekövetkeznek. A reporturl paraméterben megadott URL értékének URL kódoltnak kell lennie.
A megadott URL tartalmazhat kulcsszavakat, amelyeket az elküldött üzenethez tartozó állapotinformációkra cserélnek. A report URL opció használatára jó példa található a hogyan küldjön ütemezett SMS-t és használja a reporturl funkcionalitást útmutatóban. |
szöveges érték, maximális hossza 1024 karakter | reporturl=http%3A%2F%2Fwww.ozekisms. com%2Fproc.php%3Freporttype%3D%24reporttype %26messageid%3D%24messageid Megjegyzés: ez a következő URL URL kódolt változata. Mielőtt az SMS gateway meghívja ezt az URL-t, a $reporttype és $messageid paramétereket a megfelelő értékekre cseréli: http://192.168.1.23/proc.php?reporttype=$reporttype& messageid=$messageid a következőképpen lesz meghívva: http://192.168.1.23/proc.php?reporttype=deliveredtonetwork& messageid=ERFAV23D A reporturl-ban használható kulcsszavak listája: $reporttype $messageid $statuscode $statusmessage $fromstation $fromconnection $fromaddress $tostation $toconnection $toaddress $text $createdate $submitdate $receiveddate |
O |
messagecount | Meghatározza a küldendő üzenetek pontos számát. Ha be van állítva, indexelés szükséges a 'recipient', 'messagetype' és 'messagedata' paraméterekhez. A részletes 'messagecount' oktatóanyag itt található. | szám (alapértelmezett érték: 1) |
messagecount=6 | O |
maxresponse | Ez a szám határozza meg a maximális visszajelzést kapó üzenetek számát. Ha túllépi ezt a számot, az üzenetek elküldésre kerülnek, de nem kap visszajelzést róluk. Alapértelmezés szerint ez a paraméter 500 üzenetre van állítva. | szám | maxresponse=1000 | O |
vp | Meghatározza az üzenet érvényességi periodusát.
Az értéknek a következő dátumformátumot kell használnia: ÉÉÉÉ.HH.NN óó:pp:mm. Az értéknek URL kódoltnak kell lennie. További információért olvassa el ezt az oktatóanyagot. |
dátum érték ÉÉÉÉ.HH.NN óó:pp:mm formátumban | vp=2019.01.28.+10%3A07%3A05 | O |
* K = Kötelező paraméter, O = Opcionális paraméter
Válasz paraméterek
(xml válasz formátum)
Paraméter | Leírás | Lehetséges értékek | Példa |
acceptreport | Tartalmazza a beküldési kérésre adott választ egyetlen címzett címre. Ha több címzett van megadva, minden címzettre egy acceptreport kerül a válaszba. Az acceptreport-ok sorrendje megegyezik a címzett címek sorrendjével. | <acceptreport> <statuscode>0</statuscode> <statusmessage>Message accepted for delivery</statusmessage> <messageid>ERFAV23D</messageid> <recipient>06203105366</recipient> </acceptreport> |
|
acceptreport.statuscode | Tartalmaz egy egész számot, amely a sikerességet vagy hibát jelzi. Ha az érték 0, az azt jelenti, hogy az üzenet elfogadásra került kézbesítésre. Ha az érték nagyobb, mint 0, az azt jelenti, hogy hiba történt, az üzenet nem került elfogadásra kézbesítésre. | Egész szám, 0 vagy nagyobb. 32768-nál kisebb. | <statuscode>0</statuscode> |
acceptreport.statusmessage | Tartalmazza a státuszkód szöveges reprezentációját. Ha az üzenet elfogadásra került, az érték "Message accepted for delivery" lesz. Ha az üzenet nem került elfogadásra kézbesítésre, a hibaüzenet ebben a mezőben található. | szöveges érték, maximális hossza 1024 karakter | <statusmessage>Message accepted for delivery</statusmessage> |
acceptreport.messageid | Tartalmaz egy üzenetreferenciát, amely az SMS gateway-ben történő nyomon követésre használható. Ez az üzenetreferencia a kézbesítve a hálózatnak és kézbesítve a készüléknek jelentések azonosítására vagy az üzenet információinak lekérdezésére is használható. | szöveges érték, maximális hossza 16 karakter | <messageid>ERFAV23D</messageid> |
acceptreport.recipient | Tartalmazza a címzett címet. | szöveges érték, maximális hossza 16 karakter | <recipient>06203105366</recipient> |
Összefoglalás
Ez a cikk a HTTP API ‘sendmessage’ műveletről szólt. Ezzel a művelettel szöveges SMS üzeneteket és sok más típusú üzenetet küldhet bármilyen címzetthez az Ozeki SMS Gateway-en keresztül. Láttunk példa válaszokat és néhány további http kérést leírással, lehetséges értékekkel és példákkal.
Ha többet szeretne megtudni az üzenetei kézbesítési állapotáról, kattintson az SMS kézbesítési állapotokról szóló oldalra. Ha egy URL sablont szeretne kapni, látogasson el a hozzá tartozó oldalra.
Ha valós helyzetekben szeretné használni ezt a megoldást, töltse le az Ozeki SMS Gateway-t és kezdje el használni most!
More information