From Bright Pattern Documentation
Jump to: navigation, search
 
(4 intermediate revisions by the same user not shown)
Line 17: Line 17:
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* 5.3:Desktop-integration-api-net-version-tutorial/Purpose| Desktop Integration API .NET Version Tutorial
+
* 5.8:Desktop-integration-api-net-version-tutorial/Purpose| Desktop Integration API .NET Version Tutorial
* 5.3:Simplified-desktop-net-api-specification/Purpose| Simplified Desktop .NET API Specification
+
* 5.8:Simplified-desktop-net-api-specification/Purpose| Simplified Desktop .NET API Specification
* 5.3:Desktop-javascript-api-specification/Purpose|  Desktop JavaScript API Specification
+
* 5.8:Desktop-javascript-api-specification/Purpose|  Desktop JavaScript API Specification
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
Line 45: Line 45:
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* 5.3:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API
+
* 5.8:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
Line 81: Line 81:
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<div class="panel panel-default">
<div class="panel-heading"><h4>Chat/Mobile App APIs <i class="fa fa-mobile" style="float:right; font-size: 24px;"></i></h4></div>
+
<div class="panel-heading"><h4>Mobile/Web Messaging APIs <i class="fa fa-mobile" style="float:right; font-size: 24px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
 
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* 5.3:Mobile-api-plugin-appery-io-tutorial/Purpose| Mobile API Plug-in for Appery.io Tutorial
+
* 5.8:Mobile-SDK-Instruction-Manual/About | Mobile SDK Instruction Manual
* https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest| Mobile/Web Messaging API v1 (on Postman)
+
* https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest | Mobile/Web Messaging API v2 (on Postman)
 +
* https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest | Mobile/Web Messaging API v1 (on Postman)
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
Line 129: Line 130:
 
Get APIs||btn-primary
 
Get APIs||btn-primary
 
* https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest| Real-Time Statistics API (on Postman)
 
* https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest| Real-Time Statistics API (on Postman)
* 5.3:Real-time-statistics-api/ListofStatistics | List of Statistics  
+
* 5.8:Real-time-statistics-api/ListofStatistics | List of Statistics  
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>

Latest revision as of 23:14, 21 September 2021

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

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.

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