api:pbx:variable:get
Table of Contents
API : PBX : Variable Get
Introduction
This request will return the value of a switch.
The variable name can be prefixed with SHARED: if it is a shared variable, or <employee-id>: if it is a personal variable. If not prefix, it is considered global.
Request
| URL | https://api.telecomx.dk/pbx/variable/Variable_NAME | |
|---|---|---|
| Method | GET | |
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, ADMIN. | |
| Param | VARIABLE_NAME | Name of the variable, if shared then prefix with SHARED:, if personal then prefix with <employee-id>:. |
| Query | customer | [optional] Id of customer. Defaults to users own customer. |
Query example
https://api.telecomx.dk/pbx/variable/onduty https://api.telecomx.dk/pbx/variable/onduty?customer=1234567890123457890ABCD
Response
| Property | Type | Description |
|---|---|---|
| name | String | Name of variable. If SHARED this is prefixed with SHARED:. If PERSONAL this is prefixed with <employee-id>: |
| value | String | Value of variable |
| type | String | Type of variable: SYSTEM, SHARED, PERSONAL |
Example
{ "name": "onduty", "value": "203" }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 404 | name | Variable not found |
| 500 | internal_error | <Unspecified> |
api/pbx/variable/get.txt · Last modified: 2025/11/08 03:42 by Per Møller