API rozhraní
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://.
Dostupná rozhraní
Send
Adresa:
http://xml-api.smsmanager.cz/Send
Data:
XMLDATA
Struktura XML dokumentu:
<RequestDocument>
<RequestHeader>
<Username>test</Username>
<Password>a94a8fe5ccb19ba61c4c0873d391e987982fbbd3</Password>
</RequestHeader>
<RequestList>
<Request Type="high">
<Message Type="Text">Test</Message>
<NumbersList>
<Number>420777123456</Number>
</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: lowcost nebo high. 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. |
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. |
1) Element se musí vyskytovat minimálně jednou. Lze použít více těchto elementů.
Struktura odpovědi:
Content-Type: text/xmlv kódování UTF-8.
<Result>
<ResultHeader>
<Interface Version="1.0" />
</ResultHeader>
<Response Type="OK" ID="0" />
<ResponseRequestList>
<ResponseRequest>
<RequestID>XXX</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í. |
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
