PHONE

Retrive IP phones

GET /phones/list

Retrieves a list of IP phones .

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/phones/list?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders

counts
integer
required
Counts of IP phones.
phones
array
required
Collection of IP phone objects.
Show child attributes
- ext
  string
  required
  Extension Number of IP phone.
- vendor
  string
  required
  Vendor of IP phone.
- model
  string
  required
  Model of IP phone.
- fw_version
  string
  required
  Fw version of IP phone.
- name
  string
  required
  Name of IP phone.
- password
  string
  required
  Password of Extension Number.
- phone_password
  string
  required
  Password of IP phone.
- vmpin
  string
  required
  Voice mail pin of IP phone.
- ip
  string
  required
  IP of IP phone.
- mac
  string
  required
  MAC of IP phone.

Sample Response

{
    "counts": 1,
    "phones": [
        {
            "ext": 100,
            "vendor": "snom",
            "model": "snom760",
            "fw_version": "",
            "name": "",
            "password": 100,
            "phone_password": 123456,
            "vmpin": 999,
            "ip": "192.168.1.101",
            "mac": 12345632125
        }
    ]
}

Check IP phone's MAC

GET /phones/mac_addr/check

Check IP phone's MAC.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
mac_address
string
required
MAC of IP phone.

Sample Request

https://example.com/api/phones/mac_addr/check?access_token=196ACE20C6F34027895F7F95402BB164&mac=12345632125

Response

Placeholders

isexist
boolean
required

Sample Response

{
    "isexist": false
}

Show Phone's provision

GET /phones/provsion/show

Check IP phone's MAC.

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
extension_number
string
required

Sample Request

https://example.com/api/phones/provsion/show?access_token=196ACE20C6F34027895F7F95402BB164&extension_number=100

Response

Placeholders

count
integer
required
phoneinfos
array
required
Show child attributes
- phone_id
  string
  required
  ID for phone.
- xmlfile
  string
  required
  XML file name for phone.
- languages
  string
  required
  Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.
- ua
  string
  required
- network
  string
  required
  Network interface
- cfgurl
  string
  required
  Url for phone's cfg;
- extension_number
  string
  required
  Extension Number for phone.
- vendor
  string
  required
  The specific phone model.
- mac_address
  string
  required
  Mac address for phone.
- deskphone_password
  string
  optional
  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".
- time_zone_value
  string
  required
  Time Zone for this phone device.
- codec1
  string
  required
  Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
- codec2
  string
  required
  The second preferred codec.
- codec3
  string
  required
  The third preferred codec.
- codec4
  string
  required
  The fourth preferred codec.
blfs
array
required
Show child attributes
- key
  string
  required
- value
  string
  required
- blffirstname
  string
  required
- blflastname
  string
  required

Sample Response

{
    "count": 1,
    "phoneinfos": [
        {
            "phone_id": "1111",
            "vendor": "snom",
            "mac_address": "123456789",
            "fw_version": "",
            "xmlfile": "snom.ph.xml",
            "extension_number": "100",
            "deskphone_password": "123456",
            "time_zone_value": 8,
            "languages": "chinese",
            "ua": "snom760",
            "network": "local",
            "cfgurl": "http://127.0.0.1:8888/123456789.cfg"
        }
    ]
}

Setting Phone's provision

POST /phones/provsion

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
extension_number
string
required
extension_first_name
string
required
extension_last_name
string
required
phoneinfos
array
required
Show child attributes
- phone_id
  string
  required
  ID for phone.
- xmlfile
  string
  required
  XML file name for phone.
- languages
  string
  required
  Language for strings displayed on Phone Display LCD. Supported languages include ENGLISH, CHINESE, DUTCH, FRENCH, GERMAN, GREEK, ITALIAN, JAPANESE, POLISH, RUSSIAN, SPANISH, SWEDISH, UKRAINIAN, and BULGARIAN.
- ua
  string
  required
- network
  string
  required
  Network interface
- cfgurl
  string
  required
  Url for phone's cfg;
- extension_number
  string
  required
  Extension Number for phone.
- vendor
  string
  required
  The specific phone model.
- mac_address
  string
  required
  Mac address for phone.
- deskphone_password
  string
  optional
  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".
- time_zone_value
  string
  required
  Time Zone for this phone device.
- codec1
  string
  required
  Settings for the priority of the codecs in this phone. This indicates the first preferred codec.
- codec2
  string
  required
  The second preferred codec.
- codec3
  string
  required
  The third preferred codec.
- codec4
  string
  required
  The fourth preferred codec.
blfs
array
optional
Show child attributes
- key
  string
  required
- value
  string
  required
- blffirstname
  string
  required
- blflastname
  string
  required

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "extension_number": 100
}

Response

Placeholders

Sample Response

Phone's reprovision

POST /phones/reprovsion

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
mac_address
string
required

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "mac_address": 100
}

Response

Placeholders

Sample Response

Reboot Phone

POST /phones/reboot

Request

Placeholders

access_token
string
required
Access token is a 32-byte string with validity of 30 seconds.
mac_address
string
required

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "mac_address": 100
}

Response

Placeholders

Sample Request

counts

phones

ext

vendor

model

fw_version

name

password

phone_password

vmpin

ip

mac

Sample Response

Sample Request

isexist

Sample Response

Sample Request

count

phoneinfos

phone_id

xmlfile

languages

ua

network

cfgurl

extension_number

vendor

mac_address

deskphone_password

time_zone_value

codec1

codec2

codec3

codec4

blfs

key

value

blffirstname

blflastname

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

Sample Request

Sample Response

`counts`

`phones`

`ext`

`vendor`

`model`

`fw_version`

`name`

`password`

`phone_password`

`vmpin`

`ip`

`mac`

`isexist`

`count`

`phoneinfos`

`phone_id`

`xmlfile`

`languages`

`ua`

`network`

`cfgurl`

`extension_number`

`vendor`

`mac_address`

`deskphone_password`

`time_zone_value`

`codec1`

`codec2`

`codec3`

`codec4`

`blfs`

`key`

`value`

`blffirstname`

`blflastname`