BPCC Configuration API

With the Bright Pattern Contact Center (BPCC) Configuraiton API you currently can:

Create, update and delete your contact center users.

Assign and change agent skills and update skill levels.

Unlock a user account that may have been locked according to the security policy.

Get a list of all existing users with their internal and external (DID) phone numbers.

Get a list of all existing extenal numbers with thier current assignments (DID, routing points, etc.)

This document specifies the corresponding REST API methods, with example requests and responses. You can load this API into the Postman API Development Environment to interact with the API with your own access tokens.

Notes

Either HTTP or HTTPS transport can be configured. The same setting applies to the entire Configuration Web Portal server. For production deployments on public Internet only, HTTPS is enabled.

Authentication

The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found here. Privileges are assigned to users via one or more Roles.

To obtain an access token:

Navigate to Users page.

Select or create a user with privileges corresponding to the tasks you wish to perform via the BPCC Configuraiton API.

Click the Generate button to generate an API secret key. Copy the generated key and note the username for the next steps.

Use the Get Access Token method to obtain an access token. Set the client_id to the username and client_secret to the generated API secrect key.

Use the value of access_token returned in the response to set the Authorization: Bearer [access token] header of each subsequent request made via the BPCC Configuraiton API.

POSTGet Access Token

https://:tenant-URL/configapi/v2/oauth/token

Returns an access token that will be used to authenticate each subsequent request made via this API.

HEADERS

Content-Type

application/x-www-form-urlencoded

PATH VARIABLES

tenant-URL

boromir.bugfocus.com

Your contact center domain name, e.g., example.brightpattern.com.

Bodyurlencoded

client_id

Username of a BP user authorized to manage users and/or phones.

client_secret

API secret key generated for the above user.

scope

Your contact center domain name, e.g., example.brightpattern.com.

grant_type

Grant type. Must be set to client_credentials.

Users

With the https://:tenant_url/configapi/v2/user endpoint you can:

Create new users and define most of their attributes

Update existing users

Check and clear user lockout state

Manage agents' skills

Delete existing users

Below is a brief description of all user attributes that can be accessed via this API. More detailed descriptions of these attributes can be found here.

All attributes are strings unless otherwise noted.

All attributes are optional unless otherwise noted.

Attribute	Description
loginId	Username. Required to create user. Used to identify the user in all subsequent User Management API operations.
password	Password. Format must comply with security policy.
changePassword	Indicates whether user must change password on next login. Boolean. Default is false.
firstName	First name. Required to create user.
lastName	Last name. Required to create user.
team	Team that the user is assigned to. Required to create user.
extension	User's extension number. If not specified, an extension will be created and assigned automatically.
workPhone	User's work phone number.
mobilePhone	User's mobile phone number.
email	User's email address.
disabled	Indication whether the user account is disabled or enabled. Boolean (true/flase).
skills	For agents an array of skills with levels (e.g., "Support": 75).
roles	An array of user's roles (e.g., Agent).