Phones

List IP phones

List IP phones

GEThttp://127.0.0.1:8888/api/phones

Response

2004XX

OK

Body

application/json

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/phones', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "extension_number": "text",
      "vendor": "text",
      "model": "text",
      "fwver": "text",
      "name": "text",
      "password": "text",
      "vm_pin": "text",
      "ip": "text",
      "mac": {}
    }
  ]
}

Retrieve Phone's detailed information.

Retrieve phone's detailed information.

GEThttp://127.0.0.1:8888/api/phones/{mac}

Path parameters

mac*string

MAC address.

Response

200404

OK

Body

application/json

extension_numberstring

The extension number.

Pattern: [0-9]{3,64}

vendorstring

The phone vendor of IP phone.

modelstring

The name of IP phone model.

fwverstring

The firmware version of IP phone.

namestring

The display name of user.

passwordstring

Password for accessing the Web interface of phone. The username remains default because most phone manufacturers do not allow modification of the user name. This is supported for some phone model, such as "Snom 300".

vm_pinstring

The voicemail PIN of the phone.

ipstring

IP address.

macall of

MAC address of this IP phone.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/phones/{mac}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "extension_number": "text",
  "vendor": "text",
  "model": "text",
  "fwver": "text",
  "name": "text",
  "password": "text",
  "vm_pin": "text",
  "ip": "text",
  "mac": {}
}