User Tools

Site Tools


api:employee

API : Employee

List All employees.
Get Get an employee.
Create Create an employee.
Update Update an existing employee.
Delete Delete an employee.
Cancel deletion Cancels a planned deletion for an employee
Get shortcuts Get an employees shortcuts.
Set shortcuts Set en employees shortcuts.
Reset password Reset an employees password.
Clear tokens Remove employees tokens.
Upload picture Upload employee picture.
Download picture Get employee picture.
Delete picture Delete employee picture.
Create token Create a persistent token for M2M communication.
Delete token Delete a persistent token for M2M communication.
Create authenticator key Create a new authenticator key for 2FA.
Reset authenticator key Reset authenticator key for 2FA.
Get employee product Gets the PBX user product on the given employee, and stats of how many of their included products that have used.

Access levels

An employee object can be as little as a contact details card, a limited see-your-own settings user or a can-do-everything user. The access levels are:

Level Description
NO_LOGIN For employees who only have hosted PBX phone(s), but cannot login.
PERSONAL Access to own basic settings: voicemail, call forwarding, call detail records.
VIEWER View the configuration of the customer, but not change anything.
MANAGER View and configure the customer, but not perform actions that incur additional cost (e.g. purchase a subscription).
OWNER View, configure and purchase - full access to the customer.
RESELLER Only available if customer is a reseller. Gives full access to all the customers that belongs to the reseller, or sub resellers.
RESELLER_ADMIN Telecom X administrative employee who can manage resellers (only functional at Telecom X office).
ADMIN Telecom X administrative employee (only functional at Telecom X office).
api/employee.txt · Last modified: 2025/02/10 10:46 by Per Møller

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki