From Bright Pattern Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.

• 5.2 • 5.3

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 click the Get APIs button for the desired API specification, and you will be redirected to Postman's website. From there, you have the option to run the API collection in the Postman application in your own environment. For more information, see getpostman.com.

Note that JavaScript API documentation is available only on help.brightpattern.com (see the links shown on this page).


Agent Desktop APIs

Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.

Embedded Desktop API

The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.

List Management API

Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.

Mobile APIs

Develop customer-facing mobile/web apps for advanced chat, voice, and video communications.

Recording API

Download recording audio files along with their associated metadata with the Recording Retrieval API.

SMS/MMS API

Send and receive SMS and MMS messages, as well as track delivery status with the SMS/MMS API.

Statistics API

Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.

Tenant Management API

Transfer tenant configuration between various environments, create tenants from templates, and more.

User Management API

Automate user provisioning with third-party systems using the User Management API.