5.6.1 api phone status
Funkce /api/phone/status slouží k získání aktuálního stavu SIP účtů zařízení.
Funkce je součástí služby Phone/Call a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Telefon/hovory – sledování.
Pro tuto funkci lze použít metody GET nebo POST.
Parametry požadavku:
Parametr | Popis |
---|---|
account | Volitelný parametr definující identifikátor SIP účtu (1 nebo 2). Pokud parametr není uveden, funkce vrací stav všech SIP účtů. |
Odpověď je ve formátu application/json a obsahuje seznam SIP účtů zařízení (pole accounts) a jejich aktuální stav. V případě použití parametru account obsahuje pole accounts právě jednu položku.
Parametr | Popis |
---|---|
account | Jednoznačný identifikátor SIP účtu (1 nebo 2). |
enabled | Signalizuje, zda je SIP účet povolen. |
sipNumber | Telefonní číslo SIP účtu. |
registrationEnabled | Signalizuje, zda má SIP účet povolenou registraci. |
registered | Signalizuje, zda je účet úspěšně zaregistrován u SIP registraru. |
Příklad:
GET /api/phone/status GET /api/phone/status { "success" : true, "result" : { "accounts" : [ { "account" : 1, "enabled" : true, "sipNumber" : "5207", "registrationEnabled" : true, "registered" : true, "registerTime" : 1663585547 }, { "account" : 2, "enabled" : false, "sipNumber" : "", "registrationEnabled" : true, "registered" : false } ] } }