JSON API » phones » phones/system/list
Gets the fields of all telephone lines on system.
Input parameters
Requires authentication and the phone_reports role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
registered | Integer | 1 to return only registered telephone lines, 0 to return only unregistered telephone lines, -1 to return all. | No | -1 |
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
https://www.015pbx.net/local/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", ... } ] }