HTTP API - akcija 'sendmessage'

Ta ukaz HTTP API-ja se lahko uporablja za pošiljanje SMS sporočil preko SMS prehoda. Ukaz se lahko uporablja za pošiljanje besedilnih SMS sporočil ali drugih vrst sporočil, kot so binarna SMS sporočila, logotipi operaterjev, melodije zvonjenja, WAP PUSH itd. Ko uporabljate ta ukaz, morate uporabiti uporabniško ime in geslo HTTP API-ja, določiti morate telefonsko številko prejemnika in besedilo sporočila.

Opis

Za pošiljanje SMS sporočila uporabite naslednjo obliko URL-ja:

https://127.0.0.1:9508/api?action=sendmessage&username=UUUUU&password=PPPPP&
recipient=NNNNN&messagetype=MMMMM&messagedata=DDDDD


127.0.0.1 je lokalni IP naslov, zato ga zamenjajte z IP naslovom ali imenom gostitelja računalnika z nameščenim Ozeki SMS prehodom. (Opomba: 127.0.0.1 je lokalna povratna naslovna zanka, ki se lahko uporablja, ko se povezujete na SMS prehod z istega računalnika.) 9508 je privzeta vrata Ozeki SMS prehoda HTTP API-ja. To številko vrat lahko vidite in uredite v uporabniškem vmesniku Ozeki 10 SMS prehoda, s klikom na gumb Napredno v orodni vrstici.

"UUUUU" in "PPPPP" je treba zamenjati z uporabniškim imenom in geslom uporabnika, ki ste ga ustvarili v SMS prehodu.

Zamenjajte "NNNNN" s telefonsko številko, na katero želite poslati SMS sporočilo. Lahko uporabite lokalno obliko telefonske številke ali mednarodno obliko telefonskih številk (telefonske številke, oblikovane po mednarodni številski obliki, vedno začnejo z znakom '+'). Če uporabljate mednarodno obliko telefonske številke, upoštevajte, da morate znak '+' nadomestiti z '%2B' zaradi pravil kodiranja URL-ja.

Prosimo, zamenjajte "MMMMM" z vrsto sporočila. Za besedilna sporočila uporabite vrsto sporočila "SMS:TEXT".

Podatki sporočila vsebujejo sporočilo, ki ga želite poslati. Namesto "DDDDD" vnesite podatke sporočila. Podatki sporočila naj bodo v znakih UTF-8 in naj bodo URL kodirani.

Zahtevi lahko dodate tudi druge parametre.
Za popoln seznam razpoložljivih parametrov si oglejte spodnjo tabelo 'Parametri zahtev':

Primer URL zahteve

https://127.0.0.1:9508/api?action=sendmessage&username=admin&password=abc123&
recipient=06203105366&messagetype=SMS:TEXT&messagedata=Hello+World

Primer odziva
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>Sporočilo sprejeto za dostavo</statusmessage>
         <messageid>ERFAV23D</messageid>
         <recipient>06203105366</recipient>
      </acceptreport>
   </data>
</response>


Parametri HTTP zahtevka

Parameter Opis Možne vrednosti Primer O/M*
action Določa ukaz HTTP API sendmessage action=sendmessage O
username Določa uporabniško ime. Uporabniško ime in geslo se uporabljata za avtentikacijo uporabnika. Ko pošljete sporočilo, bo poslano v imenu avtenticiranega uporabnika. Vrednost mora biti url-kodirana. niz, največja dolžina je 16 znakov username=admin O
password Določa geslo. Uporabniško ime in geslo se uporabljata za avtentikacijo uporabnika. Ko pošljete sporočilo, bo poslano v imenu avtenticiranega uporabnika. Vrednost mora biti url-kodirana. niz, največja dolžina je 16 znakov password=abc123 O
originator Določa naslov pošiljatelja. Ta podatek bo prikazan na mobilni napravi, ki prejme sporočilo. To je naslov pošiljatelja. Lahko je telefonska številka, kratka koda ali alfanumerični naslov pošiljatelja. Telefonska številka je lahko oblikovana v lokalni obliki (npr. 06201234567) ali v mednarodni obliki (npr. +36201234567). Če uporabljate alfanumerični naslov pošiljatelja (npr. ozeki), morajo biti znaki kodirani v UTF8 in vrednost mora biti url-kodirana. niz, največja dolžina je 16 znakov originator=%2B36201112222 M
recipient Določa telefonsko številko prejemnika. Sporočilo bo poslano na to telefonsko številko. Telefonska številka je lahko podana v lokalni obliki (npr. 06201234567) ali v mednarodni obliki (npr. +36201234567).
Več naslovov prejemnikov je lahko ločenih z dvopičjem (npr.: +36201234567,+36202222222) ali podpičjem.
Vrednost mora biti url-kodirana.
niz, največja dolžina je 16 znakov recipient=%2B36201234567 O
messagetype Določa vrsto sporočila. Vrsta podatkov SMS sporočila, ki temelji na Specifikaciji vrste mobilnega sporočila. Za besedilna sporočila bodo podatki sporočila navadno besedilo, za druge vrste sporočil pa bo to XML dokument.
SMS:TEXT
SMS:WAPPUSH
...
Možne vrednosti najdete v Specifikaciji vrste mobilnega sporočila
messagetype=SMS:TEXT M
messagedata Določa besedilo ali podatke SMS sporočila. Vrednost mora biti kodirana v UTF8 in mora biti url-kodirana. niz, največja dolžina je 32768 znakov messagedata=Hello+World O
_charset_ Določa kodno tabelo kodiranih podatkov (če ni določena, se privzame utf-8 ). Novejši brskalniki bi morali nastaviti vrednost _charset_ samodejno. Če vaš brskalnik te funkcije ne podpira, jo lahko nastavite ročno na:
utf-8
windows-1250
iso-8859-1
iso-8859-2
...
(Podprte vrednosti kodnih tabel)
_charset_=iso-8859-2 M
serviceprovider Določa ime GSM modema ali povezave ponudnika storitev IP SMS, ki se uporablja za pošiljanje sporočila. Več informacij o izbiri povezave ponudnika storitev je na voljo v Vodniku za usmerjanje SMS prek HTTP SMS API.

Vrednost se mora ujemati z nizom, določenim v obrazcu za konfiguracijo povezave ponudnika storitev.
niz, največja dolžina je 16 znakov serviceprovider=Vodafone M
sendondate Določa datum in uro, ko naj bo sporočilo poslano.

Vrednost mora uporabljati naslednji format datuma: YYYY-MM-DD hh:mm:ss. Vrednost mora biti url-kodirana
datum v formatu YYYY-MM-DD hh:mm:ss sendondate=2018-12-12+10%3A07%3A05 M
responseformat Ko prehod pošlje SMS sporočilo, bo prehod vrnil spletno stran, ki označuje, da je bilo sporočilo uspešno poslano. Vsebina spletne strani je oblikovana glede na parameter responseformat. Lahko imate odziv v obliki HTML besedila, da ga je človeku lažje brati, ali pa lahko imate format XML, da je programski opremi lažje obdelati odziv. xml (privzeto)
html
urlencoded
responseformat=xml M
continueurl Ko prehod pošlje SMS sporočilo, bo prehod vrnil spletno stran, ki označuje, da je bilo sporočilo uspešno poslano. Vsebina spletne strani je oblikovana glede na parameter responseformat. Če je parameter responseformat nastavljen na html, lahko spletna stran vsebuje povezavo "Nadaljuj". Če določite URL v tem parametru, bo prikazana povezava za nadaljevanje in bo usmerjena na določeni URL. Vrednost URL-ja mora biti url-kodirana.

URL, ki ga določite, lahko vsebuje ključne besede, ki bodo nadomeščene s stanjem informacij, ki ustrezajo poslanemu sporočilu. Več informacij o možnih ključnih besedah najdete v vodiču "Ključne besede za URL za oddajo".
niz, največja dolžina je 1024 znakov continueurl=192.168.1.23

ali

continueurl=http%3A%2F%2Fwww.ozekisms.
com%2Findex.php%3Fowpn%3D159

Opomba: drugi primer vsebuje url-kodiran URL.
M
redirecturl Ko prehod pošlje SMS sporočilo, bo prehod privzeto vrnil spletno stran, ki označuje, da je bilo sporočilo uspešno poslano. Po želji lahko zahtevate, da prehod samodejno preusmeri brskalnik na URL, ki ga določite. Če določite URL v parametru redirect, bo odziv HTTP, ki ga vrne SMS prehod, vseboval preusmeritveni URL v glavi HTTP. To bo navodilo spletnemu brskalniku, naj sledi povezavi, ki ste jo določili. Vrednost URL-ja mora biti url-kodirana.

URL, ki ga določite, lahko vsebuje ključne besede, ki bodo nadomeščene s stanjem informacij, ki ustrezajo poslanemu sporočilu. Več informacij o možnih ključnih besedah najdete v vodiču "Ključne besede za URL za oddajo".
niz, največja dolžina je 1024 znakov redirecturl=192.168.1.23

ali

redirecturl=http%3A%2F%2F192.168.1.23
%2Findex.php%3Fowpn%3D159

Opomba: drugi primer vsebuje url-kodiran URL.
M
reporturl Lahko nastavite spletno stran za obdelavo informacij o dogodkih "dostavljeno v omrežje" in "dostavljeno na napravo". Če določite URL v parametru reporturl, bo vaša spletna stran poklicana, ko se ti dogodki zgodijo. Vrednost URL-ja, ki ga določite v parametru reporturl, mora biti URL kodirana.

URL, ki ga določite, lahko vsebuje ključne besede, ki bodo nadomeščene s stanjem informacij, ki ustrezajo poslanemu sporočilu.

Dober primer, kako uporabiti možnost report URL, najdete v vodiču, kako poslati načrtovano SMS in uporabiti funkcionalnost reporturl.
niz, največja dolžina je 1024 znakov reporturl=http%3A%2F%2Fwww.ozekisms.
com%2Fproc.php%3Freporttype%3D%24reporttype
%26messageid%3D%24messageid

Opomba: to je url-kodirana različica naslednjega URL-ja. Preden bo ta URL poklican s strani SMS prehoda, bosta parametra $reporttype in $messageid nadomeščena z ustreznimi vrednostmi:

http://192.168.1.23/proc.php?reporttype=$reporttype&
messageid=$messageid

bo poklican kot:
http://192.168.1.23/proc.php?reporttype=deliveredtonetwork& messageid=ERFAV23D

Seznam ključnih besed, ki jih lahko uporabite v reporturl, je:
$reporttype
$messageid
$statuscode
$statusmessage
$fromstation
$fromconnection
$fromaddress
$tostation
$toconnection
$toaddress
$text
$createdate
$submitdate
$receiveddate
M
messagecount Določa natančno število sporočil, ki jih želite poslati. Če je nastavljeno, je potrebno indeksiranje za parametre 'recipient', 'messagetype' in 'messagedata'. Podroben vodič o 'messagecount' najdete tukaj. število
(privzeta vrednost:
1)
messagecount=6 M
maxresponse To število določa največje število sporočil, o katerih boste prejeli povratne informacije. Če presežete to število, bodo vaša sporočila poslana, vendar o njih ne boste prejeli povratnih informacij. Privzeto je ta parameter nastavljen na 500 sporočil. število maxresponse=1000 M
vp Določa validity period (obdobje veljavnosti) za vaše sporočilo.

Vrednost mora uporabljati naslednji format datuma: YYYY.MM.DD hh:mm:ss. Vrednost mora biti url-kodirana.
Za več informacij preberite ta vodič.
datum v formatu YYYY.MM.DD hh:mm:ss vp=2019.01.28.+10%3A07%3A05 M

* O = Obvezen parameter, M = Neobvezen parameter

Odgovorni parametri
(oblika xml odgovora)

Parameter Opis Možne vrednosti Primer
acceptreport Vsebuje odgovor na zahtevo za posamezni naslov prejemnika. Če je bilo podanih več prejemnikov, bo v odgovoru vključen acceptreport za vsakega prejemnika. Vrstni red acceptreport-ov se ujema z vrstnim redom naslovov prejemnikov.  
<acceptreport>
   <statuscode>0</statuscode>
   <statusmessage>Sporočilo sprejeto za dostavo</statusmessage>
   <messageid>ERFAV23D</messageid>
   <recipient>06203105366</recipient>
</acceptreport>
acceptreport.statuscode Vsebuje celoštevilsko vrednost, ki označuje uspeh ali neuspeh. Če je vrednost 0, pomeni, da je bilo sporočilo sprejeto za dostavo. Če je vrednost večja od 0, pomeni, da je prišlo do napake in sporočilo ni bilo sprejeto za dostavo. Celoštevilska vrednost, večja ali enaka 0. Manjša od 32768. <statuscode>0</statuscode>
acceptreport.statusmessage Vsebuje besedilno predstavitev statusne kode. Če je bilo sporočilo sprejeto, bo vrednost "Sporočilo sprejeto za dostavo". Če sporočilo ni bilo sprejeto za dostavo, lahko v tem polju najdete sporočilo o napaki. Niz, največja dolžina je 1024 znakov <statusmessage>Sporočilo sprejeto za dostavo</statusmessage>
acceptreport.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 na napravo ali za poizvedovanje informacij o sporočilu. Niz, največja dolžina je 16 znakov <messageid>ERFAV23D</messageid>
acceptreport.recipient Vsebuje naslov prejemnika. Niz, največja dolžina je 16 znakov <recipient>06203105366</recipient>
Povzetek

Ta članek je bil o HTTP API akciji 'sendmessage'. S to akcijo lahko pošiljate besedilna SMS sporočila in številne druge vrste sporočil prek Ozeki SMS prehoda. Videli ste primer odgovorov in nekaj dodatnih HTTP zahtev z opisom, možnimi vrednostmi in primeri.

Če želite izvedeti več o statusu dostave vaših sporočil, kliknite stran o statusih dostave SMS sporočil. Če želite pridobiti URL predlogo, obiščite stran zanjo.

Če želite to rešitev uporabiti v resničnih situacijah, prenesite Ozeki SMS prehod in začnite ga uporabljati zdaj!

More information