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 nebo 3 nebo 4). 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 nebo 3 nebo 4).
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 {
  "success" : true,
  "result" : {
    "accounts" : [
      {
        "account" : 1,
        "accountType" : "general",
        "enabled" : false,
        "sipNumber" : "",
        "registrationEnabled" : false,
        "registered" : false
      },
      {
        "account" : 2,
        "accountType" : "general",
        "enabled" : true,
        "sipNumber" : "1784973567",
        "registrationEnabled" : true,
        "registered" : true,
        "registerTime" : 1721138562
      },
      {
        "account" : 3,
        "accountType" : "local",
        "enabled" : true,
        "sipNumber" : "2NIPStyle-5034500194"
      },
      {
        "account" : 4,
        "accountType" : "msteams",
        "enabled" : true,
        "sipNumber" : "+1784973567",
        "registrationEnabled" : true,
        "registered" : true,
        "registerTime" : 1721138562
      }
    ]
  }
}