Phones

List IP phones

get

List IP phones

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/phones

HTTPcURLJavaScriptPython

GET /api/phones HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Retrieve Phone's detailed information.

get

Retrieve phone's detailed information.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

macstringRequired

MAC address.

Responses

200

OK

application/json

extension_numberstring · min: 3 · max: 64Optional

The extension number.

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

vendorstringOptional

The phone vendor of IP phone.

modelstringOptional

The name of IP phone model.

fwverstringOptional

The firmware version of IP phone.

namestring · max: 1024Optional

The display name of user.

passwordstringOptional

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_pinstringOptional

The voicemail PIN of the phone.

ipstringOptional

IP address.

macall ofOptional

MAC address of this IP phone.

stringOptional

MAC address.

404

Not Found

get

/phones/{mac}

HTTPcURLJavaScriptPython

GET /api/phones/{mac} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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