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 or 3 or 4). 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 or 3 or 4)
enabled	SIP account enabled
sipNumber	SIP account telephone number
registrationEnabled	SIP account registration enabled
registered	Account registration with SIP Registrar

Example:

{
  "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
      }
    ]
  }
}