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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
customerIntegerID of customer to get telephone lines for.NoCustomer of authentication user.

Responses

CodeDescription
200Success.
400Invalid customer specified.
401The authentication details provided are invalid.
402Your 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

VersionChanges
3.13Function added.