5.7.1 api call status

Funkce /api/call/status slouží k získání aktuální stavu probíhajících telefonního hovorů. Funkce vrací seznam probíhajících hovorů a jejich parametry.

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
session	Volitelný parametr obsahující identifikátor hovoru, jehož stav se má vrátit. Pokud parametr není uveden, funkce vrací stav všech probíhajících hovorů.

Odpověď je ve formátu application/json a obsahuje seznam probíhajících hovorů (pole sessions) a jejich aktuální stav. V případě použití parametru session obsahuje pole sessions právě jednu položku. Pokud aktuálně neprobíhá žádný hovor, pole sessions je prázdné.

Parametr	Popis
session	Identifikátor volání
direction	Směr hovoru (incoming – příchozí, outgoing – odchozí)
state	Stav hovoru (connecting, ringing, connected)
calls	Jednotlivé směřování hovorů probíhajícího volání. Například při volání telefonního čísla ve skupině se zástupcem kontaktu se vytvoří dva souběžné hovory na dvě různé destinace (peer).

Příklad:

GET /api/call/status 
[
  {
    "calls": [
      {
        "id": 6,
        "peer": "sip:10.0.29.27",
        "state": "ringing"
      },
      {
        "id": 7,
        "peer": "sip:10.0.29.31",
        "state": "ringing"
      }
    ],
    "direction": "outgoing",
    "session": 4,
    "state": "ringing"
  }
]