JSON API » phones » phones/list/panel

This is a lightweight version of phones/list that requires fewer database lookups and returns less data. phones/list should normally be used instead.

Input parameters

Requires authentication and the panel role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
customer	Integer	ID of customer to get telephone lines for.	No	Customer of authentication user.

Responses

Code	Description
200	Success.
400	Invalid customer specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.

Data returned

An array of fields, corresponding to the rows of the phones table in the database.

Example: With required parameters

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

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "name":"1234567", "description":"", ... }, { "name":"1234568", "description":"", ... } ] }

Change history

Version	Changes
3.13	Function added.