API : PBX : APP: Permissions

Introduction

This request returns a complete list of all the extensions the user has the right to perform one or more actions on.

Request

URL	https://api.telecomx.dk/pbx/app/permissions
Method	GET
Access level	PERSONAL, VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN.

Query examples

https://api.telecomx.dk/pbx/app/permissions

Response

An object with keys being the extension id and properties are the permissions.

JSON object
<extension-id>.pickup	Boolean	True if user may pickup calls from the target extension.
<extension-id>.steal	Boolean	True if user may steal ongoing calls from the target extension.
<extension-id>.spy	Boolean	True if user may listen in on calls on the target extension.
<extension-id>.setPresence.	Boolean	True if user may set the presence for the target extensions employee.
<extension-id>.queueMember.	Boolean	True if user may add and remove the extension to/from a queue.
<extension-id>.viewOtherParty	Boolean	True if user may see who the extension is talking to.
<extension-id>.viewOtherPartyOverride	String	If extension have restrictions on users ability to see who the extension is talking to: NONE - no override HIDE - Always hidden HIDE_PERSONAL_PHONEBOOK - hide if number is in personal phonebook HIDE_OFF_WORK - hide when presence is OFF_WORK or HOLIDAY HIDE_PERSONAL_PHONEBOOK_AND_OFF_WORK - hide if number is in personal phonebook or presence is OFF_WORK or HOLIDAY
<extension-id>.readCalendar	Boolean	True if user has read access to the extensions employees calendar.
<extension-id>.writeCalendar	Boolean	True if user has write access to the extensions employees calendar.
<extension-id>.readPhonebook	Boolean	True if user has read access to the extensions employees phonebook.
<extension-id>.writePhonebook	Boolean	True if user has write access to the extensions employees phonebook.
<extension-id>.controlSipDevices	Boolean	True if user may control the extensions sip devices (make calls, hangup etc).

Example - normal

{
  "5c5a9dea83a3bc74d5891c95": {
    "pickup": true,
    "steal": true,
    "spy": true,
    "setPresence": true,
    "queueMember": true,
    "viewOtherParty": true,
    "viewOtherPartyOverride": "NONE",
    "readCalendar": false,
    "writeCalendar": false,
    "readPhonebook": false,
    "writePhonebook": false,
    "controlSipDevices": false
  },
  "5beaa1574a7caf17c958ed3a": {
    "pickup": true,
    "steal": false,
    "spy": false,
    "setPresence": false,
    "queueMember": true,
    "viewOtherParty": true,
    "viewOtherPartyOverride": "HIDE",
    "readCalendar": true,
    "writeCalendar": false,
    "readPhonebook": true,
    "writePhonebook": false,
    "controlSipDevices": false
  },
  {
    ...
  }
}

Errors

Error code	Message	Description
404	extension	You have no extensions
500	internal_error	<Unspecified>

WIKI

Table of Contents

API : PBX : APP: Permissions

Introduction

Request

Query examples

Response

Example - normal

Errors