5.6.1 api phone status
The /api/phone/status functions helps you get the current statuses of the device SIP accounts.
The function is part of the Phone/Call service and the user must be assigned the Phone/Call Monitoring privilege for authentication if required.
The GET or POST method can be used for this function.
Request parameters:
Parameter | Description |
---|---|
account | Optional SIP account identifier (1 or 2). If the parameter is not included, the function returns statuses of all the SIP accounts. |
The reply is in the application/json format and includes a list of device SIP accounts (accounts) including current statuses. If the account parameter is used, the accounts field includes just one item.
Parameter | Description |
---|---|
account | Unique SIP account identifier (1 or 2) |
enabled | SIP account enabled |
sipNumber | SIP account telephone number |
registrationEnabled | SIP account registration enabled |
registered | Account registration with SIP Registrar |
Example:
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 } ] } }