Obecný popis XML rozhraní

XML rozhraní díky své struktuře umožňuje plně využít vlastnosti našeho systému a plně je integrovat do Vašich aplikací.

  • Odesílání zpráv
  • Neomezený počet příjemců v rámci jedné zprávy
  • Hromadné odesílání zpráv v jednom requestu
  • Vytváření akcí pro příchozí odpovědi na základě odeslané zprávy
  • Ukládání kontaktů
  • Ukládání štítků
  • Náročnější implementace než HTTP API

Podporujeme šifrované připojení pomocí SSL. Jednotlivé adresy stačí volat protokolem https://.

Připravené knihovny

Máte hotovou implementaci našeho API a chcete jej nabídnout ostatním? Napište nám prosím na support@smsmanager.cz. Děkujeme!

Programovací jazyk Autor Odkaz na stažení Poslední aktualizace
PHP Šimon Podlipský https://github.com/LidskaSila/SmsManager 17.9.2016
Ruby David Hrachovy https://github.com/dayweek/sms_manager 16.1.2016
PHP (Nette) Michal Pospiech https://github.com/michalpospiech/nette-smsmanager 18.3.2015
PHP @kixorz https://github.com/kixorz/SMSManager 17.8.2012

Příklady volání

Pomocí bezplatného programu Postman můžete simulovat jednotlivá volání. Po instalaci importujte následující soubor: SMSMANAGERAPI.postman_collection.json

Dostupná rozhraní

Send

Adresa:

https://xml-api.smsmanager.cz/Send

Data:
XML dokument zasílejte jako obsah POST parametru
XMLDATA

Příklady struktury XML dokumentu:

<RequestDocument>
    <RequestHeader>
        <Username>test</Username>
        <Password>a94a8fe5ccb19ba61c4c0873d391e987982fbbd3</Password>
    </RequestHeader>
    <RequestList>
        <Request Type="high" CustomID="987654321">
            <Message Type="Text">Test</Message>
            <NumbersList>
                    <Number>420777123456</Number>
            </NumbersList>
        </Request>
    </RequestList>
</RequestDocument>

<RequestDocument>
    <RequestHeader>
        <Username>test</Username>
        <Password>a94a8fe5ccb19ba61c4c0873d391e987982fbbd3</Password>
    </RequestHeader>
    <RequestList>
        <Request Type="high" CustomID="987654321">
            <Message Type="Text">Test</Message>
            <NumbersList>
                    <List>12345</List>
                    <Data Value="1990">6789</Data>
            </NumbersList>
        </Request>
    </RequestList>
</RequestDocument>

XML element RequestHeader:
Název elementu Povinné Popis
Username
Ano Uživatelské jméno. V případě, že neznáte své uživatelské jméno, obraťte se na zákaznickou podporu.
Password
Ano SHA1 hash zadaného hesla. V případě, že neznáte své heslo, obraťte se na zákaznickou podporu.
XML element RequestList:
Název elementu Povinné Popis
Request
Ano 1) Obsahuje jeden konkrétní požadavek na odeslání SMS zprávy.

Atributy:

Type

Označuje jakým typem zprávy se má požadavek vyřídit. Možné hodnoty: high nebo economy nebo lowcost.

CustomID

Volitelné identifikační číslo zprávy. Přístupná jsou pouze čísla. Nemusí být unikátní. Maximální délka 10 znaků.

Sender

Obsahuje odesílatele zprávy. Může být telefonní číslo ve tvaru 420777123456 nebo text do délky 11 znaků. Text použitý jako číslo odesílatele musí být nejprve schválen.

Time

Čas odeslání zprávy. Správný formát: 2011-01-01T23:59:59. Výchozím nastavením je odeslání ihned.

Expiration

Čas expirace zprávy (= neodesílat zprávu po tomto čase). Správný formát: 2011-01-01T23:59:59. Výchozím nastavením je doba expirace 6 hodin.
XML element Request:
Název elementu Povinné Popis
Message
Ano Text SMS zprávy. Diakritika je automaticky odstraněna.

Atributy:

Type

Označuje typ obsahu zprávy. Momentálně k povolena pouze hodnota Text.
NumbersList
Ano Obsahuje seznam telefonních čísel, na která bude zpráva doručena.
XML element NumberList:
Název elementu Povinné Popis
Number
Ano 1) Telefonní číslo příjemce. Doporučený formát: "420777123456", nicméně jsou akceptovány i formáty s předvolbou ve tvaru "00420" nebo "+420". Devítiméstná telefonní čísla jsou doplněny o českou mezinárodní předvolbu.
Data
Ano 1) ID volitelného pole. Například, pokud máte u kontaktů vytvořeno uživatelské pole "Rok narození zákazníka", pak použijte ID tohoto uživatelského pole. Zjistíte jej ve webové administraci. V atributu "Value" použijte požadovanou hodnotu pole dle které se bude vyhledávat (např.: 1980 pokud chcete odeslat SMS na všechny kontakty, které mají nastavené "Rok narození zákazníka" na hodnotu "1980").
List
Ano 1) ID seznamu příjemců, který obsahuje telefonní čísla. Pro odesílání budou následně použita všechna telefonní čísla v tomto seznamu. ID seznamu příjemců zjistíte ve webové administraci.

1) Jeden z elementů se musí vyskytovat minimálně jednou. Lze použít více těchto elementů.

Struktura odpovědi:
Odpověď je zobrazována jako
Content-Type: text/xml
v kódování UTF-8.


<Result>
    <ResultHeader>
        <Interface Version="1.0" />
    </ResultHeader>
    <Response Type="OK" ID="0" />
    <ResponseRequestList>
        <ResponseRequest>
            <RequestID>1234567890</RequestID>
            <ResponseNumbersList>
                <Number>420777123456</Number>
            </ResponseNumbersList>
        </ResponseRequest>
    </ResponseRequestList>
</Result>

XML element Result:
Název elementu Popis
ResultHeader
Obsahuje informaci o verzi rozhraní.
Response

Atributy:

ID

Identifikační číslo stavu odeslání. Dle tohoto ID lze rozpoznat příčinu chyby při neodeslání.

Type

Určuje zda byla zpráva přijata k odeslání. Obsahuje OK nebo ERROR
XML element ResponseRequestList:
Název elementu Popis
ResponseRequest
Obsahuje informaci o úspěšnosti odelsání na jednotlivá čísla v rámci Requestu.
XML element ResponseRequest:
Název elementu Popis
RequestID
Obsahuje identifikační číslo Requestu. Dle tohoto ID lze dohledat informaci o úspšnosti odeslání či doručení. Toto ID je vždy unikátní (pozn.: pokud odesíláte více zpráv v samostatných volání a požadavky se liší jen telefonním číslem, může se stát, že bude vráceno jedno ID vícekrát).
ResponseNumbersList
Obsahuje telefonní čísla, na která byla v rámci Requestu zpráva odesílána.

Pokud chcete využít napojení na existující služby, prohlédněte si dokumentaci.
API dokumentace

U nás lze vše realizovat online. Včetně plateb. Podporujeme platební karty VISA, MasterCard a systém PayPal. Máme účet u Raiffeisenbank pro rychlé obdržení Vaší platby. VISA MasterCard PayPal