JSON API » phones » phones/hardware/list

Lists hardware addresses of a telephone line.

Input parameters

Requires authentication and the phones role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
count	Integer	1 to return a count, 0 to return full data.	No	0
phone	Integer	Telephone line id.	Yes
pages	Integer	1 to return a reduced set of data for generating the pages select box, 0 to return full data.	No	0

Responses

Code	Description
200	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The telephone line does not exist, or you do not have permission to view it.

Data returned

Telephone line hardware addresses.

Example: With required parameters

http://enswitch.example.com/api/json/phones/hardware/list/?auth_username=user;auth_password=password;id=55

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ { "phone":55, "hardware_address": "...", "provision1": "", "provisioning": 0 }, { "phone":55, "hardware_address": "...", "provision1": "", "provisioning": 0 } } }

Change history

Version	Changes
4.3	Function added.