Rozhraní Odorik pro příkazovou řádku¶

Použití¶

odorik [parameter] <command> [options]

Jednotlivé příkazy určují jaká operace se provede.

Popis¶

Tento modul také nainstaluje odorik, který vám ho umožní používat z příkazové řádky.

Globální volby¶

Program rozumí následujícím globálním volbám. Tyto musí být zadány před příkazem.

--format {csv,json,text,html}¶: Určí výstupní formát.

--url URL¶: Nastaví API URL. Přepíše hodnotu z konfiguračního souboru, viz Soubory.

--user USER¶: Nastaví API uživatele. Přepíše hodnotu z konfiguračního souboru, viz Soubory.

--password PASSWORD¶: Nastaví API heslo. Přepíše hodnotu z konfiguračního souboru, viz Soubory.

--config PATH¶: Cesta ke konfiguračnímu souboru, viz Soubory.

--config-section SECTION¶: Sekce v konfiguračním souboru, viz Soubory.

Příkazy¶

V současné době jsou k dispozici tyto příkazy:

version¶: Vypíše verzi programu.

api PATH [--post] [--param KEY=VALUE]...¶

Provede autentizované volání API. Jako výchozí se použije metoda GET, volbou --post ji změníte na POST.

Další parametry můžete zadat volbou --param, která může být uvedena vícekrát.

balance¶: Vypíše aktuální zůstatek.

mobile-data [--list] [--phone NUMBER] [--all] [DATE PERIOD]¶

Vypíše použití mobilních dat.

S parametrem --list vypíše i jednotlivé položky.

Výsledek může být také omezen na telefonní číslo zadáním volby --phone. Telefonní číslo zadávejte ve tvaru 00420789123456.

Pokud použijete volbu --all, program vypíše souhrn pro všechny linky na účtu.

Informace o zadání intervalu dat naleznete v Zadávání časového intervalu.

calls [--list] [--line LINE] [--direction {in,out,redirected}] [--status {answered,missed}] [DATE PERIOD]¶

Vypíše hovory.

S parametrem --list vypíše i jednotlivé položky.

Výsledek může být také omezen na jednu linku použitím --line.

Hovory dále můžete filtrovat pomocí --status nebo --direction.

Informace o zadání intervalu dat naleznete v Zadávání časového intervalu.

sms [--list] [--line LINE] [DATE PERIOD]¶

Vypíše SMS zprávy.

S parametrem --list vypíše i jednotlivé položky.

Výsledek může být také omezen na jednu linku použitím --line.

Informace o zadání intervalu dat naleznete v Zadávání časového intervalu.

send-sms [--sender SENDER] recipient message¶

Odešle SMS zprávu.

Číslo odesílatele můžete změnit pomocí --sender. Musí se jednat o jednu z povolených hodnot. Jako výchozí se použije 5517.

callback [--line LINE] caller recipient¶: Objedná zpětné volání.

lines [--generate-config]¶

Vypíše informace o linkách.

S volbou --generate-config tento příkaz vytvoří položky do konfiguračního souboru pro pojmenování linek a telefonních čísel, viz Soubory.

summary [DATE PERIOD]¶

Vypíše souhrnné informace o všech linkách pod účtem.

Informace o zadání intervalu dat naleznete v Zadávání časového intervalu.

Zadávání časového intervalu¶

Pro mnoho příkazů můžete zadat časový interval na který se budou aplikovat:

--this-month¶: Vypíše informace pro tento měsíc. Jedná se o výchozí interval.

--last-month¶: Vypíše informace pro minulý měsíc.

--start-date DATE¶: Počáteční datum.

--end-date DATE¶: Koncové datum. Pokud nebude zadáno použije se aktuální.

Všechny volby zpracují datum nebo čas v téměř jakémkoliv formátu. V dokumentaci k dateutil naleznete podrobnější popis (obzvlášť popis pořadí roku, měsíce a dne).

Soubory¶

~/.config/odorik: Konfigurační soubor uživatele
/etc/xdg/odorik: Systémový konfigurační soubor

Program dodržuje specifikaci XDG, takže umístění konfiguračních souborů můžete ovlivnit proměnnými prostředí XDG_CONFIG_HOME nebo XDG_CONFIG_DIRS.

Následující parametry mohou být nastaveny v sekci [odorik] (nebo vámi zadané pomocí volby --config-section):

user: API uživatel, může být buď ID uživatele nebo linky.

password: API heslo. Použijte API heslo pro uživatele nebo heslo linky (stejné jako pro SIP) pro přístup na linku.

url: URL API serveru, výchozí je https://www.odorik.cz/api/v1/.

Více informací naleznete na wiki v sekci Autentizace Odorik API.

Konfigurační soubor je ve formátu INI. Například může vypadat takto:

[odorik]
user = pepa
password = zdepa

Dále může konfigurační soubor obsahovat pojmenování pro telefonní čísla a linky:

[lines]
pepa = 12345

[numbers]
pepa = 00420789789789
franta = 00420789123456

Příklady¶

Vypsat verzi programu:

$ odorik version
version: 0.1

Vypsat aktuální zůstatek:

$ odorik balance
balance: 123.45

Vypsat aktuální využití mobilních dat:

$ odorik mobile-data --phone 00420789123456
bytes_total: 111593707
bytes_down: 87039672
bytes_up: 24554035
price: 0

Odeslání zprávy:

$ odorik send-sms 00420789123456 "Ahoj, jak se mas?"

Objednání zpětného volání:

$ odorik callback 00420789123456 800123456

Výpis souhrnných informací o účtu:

$ odorik summary
Pepa
id: 716000
public_number: 00420789789789
call_count: 58
sms_count: 42
bytes_total: 145921813
data_price: 0.01
call_price: 24.28
sms_price: 12.31
price: 36.59

Franta
id: 717000
public_number: 00420789123456
call_count: 11
sms_count: 0
bytes_total: 0
data_price: 0
call_price: 2.20
sms_price: 0
price: 2.20

Obecné použití API:

$ odorik api sms/allowed_sender
Odorik.cz,5517,00420789123456

Obecné použití POST API:

$ odorik api --post --param caller=00420789123456 --param recipient=800123456 callback

Strojově zpracovatelné výstupní formáty:

$ odorik --format json mobile-data
{
  "bytes_total": 111593707,
  "bytes_down": 87039672,
  "bytes_up": 24554035,
  "price": 0.008
}
$ odorik --format csv mobile-data
bytes_total,111593707
bytes_down,87039672
bytes_up,24554035
price,0.008