sms-sluzba.cz API_XML30 - textové SMS do ČR a do zahraničí

Podobné dokumenty
sms.sluzba.cz API_XML30 pro textové SMS zprávy do ČR a do zahraničí

Dokumentace ke službě SMS Connect.

1. Obsah. Publikováno:

Dokumentace ke službě SMS Connect.

Dokumentace ke sluţbě SMS Connect.

Obsah. Kdo jsme? Co vám přinášíme s naší bránou? Jak si otevřu bránu na klikniavolej.cz?... 3

Platební systém XPAY [

API pro službu mobilem.cz, verze XML 5.04

Technická specifikace SMS Platby

Funkční specifikace ABOKWS. Aplikační rozhraní elektronického bankovnictví ABO-K. Verze 0.5

Nastavení telefonu Nokia N9

Modul PrestaShop verze 1.6 Uživatelská dokumentace

Modul PrestaShop verze 1.7 Uživatelská dokumentace

Aplikace AWEG3 Profil SMS. Uživatelská příručka. Aktualizace:

Nastavení telefonu Samsung S5610

Příjem a odesílání datových zpráv na UK

Příručka pro školy. Školní projekt na Portálu farmáře

RESTful API TAMZ 1. Cvičení 11

Je to SMTP a POP3 server který spolupracuje s GSM branami Alphatech. Převádí SMS zprávy na y a y na SMS zprávy.

Axfone SMS API rozhraní

Příručka pro editaci kontaktů na eagri

Nastavení telefonu Windows Phone 8S by HTC

Nastavení telefonu Sony Xperia L

Nastavení telefonu Nokia Asha 311

2. Kontakty. 1. Základní nastavení telefonu Vložení SIM karty Vložení paměťové karty Zapnutí telefonu a PIN. 3. Volání

wplatba SOAP api Technická dokumentáce

Modul msender message Sender. Nápověda

U:fonova samoobsluha. Uživatelský manuál

Nastavení telefonu Samsung S5220 Star 3

PODMÍNKY POSKYTOVÁNÍ PŘÍSTUPU K PORTÁLU NAMĚŘENÝCH DAT POMOCÍ WEBOVÝCH SLUŽEB SPOLEČNOSTI ČEZ DISTRIBUCE, A. S.

API pro službu Mobilem.cz, verze XML 4.9

Návod k nastavení účtu v emclient (IceWarp Desktop) pro práci s IceWarp Mail serverem.

Jak nastavit 2SMS a SMS2 na 2N StarGate - nové CPU 2013

Jak nastavit 2SMS a SMS2 na bráně 2N VoiceBlue Next

Nastavení telefonu Sony Ericsson XPERIA X10

Artlingua Translation API

Příručka uživatele. Registrace a přihlášení uživatele do portálu IS KP 14+ Aplikace MS2014+

Vzhled a popis hlavních funkcí systému SMSbrána.cz

Dokumentace k API SSLmarketu. verze 1.3

Návrh funkcí webových služeb (WS) pro komunikaci mezi Informačním systémem datových schránek (ISDS) a spisovými službami (SS)

TRANSPORTY výbušnin (TranV)

Nastavení telefonu Samsung N9005 Galaxy Note 3

Chytry odbě ratěl API

Nastavení telefonu Nokia Asha 300

Nastavení telefonu Samsung S5570 Galaxy Mini

Nastavení telefonu Sony Xperia E

Seznámení s ISPOP Oddělení ISPOP a IRZ CENIA, česká informační agentura životního prostředí

Nastavení telefonu T-Mobile move

2. Kontakty. 1. Základní nastavení telefonu Vložení SIM a paměťové karty Zapnutí telefonu a PIN. 3. Volání

Position Services. Search

Nastavení tabletu Samsung P5100 Galaxy Tab

Nastavení tabletu Samsung P605 Galaxy Note 10.1 (2014 edition)

Nastavení telefonu Sony Ericsson XPERIA X8

Nastavení telefonu Sony Ericsson Xperia Arc S

Nastavení telefonu Sony Ericsson T300

Nastavení telefonu Nokia 206

Nastavení ového účtu Outlook 2007

Na vod k nastavenı u

Aplikace pro elektronicke odesla nı da vky Listu o prohlı dce zemr ele ho a dals ı ch da vek do NZIS.

Nastavení telefonu Samsung SGH-F250

První seznámení s mobilní aplikací PATRIOT GPS

Internetový portál Come Automaty

Zákony pro lidi - Monitor změn (zdroj:

Nastavení telefonu Alcatel OT-991

Manuál pro zasílání záznamů o úrazech

Příručka pro potvrzování zůstatku vydavatelům karetních platebních prostředků

Aplikace BSMS. Uživatelská příručka - 1 -

Nastavení telefonu Samsung S3310

Nastavení telefonu Samsung N7100 Galaxy Note II

Nastavení telefonu HTC Desire

Nastavení telefonu Alcatel One Touch IDOL

Nastavení zařízení Samsung P1000 Galaxy Tab

Systém elektronického bankovnictví GEMINI 5. Napojení na účetní systémy popis exportních / importních souborů. Verze 1.1

Ing. Jitka Dařbujanová. , SSL, News, elektronické konference

1. Základní nastavení tabletu Vložení SIM karty Vložení paměťové karty Zapnutí tabletu a PIN. 2. Kontakty. 3. Volání

mbank.cz mtransfer Okamžitá notifikace o mtransferu Dokumentace pro externího partnera

Nastavení telefonu Nokia Lumia 925

1. Základní nastavení telefonu Vložení SIM karty Vložení paměťové karty Zapnutí telefonu a PIN. 2. Kontakty. 3. Volání

Nastavení telefonu Samsung I9300 Galaxy S III

Nastavení telefonu HTC One S

Nastavení telefonu Nokia 9500

B2B SOAP - popis funkcionality

2. Kontakty. 1. Základní nastavení telefonu Vložení SIM a paměťové karty Zapnutí telefonu a PIN. 3. Volání

Faxový server společnosti PODA s.r.o.

Nastavení tabletu Samsung P5200 Galaxy Tab

Max Homebanking PS uživatelský manuál rozhraní pro automatické stahování dat

Nastavení telefonu Sony Ericsson P990i

Nastavení tabletu Huawei MediaPad 7 Lite

Nastavení telefonu LG KM900 Arena

Webová služba. Popis. Dostupné operace. add_subscriber_groups

1. Základní nastavení telefonu Vložení SIM a paměťové karty Zapnutí telefonu a PIN. 2. Kontakty. 3. Volání

Práce s ovými schránkami v síti Selfnet

Platební systém XPAY [

Platební systém XPAY [

1. Základní nastavení tabletu Vložení SIM a paměťové karty Zapnutí tabletu a PIN. 2. Kontakty. 3. Volání

Vyúčtování na míru. OneNet samoobsluha

Technická specifikace Platební brána IBS

Transkript:

sms-sluzba.cz API_XML30 - textové SMS do ČR a do zahraničí 1. Odesílání zpráv Provádí se odesláním jednoduchého XML dokumentu pomocí HTTPS (nezabezpečená komunikace není povolena!) metodou POST (URL https://smsgateapi.sms-sluzba.cz/apixml30/receiver), s tím, že přihlašovací údaje jsou obsaženy v URL. Příklad HTTPS požadavku na odeslání SMS zprávy: POST /apixml30/receiver?login=jmeno&password=heslo HTTP/1.0 Host: smsgateapi.sms-sluzba.cz Content-type: text/xml Content-length: 135. Struktura XML dokumentu pro odeslání textové zprávy je následují: <outgoing_message> <dr_request>20</dr_request> <recipient>777123456</recipient> <send_at>20160404093000</send-at> </outgoing_message> Document element (root element) má název "outgoing_message". Tag dr_request je nepovinný a řídí se jím žádost o doručenku pro danou SMS zprávu: 0 = doručenka není vyžadována, 20 = doručenka k odesílané zprávě je vyžadována. V případě, že tag dr_request není uveden, řídí se požadavek na doručenku dle nastavení v uživatelském účtu na sms-sluzba.cz (https://sms-sluzba.cz/users/edit) Tag text je povinný a musí obsahovat text zprávy. Text delší než 459 znaků bude oříznut. Tag recipient je povinný a obsahuje číslo v mezinárodním formátu s "+" (+420603123456), akceptován je také mezinárodní formát se dvěma nulami (00420603123456), nebo 9-ti místný formát u českých tel. čísel (603123456). SMS jsou odesílány jako 7-bitové zprávy (160-ti znakové SMS bez diakritiky, případně spojovatelé zprávy max. 3 fragmenty), všechny znaky jsou automaticky přeloženy do znakové sady GSM. Tag send_at je nepovinný a obsahuje čas odeslání zprávy. V případě neuvedení tagu bude zpráva odeslána okamžitě (formát času: YYYYMMDDHHMMSS). V případě korektního převzetí požadavku odpoví API HTTP resultem 200 a vrací XML dokument: <id>420777123456-20080404153039854</id> <send_at>20080404153038</send_at> <recipient>+420777123456</recipient> <parts>1</parts> <price>0.80</price> <credit>168.85</credit> V XML souboru je rekapitulována odeslaná zpráva. Tag parts obsahuje informaci o tom, na kolik

zpráv (fragmentů po 160 znacích) byl text rozdělen. V tagu id je vrácen identifikátor zprávy, se kterým je zpráva zařazena na portálu sms-sluzba.cz. V případě požadavku na doručenku slouží tento identifikátor k párování doručenky a SMS zprávy. Dále je možno zjistit cenu za odeslanou zprávu (tag price) a aktuální stav kreditu po odeslání zprávy (tag credit). 2. Příjem zpráv a doručenek Provádí se pomocí HTTPS metodou GET (URL https://smsgateapi.sms-sluzba.cz/apixml30/sender) a API vrací XML dokument. Dokument může obsahovat různé informace: Příchozí SMS zprávy právy, které byly vyhodnoceny jako odpovědi na některou z předchozích ochozích zpráv uživatele Doručenky k odeslaným zprávám Případně i samotné odchozí zprávy (z důvodu synchronizace apod.) V případě stažení příchozí SMS zprávy je struktura XML dokumentu dle příkladu: <type>incoming_message</type> <id>420777123456-20080404072509664</id> <text>text prichozi zpravy</text> <sent_at>20080404072542</sent_at> <sender>+420777123456</sender> <recipient>5517</recipient> Takto v případě odpovědi na zprávu, kdy v tagu in_reply_to je ID odchozí zprávy na kterou se odpovídá: <type>answer_message</type> <id>420777123456-20080404072509664</id> <sent_at>20080404072542</sent_at> <in_reply_to>420777123456-20080404153039854</in_reply_to> <sender>+420777123456</sender> <recipient>5517</recipient> Struktura XML v případě stažení dřívější odchozí zprávy: <type>gate_outgoing_message</type> <id>420777123456-20080404072210662</id> <text>d</text> <send_at>20080404065600</send_at> <recipient>+420777123456</recipient> kdy type může nabývat hodnot: gate_outgoing_message - pokud byla zpráva odeslána přes webový portál sms-sluzba.cz

api_outgoing_message - pokud byla zpráva odeslána přes API SMS Gate Struktura XLM v případě stažení doručenky: <type>delivery_report</type> <id>420777123456-20080328114405559</id> <delivery_timestamp>20080328114428</delivery_timestamp> 0 <description>doručeno</description> kde id je ID zprávy, ke které se doručenka váže. Tag messages může obsahovat "neomezený" počet (výchozí nastavení vrací pouze jeden tag message) vnořených tagů message různého typu. Počet převzatých zpráv lze ovlivnit parametrem count předávaným v URL, maximálně však 30 zpráv. Výchozí nastavení vrací objekty typu answer_message (přijaté odpovědi na odeslané zprávy). Pro získání jiných typů objektů (zpráv, doručenek) při volání nastavte následující parametry v querystringu požadavku: query_incoming = 1 - příchozí zprávy a odpovědi query_outgoing = 1 - odchozí zprávy ze smsgate a api query_delivery_report = 1 - doručenky k odchozím zprávám Takže pro příjem jakýchkoli informací lze odeslat tento požadavek: https://smsgateapi.sms-sluzba.cz/apixml30/sender?login=jmeno&password=heslo&query_incoming=1&qu ery_outgoing=1& query_delivery_report=1 Každé převzetí jakékoli výše zmíněné zprávy (ať už příchozí SMS nebo doručenky) je třeba potvrdit pomocí HTTPS metodou GET s platnými přihlašovacími údaji: https://smsgateapi.sms-sluzba.cz/apixml30/confirm?type=delivery_report&id=420777123456-803281144055597&login=jmeno&password=heslo Parametr type určuje, zda se jedná o potvrzení převzetí outgoing_message, incoming_message nebo delivery_report. id je identifikátor zprávy (atribut "id" tagu "message" z původně přijatého XML dokumentu) V případě potřeby lze kdykoli vyžádat aktuální stav určité zpávy (doručenku) pomocí akce get_delivery_report ( act=get_delivery_report ) v querystringu požadavku: https://smsgateapi.sms-sluzba.cz/apixml30/sender? login=jmeno&password=heslo&act=get_delivery_report&id=420777123456-20080404072210662 3. URL https://smsgateapi.sms-sluzba.cz/apixml30/receiver - Odesílání SMS zpráv https://smsgateapi.sms-sluzba.cz/apixml30/sender - Příjem (stahování) zpráv https://smsgateapi.sms-sluzba.cz/apixml30/confirm - Potvrzování příjmu zpráv

4. Možné stavy při odesílaní zpráv <id>200</id> Zprava byla uspesne odeslana <id>400;1</id> Chybne telefonni cislo 77716085 <id>400;2</id> Chybi text zpravy <id>400</id> Neznama akce <id>401</id> Chybne prihlaseni <id>401;1</id> Ucet zablokovan <id>402</id> Nedostatecny kredit <id>503</id> Chyba brany

5. Informace o účtu aktuální stav kreditu a nastavená cena za SMS Pro zjištění základních informací o účtu lze použít volání HTTP GET dle příkladu: https://smsgateapi.sms-sluzba.cz/apixml30/info/credit?login=jmeno&password=heslo API vrací následující XML strukturu s aktuálním stavem kreditu a cenou za SMS do ČR, SK a zahraničí (všechny ceny jsou uvedeny bez DPH). <info> <credit>454.17</credit> <price_cz_sms>0.68</price_cz_sms> <price_sk_sms>0.78</price_sk_sms> <price_other_sms>1.80</price_other_sms> </info> 6. Provize Pro získaní provize z odeslaných sms vašich zákazníků předejte při odeslání zprávy jako jeden z parametrů GET hodnotu affiliate, která obsahuje identifikátor partnera. Příklad: /apixml30/receiver?login=jmeno&password=heslo&affiliate=123456789 Pro získání identifikátoru a bližsí informace o partnerském programu nás kontaktujte na emailu admin@sms-sluzba.cz 7. Speciální možnosti a vlastnosti API XML 3.0 Vynucení požadované hlavičky v odpovědi API: Při integraci do některých systémů (např. Microsoft SharePoint) může vzniknout problém s hlavičkou "Content- Type: application/xml nebo "Content-Type: text/xml v odpovědích, které API SMS Gate standardně vrací. V takovém případě můžete v požadavku hlavičkou "Response-Content-Type vynutit hodnotu hlavičky Content-Type v odpovědi API. Pokud v požadavku uvedete "Response-Content-Type: text/plain bude odpověď API obsahovat hlavičku Content-Type: text/plain namísto standardní Content-Type: application/xml.