User Tools

Site Tools


api:pbx:switch:get

API : PBX : Switch Get

Introduction

This request will return the value of a switch.

Request

URL https://api.telecomx.dk/pbx/switch/SWITCH_NAME
Method GET
Access level PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.
Param SWITCH_NAME Name of the switch. If shared prefix with SHARED:, if personal prefix with <employee-id>:
Query customer [optional] Id of customer. Defaults to users own customer.

Query example

https://api.telecomx.dk/pbx/switch/alarm
https://api.telecomx.dk/pbx/switch/alarm?customer=1234567890123457890ABCD

Response

Json object
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

Example

{
  "name": "alarm",
  "value": false,
  "type": "SYSTEM"
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 name Switch not found
500 internal_error <Unspecified>
api/pbx/switch/get.txt · Last modified: 2025/11/08 04:15 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki