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



Podobné dokumenty
sms-sluzba.cz API_XML30 - textové SMS 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.

Platební systém XPAY [

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

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

Nastavení telefonu Nokia N9

Technická specifikace SMS Platby

Modul PrestaShop verze 1.6 Uživatelská dokumentace

Modul PrestaShop verze 1.7 Uživatelská dokumentace

Nastavení telefonu Samsung S5610

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

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

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

Artlingua Translation API

Axfone SMS API rozhraní

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

Nastavení telefonu Sony Xperia L

Nastavení telefonu Windows Phone 8S by HTC

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

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í

Nastavení telefonu Samsung S5220 Star 3

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

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

Nastavení telefonu Sony Ericsson XPERIA X10

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

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

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

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.

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

Dokumentace k API SSLmarketu. verze 1.3

TRANSPORTY výbušnin (TranV)

Chytry odbě ratěl API

Nastavení telefonu Nokia Asha 300

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

Nastavení telefonu Sony Xperia E

Modul msender message Sender. Nápověda

Nastavení telefonu T-Mobile move

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

GP webpay: Správa objednávek, Web Services

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

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

Technická specifikace Platební brána IBS

wplatba SOAP api Technická dokumentáce

Platební systém XPAY [

UŽIVATELSKÁ PŘÍRUČKA PRO SLUŽBU INTERNETBANKING PPF banky a.s.

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

Internetový portál Come Automaty

Nastavení telefonu Sony Ericsson XPERIA X8

Nastavení telefonu Sony Ericsson Xperia Arc S

1 Import platebních příkazů

Nastavení telefonu Samsung N9005 Galaxy Note 3

Nastavení telefonu Nokia 206

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

Manuál pro implementaci služby PLATBA 24. Datum: 17. prosince 2014 Verze: 1.49

Nastavení telefonu Samsung SGH-F250

Nastavení telefonu Alcatel OT-991

Nastavení telefonu Samsung S5570 Galaxy Mini

Nastavení telefonu Samsung S3310

Nastavení telefonu Alcatel One Touch IDOL

Nastavení telefonu HTC Desire

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)

Nastavení zařízení Samsung P1000 Galaxy Tab

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

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 Nokia Lumia 925

Nastavení telefonu Nokia 9500

Nastavení telefonu HTC One S

JSON API pro zjišťování cen MtG karet

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

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

Nastavení telefonu Sony Ericsson P990i

Nastavení tabletu Samsung P5100 Galaxy Tab

Nastavení telefonu LG KM900 Arena

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

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

Nastavení tabletu Huawei MediaPad 7 Lite

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í

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

Nastavení telefonu HTC Sensation

nadstavbový modul programu Amicus

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

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

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

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

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

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

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

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

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

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

Kompletní návod na nákup a čtení eknih ve formátech PDF a epub na PC a MAC

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

Transkript:

sms.sluzba.cz API_XML30 pro textové SMS zprávy 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.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.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>20110404093000</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 ke zpráve 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 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 - 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 na odeslanou zprávu (tag price) a aktuální stav kreditu po provedení transakce (tag credit).

2. Příjem zpráv a doručenek Provádí se pomocí HTTPS metodou GET (URL https://smsgateapi.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í zprávy je struktura 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 api_outgoing_message - pokud byla zpráva odeslána přes api

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 (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.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ž SMS nebo doručenky) je třeba potvrdit pomocí HTTPS metodou GET s platnými přihlašovacími údaji: https://smsgateapi.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.sluzba.cz/apixml30/sender?login=jmeno&password=heslo&act=get_delivery_report&id=4207 77123456-20080404072210662 3. URL https://smsgateapi.sluzba.cz/apixml30/receiver - Odesílání SMS zpráv https://smsgateapi.sluzba.cz/apixml30/sender - Příjem (stahování) zpráv https://smsgateapi.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 - stav kreditu a 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.sluzba.cz/apixml30/info/credit?login=jmeno&password=heslo API vrací následující XML strukturu se stavem kreditu a cenou za SMS do ČR, SK a zahraničí (všechny hodnoty jsou 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 smssluzbacz@axima-brno.cz