From Bright Pattern Documentation
Jump to: navigation, search
(Updated via BpClonePage extension. Source page: draft:Api)
(→‎Embedded Desktop API: adds link to "Agent Desktop Client-Side JavaScript API")
Line 15: Line 15:
 
==<i class="fa fa-user"></i> Embedded Desktop API==
 
==<i class="fa fa-user"></i> Embedded Desktop API==
 
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
 
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
 +
* [[AgentDesktop-client-side-javascript-api-specification/Purpose| Agent Desktop Client-Side JavaScript API]]
 
* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
 
* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
 
</div><!-- end of col 3-->
 
</div><!-- end of col 3-->
 
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
 
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
 +
 
==<i class="fa fa-microphone"></i> Interaction Content API==
 
==<i class="fa fa-microphone"></i> Interaction Content API==
 
Download recordings as audio files along with their associated metadata with the Interaction Content API.
 
Download recordings as audio files along with their associated metadata with the Interaction Content API.

Revision as of 07:17, 22 October 2024

• 5.19 • 5.2 • 5.3 • 5.8


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 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.

Task Routing API

Create and manage tasks with the Task Routing API.