API pro práci s SMS

Součást 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
  • formát odpovědi: plain-text, hodnoty oddělené čárkou
  • vyžaduje autentizaci
  • příklad odpovědi:
    Odorik.cz,5517,00420789123456

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

  • výpis odeslaných a přijatých zpráv
  • povinné parametry:
    • from, to: časové rozmezí hovorů; řetězec formátovaný jako 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 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 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 autentizaci
 
api/sms.txt · Poslední úprava: 2016/05/27 10:54 autor: michal