API Reference
Bright Pattern uses Postman to host documentation for Bright Pattern Contact Center REST APIs.
Postman is a popular REST API client for testing and documenting APIs with examples in multiple programming languages. To view documentation hosted on Postman, simply follow the link under the desired API specification. From there, you have the option to run the API collection in the Postman application in your own environment.
Note that JavaScript API documentation is available only on help.brightpattern.com (see the links shown on this page).
Configuration API
Automate user provisioning with third-party systems using the Configuration API.
Embedded Desktop API
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
Interaction Content API
Download recordings as audio files along with their associated metadata with the Interaction Content API.
List Management API
Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.
Mobile/Web Messaging APIs
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
SCIM-Compliant User Provisioning API
Communicate user identity data between identity providers and service providers.
SMS/MMS API
Send, receive, and monitor the delivery of messages via SMS, MMS, and certain integrated messenger platforms.
Statistics API
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.