5.6.3 api phone config
Funkce /api/phone/config slouží ke sledování a kontrolování nastavení SIP účtů.
U této funkce lze použít metodu GET pro stažení a PUT pro nahrání konfigurace.
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 metodu GET a Telefon/hovory – řízení pro metodu PUT.
Metoda GET
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ů. |
Pro metodu GET je odpověď ve formátu application/json a obsahuje seznam SIP účtů zařízení (pole accounts) a jejich aktuální stav. V případě použití specifikování účtu parametrem account odpověď obsahuje jen informace o daném účtu.
Upozornění
- Zařízení z bezpečnostních důvodů nevrací heslo při použití metody GET.
Příklad:
GET /api/phone/config { "success": true, "result": { "accounts": [ { "account": 1, "enabled": false, "displayName": "", "sipNumber": "", "domain": "", "domainPort": "", "authId": "", "proxyAddress": "", "proxyPort": "", "registrationEnabled": false, "registrarAddress": "", "registrarPort": "", "answerMode": "1" }, { "account": 2, "enabled": false, "displayName": "", "sipNumber": "", "domain": "", "domainPort": "", "authId": "", "proxyAddress": "", "proxyPort": "", "registrationEnabled": false, "registrarAddress": "", "registrarPort": "", "answerMode": "1" } ] } }
Metoda PUT
Parametry požadavku:
Parametr | Popis |
---|---|
blob-json | Povinný parametr obsahující konfiguraci SIP účtů (ve formátu JSON). |
Pro metodu PUT je povinný parametr blob-json, který může obsahovat všechny parametry z pole accounts ze souboru získaného metodou GET. Kromě povinného parametru account musí obsahovat minimálně ještě jeden další parametr. Ostatní parametry jsou volitelné. U každého účtu v uploadovaném JSON souboru je možné specifikovat parametr password a zadat heslo v otevřené podobě. Tento parametr není z bezpečnostních důvodů součástí odpovědi na metodu GET. Odpověď je ve formátu application/json. Pokud se při ověřování vyskytne chyba, celý proces skončí neúspěšně a žádný z parametrů nebude použit.
Příklad:
PUT /api/phone/config { "success": true, }
Parametry z databáze odpovídají parametrům v JSON souboru následovně:
Parametr z databáze | JSON parametr | Doplňkové informace |
---|---|---|
Phone.Sip | account | Číslování začíná od 1, ne od 0. |
Phone.Sip.Enabled | enabled | |
Phone.Sip.User.DisplayName | displayName | |
Phone.Sip.User.Id | sipNumber | |
Phone.Sip.User.AuthId | authId | Pokud zůstane parametr prázdný, bude parametr Phone.Sip.User.Id použit místo něj. |
Phone.Sip.User.PasswordString | password | V otevřené podobě – lze do zařízení nahrát pouze pomocí funkce PUT, ale nelze jej získat pomocí funkce GET. |
Phone.Sip.Client.Domain | domain | |
Phone.Sip.Client.Port | domainPort | |
Phone.Sip.Proxy.Address | proxyAddress | |
Phone.Sip.Proxy.Port | proxyPort | |
Phone.Sip.Registrar.Enabled | registrationEnabled | |
Phone.Sip.Registrar.Address | registrarAddress | |
Phone.Sip.Registrar.Port | registrarPort | |
Phone.Sip.Misc.AnswerMode | answerMode |