Customer Users #
The Customer Users resource allows for the management of users at a customer level. The base URI for all request is:
/{VERSION}/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}
Customer Users Schema #
Users represent an end user of the system.
| Key | Description | Type | Default | Required | |
|---|---|---|---|---|---|
| id | The unique User identifier | string | (auto generated) | Yes (not create) | |
| displayName | A full User display name | string[100][100] | Yes | ||
| The email address of the User | string[200][200] | Yes | |||
| roles | Collection of roles | roles | |||
| primaryTenant | The id of the Users primary tenant | string | |||
| isParent | Used to indicate whether the user is configured at a higher level e.g. Reseller-Level | bool |
Roles #
User Access Type #
These roles control what PBX feature licences are assigned to a User, changing these may incur charges.
| Key | Name | Description | Pre-requisite | Licenced | Read Only |
|---|---|---|---|---|---|
| customer.user.pbx1,2 | Essential User | This enables call modelling/logging for the User. | ✔ | ||
| customer.user.uc.remote | Professional User | Controls access to the Softphone and ~.UcClient.~ Mobile features. | customer.user.uc | ✔ | |
| customer.user.pbx.realtime3 | Real-Time Add-On | Required for real-time call modelling for the user. | customer.user.pbx | ✔ | |
| customer.user.acd | Agent User Add-On | Controls modelling of ACD events and access to ACD features of ~.UcClient.~. | customer.user.pbx | ✔ | |
| customer.user.microsoftteams | Microsoft Teams User | Shows whether the user's Microsoft Teams calls are being monitored. | ✔ | ✔ |
info
Optionally, the customer.user.acd role can be automatically assigned to a user if they are detected as being a Call Centre Pro user on a ~.pbx.kazoo.name.~ system. This feature is controlled by a Customer level setting which can be configured through the reseller portal.
Supervisor Access Roles #
These control which access licences are assigned to a User, changing these may incur charges.
warning
These are mutually exclusive, with the higher roles allow access to all of the features of the lower roles. Ensure that only a single access licence role is assigned to a User at one time.
| Key | Friendly Name | Description | Pre-requisite | Licenced |
|---|---|---|---|---|
| customer.user.supervisorl1 | Reports Supervisor | Provides the user with access to Workspaces & Historical Reports | customer.user | |
| customer.user.supervisorl2 | Analytics Supervisor | Provides the user access to the Dashboard and Historical Reports | customer.user | ✔ |
| customer.user.supervisorl3 | Live Analytics Supervisor | Provides the user access to the Reports/Dashboard/Wallboard including active call stats. | customer.user | ✔ |
| customer.user.supervisorl4 | Contact Centre Supervisor | Provides the user access to the Reports/Dashboard/Wallboard including active call stats and queue/agent live grids. | customer.user | ✔ |
| customer.user.supervisorl5 | Insights Supervisor | Provides the user access to the Insights Reports/Dashboard/Wallboard. | customer.user | ✔ |
Permission Roles #
These control the user's permissions and the areas which they can access.
| Key | Friendly Name | Description | Pre-requisite | Licenced |
|---|---|---|---|---|
| customer.user | Website Access | Grants the user access to the ~.Dimensions.~~ web portal. | ||
| user.admin | Manage Users | Allows the user to create and manage users. | customer.user | |
| customer.billables.admin | Manage Billable Items | Allows the user to make changes that will affect billing | customer.user | |
| customer.device.readonly | Device Access | Allows the user read-only access to their customer account's devices | customer.user | |
| customer.device.admin | Device Admin | Allows the user to modify devices for their customer account | customer.user | |
| customer.settings | Customer Settings | Allows the user to edit organisation-wide settings | customer.user | |
| customer.directories.contributor | Manage Contact Directories | Allows the user to manage contact directories | customer.user | |
| customer.workspace.admin | Workspace Administrator | Gives the user access to manage workspaces | customer.user, customer.settings | |
| customer.voice.apps | Phone System Apps | Allows the user to access communications Voice Apps for configuration. | customer.user | |
| customer.voice.admin | Phone System Admin | Gives the user admin permissions on the communications Voice Apps. | customer.user | |
| onboarding.admin | REST API Administrator | Allows the user to configure the REST API service | customer.user | |
| webhooks.admin | Webhooks Admin | Allows the user to configure webhook triggers | customer.user | |
| pbx.agentcontrol | Supervisor Agent Control | Allows the user to change another user's agent status via the Dashboard | customer.user | |
| pbx.silentmonitor | Silent Monitor | Allows the user to silent monitor (whisper, barge-in, steal) other users calls | customer.user | |
| recording.observer | Recording Playback | Gives the user access to playback recordings from the Call Segmentation view | customer.user |
warning
When granting the user.admin role, they will also require the customer.user role to be able to login to the Customer portal. There must always be a single User that has both the user.admin and customer.user role otherwise you may receive the error "There must be at least one user administrator."
Client Roles #
These control the user's client access and softphones.
| Key | Friendly Name | Description | Pre-requisite | Licenced |
|---|---|---|---|---|
| customer.user.uc | ~.UcClient.~ UC | Allows the user access to use the ~.UcClient.~ Desktop application in CTI Mode. | customer.user | |
| customer.user.crm | ~.UcClient.~ CRM | This enables the CRM client role for the User. Once enabled, users can login to the available CRM integrations (e.g. Salesforce, Dynamics). | customer.user | ✔ |
| customer.user.uc.softphone | ~.UcClient.~ Softphones | Controls access to the Softphone features of ~.UcClient.~. | customer.user.uc | ✔ |
Available Interfaces #
| Interface | Description |
|---|---|
| Get All | Returns a collection of all customer users. |
| Get User | Returns a specific customer user instance. |
| Create User | Creates a new customer user instance. |
| Patch User | Updates an existing customer user instance. |
| Update User Device | Assign or remove devices as a Softphone. |
| Delete User | Removes an existing customer user instance. |
| Send New User Email | Sends the customer's user the Welcome email link so they can authenticate with the system. |
| Send UC Welcome Email | Sends the customer user the unified communications welcome email link so they can download uc clients. |
-
In the UK, the customer.user.uc.essential role should be used. ↩︎
-
This role will be automatically assigned to any user that exists on the communications platform ↩︎
-
This role will be automatically assigned to any user with the customer.user.pbx role when the first customer.user.supervisorl3 role or above is assigned to a user. ↩︎