api:pbx:switch:list
Table of Contents
API : PBX : Switch list
Introduction
This request will return a list of all the switches a PBX has.
Request
| URL | https://api.telecomx.dk/pbx/switch | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN. | |
| Query | customer | [optional] Id of customer to show switches for. Defaults to the users own customer if not specified. |
Query examples
https://api.telecomx.dk/pbx/switch https://api.telecomx.dk/pbx/switch?customer=123458789012457890ABCD
Response
Array of JSON objects.
| Property | Type | Description |
|---|---|---|
| name | String | Name of switch. If type is SHARED then prefixed with SHARED:. If type is PERSONAL then prefixed with <employee-id>: |
| value | Boolean | Value of switch |
| type | String | Type of switch: SYSTEM, SHARED, PERSONAL |
| employee | Object | Employee data, if type is PERSONAL. |
| employee._id | Id | Id of employee. |
| employee.name | String | Name of employee. |
Example
[ { "name": "alarm", "value": false, "type": "SYSTEM" }, { "name": "12345674890123457890ABCD:room", "value": "203A", "type": "PERSONAL" }, { ... } ]
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/switch/list.txt · Last modified: 2025/11/08 04:11 by Per Møller