====== API pro práci s SMS ======

Součást [[:api|Odorik.cz API]] určená pro práci s textovými zprávami (SMS).

=== GET /sms/allowed_sender ===

  * vrací seznam hodnot použitelných pro hodnotu sender při odesílání SMS
  * Bez ohledu na to, co tato funkce vrátí, do ČR jsou dovoleny jen Odorik.cz, smsinfo a 5517. Pokud použijete jako odesilatele mobilní číslo, bude nahrazeno id "smsinfo". Posílání SMS do ČR je spolehlivé a potvrzená doručenka znamená, že SMS byla opravdu doručena. U posílání do zahraničí existují případy, kdy si doručenku "vymyslí" tranzitní operátor. Spolehlivost se může lišit také podle zvoleného odesilatele. Mobilní operátoři obecně a celosvětově nemají odesílání SMS přes API rádi a dělají různé naschvály, mohou SMS i úmyslně zahazovat třeba dle id odesilatele.
  * formát odpovědi: plain-text, hodnoty oddělené čárkou
  * vyžaduje [[:api#autentizace|autentizaci]]
  * příklad odpovědi: <code>Odorik.cz,5517,00420789123456</code>



=== GET /sms.csv, GET /sms.json, GET /sms.xml ===

  * výpis odeslaných a přijatých zpráv
  * nelze načíst texty přijatých nebo odeslaných zpráv, ale jen informaci o tom kdo komu kdy poslal jakou SMS.
  * je možné využít parametru **include_sms=true** u [[:api:calls#historie_hovoru|historie hovorů]], aby byly vráceny jak hovory, tak zprávy v jednom požadavku
  * povinné parametry:
    * **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//)
  * nepovinné parametry:
    * **direction**: //in/////out//; filtr na příchozí/odchozí zprávy
    * **line**: vrátit jen na zprávy u dané linky
  * vyžaduje [[:api#autentizace|autentizaci]]

=== POST /sms ===

  * požadavek na odeslání SMS zprávy
  * povinné parametry:
    * **recipient** - adresát zprávy, telefonní číslo v mezinárodním formátu začínající 00 (například: 00420789123456)
    * **message** - text zprávy, automaticky ořezáno na maximální délku 765 znaků
  * nepovinné parametry:
    * **sender** - odesílatel zprávy, musí být jedna z možností vrácena /sms/allowed_sender
    * **delayed** - opožděné odeslání zprávy; možné hodnoty jsou buď jedno číslo určující počet minut, o kolik bude zpráva zdržena, anebo přesné datum odeslání ve formátu [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2036-07-16T08:12:14Z//)
  * formát odpovědi: plain-text
  * možné odpovědi:
    * //successfully_sent <aktualni_kredit>//
    * //successfully_enqueued//
    * //error missing_argument <seznam_chybejicich_argumentu>//
    * //error empty_message//
    * //error forbidden_sender//
    * //error unsupported_recipient//
    * //error low_balance//
    * //error gateway_failed//
    * //error invalid_delay_format//
    * //error delayed_into_past//
  * vyžaduje [[:api#autentizace|autentizaci]]