JSON API » phones » phones/system/list

Gets the fields of all telephone lines on system.

Input parameters

Requires authentication and the telephone line reports role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
registeredInteger1 to return only registered telephone lines, 0 to return only unregistered telephone lines, -1 to return all.No-1

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/system/list/?auth_username=user;auth_password=password

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

Change history

VersionChanges
3.13Function added.