5.10.4 api log pull

Funkce /api/log/pull provádí čtení položek z fronty kanálu (subscription) a vrací seznam dosud nevyčtených událostí, příp. prázdný seznam, pokud žádná nová událost není k dispozici. Větší množství událostí jsou pak stahovány po dávkách o 128 událostech.

Pomocí parametru timeout lze specifikovat maximální dobu, za jakou musí interkom vygenerovat odpověď. V případě, že ve frontě kanálu je alespoň jedna položka, odpověď je vygenerována okamžitě. V případě, že je fronta kanálu prázdná, interkom odloží odeslání odpovědi do doby, než vznikne nová událost, příp. vyprší nastavený timeout.

Funkce je součástí služby Logging a pro provedení funkce nejsou potřeba žádná zvláštní privilegia uživatele. Čtení událostí je podmíněno privilegii uživatele tyto události sledovat, viz tabulka událostí v 5.10.2 api log subscribe.

Pro tuto funkci lze použít metody GET nebo POST.

Parametry požadavku:

Parametr

Typ

Povinný

Výchozí

hodnota

Popis

id

uint32

Ano

–

Identifikátor existujícího kanálu vytvořeného předchozím voláním funkce /api/log/subscribe.

timeout

uint32

Ne

0

Specifikuje zpoždění odpovědi (v sekundách) v případě, že fronta kanálu je prázdná. Výchozí hodnota 0 znamená, že interkom odpovídá vždy okamžitě bez jakéhokoliv zpoždění.

Odpověď je ve formátu application/json a obsahuje seznam událostí.

Parametr	Typ	Popis
events	array	Pole objektu události. V případě, že během nastaveného timeoutu nenastala žádná událost, je pole prázdné.

Příklad:

GET /api/log/pull
{

  "success" : true,
  "result" : {
    "events" : [
      {
        "id" : 1,
		"tzShift" : 0,
        "utcTime" : 1437987102,
        "upTime" : 8,
        "event" : "DeviceState",
        "params" : {
          "state" : "startup"
        }
      },
      {
        "id" : 3,
        "tzShift" : 0,
        "utcTime" : 1437987105,
        "upTime" : 11,
        "event" : "RegistrationStateChanged",
        "params" : {
          "sipAccount" : 1,
          "state" : "registered"
        }
      }
    ]
  }
}

Události

Každá událost v poli events obsahuje následující informace, které jsou společné pro všechny typy událostí:

Parametr	Typ	Popis
id	uint32	Interní ID záznamu o události (32bit číslo, 1 po restartu interkomu, inkrementované s každou novou událostí)
utcTime	uint32	Absolutní čas vzniku události (Unix Time, UTC – koordinovaný světový čas).
upTime	uint32	Relativní čas vzniku události (počet sekund od restartu interkomu).
tzShift	int32	Rozdíl mezi místním časem a časem UTC v minutách. Přičtením této hodnoty k utcTime se získá místní čas vzniku události dle nastavení časové zóny v zařízení: localTime = utcTime + tzShift * 60
event	string	Typ události ("KeyPressed", "InputChanged", ...)
params	object	Specifické parametry události.

Událost DeviceState

Signalizuje změny stavu zařízení.

Parametry události:

Parametr

Typ

Popis

state

string

Signalizovaný stav zařízení:

"startup" – generováno jednorázově po startu zařízení (vždy úplně první událost)

Příklad:

{
  "id" : 1,
  "tzShift" : 0,
  "utcTime" : 1437987102,
  "upTime" : 8,
  "event" : "DeviceState",
  "params" : {
    "state" : "startup"
  }
}

Událost AudioLoopTest

Signalizuje provedení automatického audio loop testu a jeho výsledek. Událost je signalizovaná vždy po provedení automatického testu (naplánovaného příp. manuálně spuštěného).

Parametr

Typ

Popis

result

string

Výsledek provedeného testu.

"passed" – test byl úspěšně proveden a nebyl zjištěn žádný problém

"failed" – test byl proveden, ale byl detekován problém s reproduktorem nebo mikrofonem v zařízení

Příklad:

{
  "id" : 26,
  "tzShift" : 0,
  "utcTime" : 1438073190,
  "upTime" : 9724,
  "event" : "AudioLoopTest",
  "params" : {
    "result" : "passed"
  }
}

Událost MotionDetected

Signalizuje detekci pohybu pomocí kamery. Událost je dostupná pouze na modelech vybavených kamerou. Událost se generuje pouze v případě, že v konfiguraci kamery interkomu je tato funkce povolena.

Parametry události:

Parametr

Typ

Popis

state

string

Stav detektoru pohybu:

"in" – signalizuje začátek intervalu, ve kterém byl detekován pohyb

"out" – signalizuje konec intervalu, ve kterém byl detekován pohyb

Příklad:

{
  "id" : 2,
  "tzShift" : 0,
  "utcTime" : 1441357589,
  "upTime" : 1,
  "event" : "MotionDetected",
  "params" : {
    "state" : "in"
  }
}

Událost NoiseDetected

Signalizuje zvýšenou hladinu zvuku detekovanou pomocí zabudovaného nebo externího mikrofonu. Událost se generuje pouze v případě, že v konfiguraci interkomu je tato funkce povolena.

Parametry události:

Parametr

Typ

Popis

state

string

Stav detektoru hluku:

"in" – signalizuje začátek intervalu, ve kterém byl detekován hluk

"out" – signalizuje konec intervalu, ve kterém byl detekován hluk

Příklad:

{
  "id" : 2,
  "tzShift" : 0,
  "utcTime" : 1441357589,
  "upTime" : 1,
  "event" : "NoiseDetected",
  "params" : {
    "state" : "in"
  }
}

Události KeyPressed a KeyReleased

Signalizuje stisk (KeyPressed) nebo uvolnění (KeyReleased) tlačítka nebo klávesy numerické klávesnice.

Parametry události:

Parametr

Typ

Popis

key

string

Kód stisknutého nebo uvolněného tlačítka:

"0" až "9" – tlačítka numerické klávesnice

"%1" – "%150" - tlačítka rychlé volby

"*" – tlačítko se symbolem * příp. telefonu

"#" – tlačítko se symbolem # příp. klíčku

Příklad:

{
  "id" : 4,
  "tzShift" : 0,
  "utcTime" : 1437987888,
  "upTime" : 794,
  "event" : "KeyPressed",
  "params" : {
    "key" : "5"
  }
}

Událost CodeEntered

Signalizuje zadání kódu uživatelem na numerické klávesnici interkomu. Událost se generuje pouze na zařízeních vybavených numerickou klávesnicí.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikáté zadání kódu se jedná.
direction	string	Směr průchodu: "in" – příchod "out" – odchod "any" – průchod Pozn.: Směr průchodu čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
code	string	Uživatelem zadaný kód, např. "1234". Kódy mají minimálně dvě číslice a kód "00" nelze použít.
type	string
uuid	string	Unikátní ID uživatele.
valid	boolean	Platnost zadaného kódu (tj. zda je kód zaveden v konfiguraci interkomu jako platný kód uživatele nebo jako platný univerzální kód spínače). false – kód není platný true – kód je platný

Příklad:

{
  "id" : 128,
  "tzShift" : 0,
  "utcTime" : 1548078453,
  "upTime" : 1061,
  "event" : "CodeEntered",
  "params" : {
    "ap" : 0,
    "session" : 8,
    "direction" : "in",
    "code" : "1234",
    "type" : "user",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c",
    "valid" : true
  }
}

Událost CardEntered

Signalizuje přiložení RFID karty ke čtečce. Událost je dostupná pouze na modelech vybavených čtečkou RFID karet.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikáté přiložení karty se jedná.
direction	string	Směr průchodu RFID čtečky: "in" – příchod "out" – odchod "any" – průchod Pozn.: Směr průchodu čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
reader	string	Jméno RFID čtečky příp. Wiegand modulu, příp. jedna z následujících hodnot pro nemodulární modely interkomu: "internal" – interní čtečka (2N IP interkomy) "external" – externí čtečka připojená pomocí Wiegand interface Pozn.: Jméno čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
uid	string	Jednoznačný identifikátor přiložené karty (číslo v hexadecimálním formátu, 6–16 znaků, podle typu karty).
uuid	string	Unikátní ID uživatele.
valid	boolean	Platnost přiložené RFID karty (tj. zda je uid karty přiřazeno jednomu z uživatelů v adresáři interkomu). false – karta není platná true – karta je platná

Příklad:

{
  "id" : 60,
  "tzShift" : 0,
  "utcTime" : 1548078014,
  "upTime" : 622,
  "event" : "CardEntered",
  "params" : {
    "ap" : 0,
    "session" : 5,
    "direction" : "in",
    "reader" : "ext2",
    "uid" : "4BD9E903",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c",
    "valid" : true
  }
}

Události InputChanged a OutputChanged

Signalizuje změnu stavu logického vstupu (InputChanged) nebo výstupu (OutputChanged). Aktuální seznam dostupných vstupů a výstupů lze zjistit pomocí funkce /api/io/caps.

Parametry události:

Parametr

Typ

Popis

port

string

Název I/O portu.

state

boolean

Aktuální logický stav I/O portu:

false – neaktivní, log.0

true – aktivní, log.1

Příklad:

{
  "id" : 2,
  "tzShift" : 0,
  "utcTime" : 1437987103,
  "upTime" : 9,
  "event" : "OutputChanged",
    "params" : {
      "port" : "led_secured",
      "state" : false
  }
}

Událost SwitchStateChanged

Signalizuje změnu stavu spínače (viz konfigurace interkomu Hardware | Spínače).

Parametry události:

Parametr

Typ

Popis

switch

uint32

Číslo spínače 1..4

state

boolean

Aktuální logický stav spínače:

false – neaktivní, log.0

true – aktivní, log.1

originator

Informuje, jakým způsobem byl switch aktivován.

profile – vyvoláno přechodem na nastavený aktivní časový profil.

api – vyvoláno pomocí http api (api/switch/ctrl).

ap – autentizace uživatele na přístupovém bodu. Událost pak doplňuje číslo app a session.

rex – stisk odchodového tlačítka (tlačítko, které otevírá dveře po definovanou dobu, kdy osoba opouští místnost).

idt – vyvoláno pomocí http api (api/switch/ctrl), pokud se použila speciální autentizace pro 2N^® Indoor Touch 2.0, 1.0.

dtmf – použití dtmf kódu v hovoru.

auth – autorizace pomocí uživatelského, universálního nebo zónového kódu.

uni – autorizace pomocí univerzálního kódu.

zone – autorizace pomocí zónového kódu.

automation – vyvoláno pomocí akce automation.

Příklad:

{
  "id" : 2,
  "tzShift" : 0,
  "utcTime" : 1437987103,
  "upTime" : 9,
  "event" : "SwitchStateChanged",
    "params" : {
        "switch" : 1,
        "state" : true
  }
}

Událost CallStateChanged

Signalizuje vytvoření, ukončení příp. jinou změnu stavu probíhajícího hovoru.

Parametry události:

Parametr	Typ	Popis
	string	Specifikuje, zda se jedná o příchozí nebo odchozí hovor: "incoming" – příchozí hovor "outgoing" – odchozí hovor
	string	Aktuální stav automatu hovoru: "connecting" – probíhá sestavování hovoru (pouze odchozí hovory) "ringing" – vyzvánění "connected" – hovor spojen "terminated" – hovor ukončen
peer	string	SIP URI volajícího (příchozí hovory) nebo volaného (odchozí hovory) účastníka.
session	uint32	Jednoznačný identifikátor hovoru. Identifikátor hovoru lze dále použít ve funkcích /api/call/answer, /api/call/hangup a /api/call/status.
call	uint32	TBD

Příklad:

{
  "id" : 5,
  "tzShift" : 0,
  "utcTime" : 1438064126,
  "upTime" : 660,
  "event" : "CallChanged",
  "params" : {
    "direction" : "incoming",
    "" : "ringing",
    "peer" : "sip:2229@10.0.97.150:5062;user=phone",
    "session" : 1,
    "call" : 1
  }
}

Událost RegistrationChanged

Signalizuje změnu stavu registrace všech SIP účtů k SIP serveru.

Parametry události:

Parametr

Typ

Popis

sipAccount

uint32

Číslo SIP účtu, na kterém proběhla změna stavu:

1 – první SIP účet

2 – druhý SIP účet

string

Udává nový stav automatu registrace SIP účtu:

"registered" – účet byl úspěšně zaregistrován

"unregistered" – účet byl odregistrován

"registering" – probíhá registrace

"unregistering" – probíhá odregistrování účtu

Příklad:

{
  "id" : 3,
  "tzShift" : 0,
  "utcTime" : 1437987105,
  "upTime" : 11,
  "event" : "RegistrationChanged",
  "params" : {
    "sipAccount" : 1,
    "" : "registered"
  }
}

Událost TamperSwitchActivated

Signalizuje aktivaci ochranného spínače – otevření krytu zařízení. Funkce ochranného spínače musí být nakonfigurována v menu Digitální vstupy / Ochranný spínač.

Parametry události:

Parametr

Typ

Popis

string

Stav ochranného spínače:

"in" – signalizuje aktivaci ochranného spínače (tj. otevření krytu zařízení)

"out" – signalizuje deaktivaci ochranného spínače (tj. zavření krytu zařízení)

Příklad:

{
  "id" : 54,
  "tzShift" : 0,
  "utcTime" : 1441357589,
  "upTime" : 158,
  "event" : "TamperSwitchActivated",
  "params" : {
    "state" : "in"
  }
}

Událost UnauthorizedDoorOpen

Signalizuje neautorizované otevření dveří. Vyžaduje připojení snímače otevřených dveří na jeden z digitálních vstupů a příslušné nastavení v menu Digitální vstupy | Stav dveří.

Parametry události:

Parametr

Typ

Popis

state

string

Stav neautorizovaného otevření dveří:

"in" – signalizuje zahájení stavu neautorizovaného otevření

"out" – signalizuje ukončení stavu neautorizovaného otevření dveří

Příklad:

{
  "id" : 80,
  "tzShift" : 0,
  "utcTime" : 1441367842,
  "upTime" : 231,
  "event" : "UnauthorizedDoorOpen",
  "params" : {
    "state" : "in"
  }
}

Událost DoorOpenTooLong

Signalizuje dlouhé otevření dveří, resp. nezavření dveří do nastavené doby. Vyžaduje připojení snímače otevřených dveří na jeden z digitálních vstupů a příslušné nastavení v menu Digitální vstupy | Stav dveří.

Parametry události:

Parametr

Typ

Popis

state

string

Stav dlouhého otevření dveří:

"in" – signalizuje zahájení stavu dlouhého otevření dveří.

"out" – signalizuje ukončení stavu dlouhého otevření dveří.

Příklad:

{
  "id" : 96,
  "tzShift" : 0,
  "utcTime" : 1441369745,
  "upTime" : 275,
  "event" : "DoorOpenTooLong",
  "params" : {
    "state" : "out"
  }
}

Událost LoginBlocked

Signalizuje dočasné zablokování přístupu k webovému rozhraní z důvodu opakovaného zadání neplatného přihlašovacího jména nebo hesla.

Parametry události:

Parametr	Typ	Popis
address	string	IP adresa, ze které bylo provedeno opakované přihlášení s neplatnými údaji.

Příklad:

{
  "id" : 5,
  "tzShift" : 0,
  "utcTime" : 1441369745,
  "upTime" : 275,
  "event" : "LoginBlocked",
  "params" : {
    "address" : "10.0.23.32"
  }
}

Událost UserAuthenticated

Signalizuje autentizaci uživatele a následné otevření dveří.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikátou autorizaci uživatele se jedná.
name	string	Specifikuje jméno uživatele z telefonního seznamu
uuid	string	Unikátní ID uživatele.
apbBroken	string	Platnost přiložené karty v Anti-passback oblasti. false – oblast soft APB není aktivní true – oblast soft ABP je aktivní a je porušena

Příklad:

{
  "success" : true,
  "result" : {
    "events" : [
      {
        "id" : 65,
        "tzShift" : 0,
        "utcTime" : 1593606655,
        "upTime" : 7951,
        "event" : "UserAuthenticated",
        "params" : {
          "ap" : 0,
          "session" : 6,
          "name" : "Alice Gruberov\u00E1",
          "uuid" : "8fa29ebc-2fe8-4a8c-9a3b-d8b0351fb6f8",
          "apbBroken" : true
        }
      }
    ]
  }
}

Událost CardHeld

Signalizuje přiložení RFID karty ke čtečce delší než 4 s.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikáté přiložení karty se jedná.
direction	string	Směr průchodu RFID čtečky: "in" – příchod "out" – odchod "any" – průchod Pozn.: Směr průchodu čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
reader	string	Identifikace čtečky, která kartu načetla.
uid	string	Identifikátor uživatele.
valid	string	Platnos přiložené karty (tj. zda je karty zavedena v konfiguraci interkomu jako platná pro uživatele.). false – karta není platná true – karta je platná

Příklad:

{    
  "id" : 9,
  "tzShift" : 0,
  "utcTime" : 1516893493,
  "upTime" : 354,
  "event" : "CardHeld",
  "params" : {
    "ap" : 1,
    "session" : 4,
    "direction" : "out",
    "reader" : "ext2",
    "uid" : "3F00F318E7",
    "valid" : true
   }
}

Událost SilentAlarm

Signalizuje aktivaci tichého alarmu.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikátý SilentAlarm se jedná.
name	string	Specifikuje jméno uživatele z telefonního seznamu.
uuid	string	Unikátní ID uživatele.

Příklad:

{
  "id" : 200,
  "tzShift" : 0,
  "utcTime" : 1548079445,
  "upTime" : 2053,
  "event" : "SilentAlarm",
  "params" : {
    "ap" : 0,
    "session" : 17,
    "name" : "Joseph",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c"
  }
}

Událost AccessLimited

Signalizuje odmítnutí zadaného uživatele.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
type	string	card, code, finger
state	string	Stav, možné hodnoty: in = aktivní, out = neaktivní.

Příklad:

{
	"id" : 408,
	"tzShift" : 0,
	"utcTime" : 1517302112,
	"upTime" : 408951,
	"event" : "AccessLimited",
	"params" : {
	  "ap" : 0,
	  "type" : "card",
	  "state" : "in"
	}
}

Událost PairingStateChange

Signalizuje párování s bluetooth rozhraním.

Parametry události:

Parametr	Typ	Popis
state	string	pending / inactive / pending_blocked / expired / paired
authId	string	Autorizační ID

Příklad:

{
        "id" : 197,
        "tzShift" : 0,
        "utcTime" : 1516894499,
        "upTime" : 1360,
        "event" : "PairingStateChanged",
        "params" : {
          "state" : "pending",
          "authId" : "F2CAE955C9B4E81CD00E3A096E52543B"
        }
      }

Událost SwitchesBlocked

Signalizuje zablokování zámků ochranným spínačem. Pokud je funkce povolena, po aktivaci ochranného spínače dojde k zablokování všech spínačů po dobu 30 minut. Blokování bude aktivní i po restartu zařízení.

Parametry události:

Parametr	Typ	Popis
state	string	in, out

Příklad:

{
        "id" : 205,
        "tzShift" : 0, "utcTime" : 1516894667,
        "upTime" : 1528,
        "event" : "SwitchesBlocked",
        "params" : {
          "state" : "in"
        }
     }

Událost FingerEntered

Signalizuje přiložení prstu ke čtečce otisků prstů.

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikáté přiložení prstu se jedná.
direction	string	Směr průchodu čtečky otisků prstů: "in" – příchod "out" – odchod "any" – průchod Pozn.: Směr průchodu čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
uuid	string	Unikátní ID uživatele.
valid	string	Platnost otisku prstu (tj. zda je otisk prstu zaveden v konfiguraci interkomu jako platný otisk prstu uživatele). false – otisk prstu není platný true – otisk prstu je platný

Příklad: Načtení prstu zadaného uživatele

{
  "id" : 18,
  "tzShift" : 0,
  "utcTime" : 1548077595,
  "upTime" : 203,
  "event" : "FingerEntered",
  "params" : {
    "ap" : 0,
    "session" : 2,
    "direction" : "in",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c",
    "valid" : true
  }
}

Neúspěšné zadání: Načtení prstu nezadaného uživatele

{
  "id" : 1368,
  "tzShift" : 0,
  "utcTime" : 1548145535,
  "upTime" : 62598,
  "event" : "FingerEntered",
  "params" : {
    "ap" : 0,
    "session" : 1,
    "direction" : "in",
    "valid" : false
  }
}

Událost MobKeyEntered

Signalizuje autorizaci pomocí bluetooth čtečky.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikátou autorizaci pomocí WaveKey se jedná.
direction	string	Směr průchodu: "in" – příchod "out" – odchod "any" – průchod Pozn.: Směr průchodu čtečky se nastavuje pomocí konfiguračního rozhraní interkomu.
authid	string	WaveKey ID.
uuid	string	Unikátní ID uživatele.
valid	string	Platnost WaveKey (tj. zda je WaveKey zaveden v konfiguraci interkomu jako platný WaveKey pro uživatele). false – WaveKey není platný true – WaveKey je platný

Příklad:

{
  "id" : 161,
  "tzShift" : 0,
  "utcTime" : 1548079174,
  "upTime" : 1782,
  "event" : "MobKeyEntered",
  "params" : {
    "ap" : 0,
    "session" : 9,
    "direction" : "in",
    "authid" : "48c48155eed7ea1dbb0b4d534b7459b9",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c",
    "valid" : true
  }
}

Událost DoorStateChanged

Signalizuje změnu stavu dveří.

Parametry události:

Parametr	Typ	Popis
state	string	opened, closed

Příklad:

{
        "id" : 240,
        "tzShift" : 0,
        "utcTime" : 1516895295,
        "upTime" : 2156,
        "event" : "DoorStateChanged",
        "params" : {
          "state" : "opened"
        }     
}

Událost UserRejected

Signalizuje odmítnutí autorizace uživatele.

Parametry události:

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikáté odmítnutí autorizace se jedná.
name	string	Jméno uživatele.
uuid	string	Unikátní ID uživatele.
reason	string	accessBlocked, switchLocked, invalidTime, invalidProfile, invalidSequence, invalidCredential, authInterupted, timeout, switchDisabled

Příklad:

{
  "id" : 173,
  "tzShift" : 0,
  "utcTime" : 1548079274,
  "upTime" : 1882,
  "event" : "UserRejected",
  "params" : {
    "ap" : 0,
    "session" : 10,
    "name" : "Joseph",
    "uuid" : "54877b0e-4cc3-c645-9530-6c7850f47a9c",
    "reason" : "invalidCredential"
  }
}

Událost DisplayTouched

Signalizuje dotyk na displeji.

Parametry události:

Parametr	Typ	Popis
x	string	Souřadnice bodu dotyku na displeji. Maximální hodnota je dána rozlišením displeje.
y	string	Souřadnice bodu dotyku na displeji.
dx	string	Změna souřadnic při posunu na displeji, může nabývat i záporné hodnoty. Maximální hodnota je dána rozlišením displeje.
dy	string	Změna souřadnic při posunu na displeji.

Příklad:

{
	"id" : 337,
	"tzShift" : 0,
	"utcTime" : 1517301424,
	"upTime" : 408263,
	"event" : "DisplayTouched",
	"params" : {
	  "x" : 89,
 	  "y" : 100,
	  "dx" : 0,
	  "dy" : 0
	}
}

Událost DtmfEntered

Signalizuje DTMF kód v hovoru.

{
    "id" : 86,
    "tzShift" : 0,
    "utcTime" : 1558522871,
    "upTime" : 3531,
    "event" : "DtmfEntered",
    "params" : {
      "code" : "00",
      "type" : "uni",
      "call" : 3,
      "valid" : true
 }
}

Parametr	Typ	Popis
code	string	Znění zadaného kódu.
type	string	Informuje, jaký typ kódu byl použit. uni – univerzální kód spínače user – uživatelský kód
call	string	ID hovoru.
valid	string	Platnost zadaného kódu (tj. platný univerzální kód spínače nebo platný uživatelský kód). false – kód není platný true – kód je platný

Událost AccessTaken

Signalizuje přiložení karty v Anti-passback oblasti.

{
  "success" : true,
  "result" : {
    "events" : [

    ]
  }
}

Událost ApLockStateChanged

Signalizuje změnu stavu (zapnuto/vypnuto) nouzového uzamčení.

{
    "id" : 35,
    "tzShift" : 0,
    "utcTime" : 1558522465,
    "upTime" : 3125,
    "event" : "ApLockStateChanged",
    "params" : {
      "ap" : 0,
      "state" : "in"                    
    }
}

Parametr

Typ

Popis

ap

string

Access Point, možné stavy: 0 = entry, 1 = exit.

state

string

Stav změny stavu.

"in" – signalizuje začátek intervalu nouzového uzamčení

"out" – signalizuje konec intervalu nouzového uzamčení

Událost RexActivated

Signalizuje aktivaci vstupu, která je nastavena na tlačítko REX.

{
    "id" : 29,
    "tzShift" : 0,
    "utcTime" : 1558522162,
    "upTime" : 2822,
    "event" : "RexActivated",
    "params" : {
      "ap" : 1,                           
      "session" : 1
    }
}

Parametr	Typ	Popis
ap	string	Access Point, možné stavy: 0 = entry, 1 = exit.
session	string	Informuje, o kolikátou aktivaci REX tlačítka se jedná.

Událost LiftStatusChanged

Signalizuje detekci připojení/odpojení Lift Control modulu.

 {
        "id" : 2871,
        "tzShift" : 0,
        "utcTime" : 1561540370,
        "upTime" : 73822,
        "event" : "LiftStatusChanged",
        "params" : {
          "module" : 0,
          "ready" : true
        }
     
},

Parametr

Typ

Popis

module

string

Informuje o ID modulu.

ready

string

Informuje o stavu modulu.

false – odpojeno

true – připojeno

Událost LiftFloorsEnabled

Signalizuje permanentní povolení přístupu na patro nebo trvalý přístup uživatele

 {
        "id" : 2850,
        "tzShift" : 0,
        "utcTime" : 1561540011,
        "upTime" : 73463,
        "event" : "LiftFloorsEnabled",
        "params" : {
          "type" : "user" 
          "floors" : [
            0, 1, 2, 3, 4
          ],
          "uuid" : "621a5a49-1f8b-d34c-9a8b-881055864deb",
        }
      },

 {
        "id" : 2855,
        "tzShift" : 0,
        "utcTime" : 1561540016,
        "upTime" : 73468,
        "event" : "LiftFloorsEnabled",
        "params" : {
          "type" : "public" 
          "floors" : [
            1, 4
          ],
        }
      },

Parametr

Typ

Popis

type

string

Informuje, o jaký typ přístupu se jedná.

public – změna veřejného přístupu

user – při autentizaci uživatele

floors

string

Informuje o přístupných patrech.

Událost LiftConfigChanged

Signalizuje změnu nastavení řízení výtahu.

       {
        "id" : 2860,
        "tzShift" : 0,
        "utcTime" : 1561540163,
        "upTime" : 73615,
        "event" : "LiftConfigChanged",
        "params" : {
          "hash" : 11
        }
      },

Parametr	Typ	Popis
hash	string	Unikátní číslo změny konfigurace.

Událost CapabilitiesChanged

Signalizuje změnu dostupných funkcí.

{   
  "success":true,
  "result":{      
   "events":[        
     {            
      "id":21,
      "tzShift":0,
      "utcTime":1585037151,
      "upTime":256,
      "event":"CapabilitiesChanged",
      "params":{
       
      }
      
     }


   ]
   
  }

}

Parametr	Typ	Popis
id	string	Pořadové číslo události.
tzShift	uint32	Rozdíl mezi místním časem a časem UTC v minutách. Přičtením této hodnoty k utcTime se získá místní čas vzniku události dle nastavení časové zóny v zařízení: localTime = utcTime + tzShift * 60
utcTime	uint32	Absolutní čas vzniku události (Unix Time, UTC – koordinovaný světový čas).
upTime	uint32	Relativní čas vzniku události (počet sekund od restartu interkomu).
event	string	Typ události CapabilitiesChanged.
params	object	Specifické parametry události.