From Bright Pattern Documentation
Jump to: navigation, search
(12 intermediate revisions by 3 users not shown)
Line 32: Line 32:
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* https://documenter.getpostman.com/view/6711197/S1EUtanN| Configuration API  
+
* https://documenter.getpostman.com/view/6711197/S1EUtanN| Configuration API (on Postman)
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
Line 40: Line 40:
 
<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>Embedded Desktop API <i class="fa fa-sign-in" style="float:right; font-size: 13px;"></i></h4></div>
+
<div class="panel-heading"><h4>Embedded Desktop API <i class="fa fa-sign-in-alt" style="float:right; font-size: 13px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
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.
Line 60: Line 60:
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* https://documenter.getpostman.com/view/6711197/S1EUtb1f | Interaction Content API   
+
* https://documenter.getpostman.com/view/6711197/S1EUtb1f | Interaction Content API (on Postman)  
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
Line 73: Line 73:
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* 5.3:List-management-api-specification/Purpose | List Management API Specification
+
* https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest | List Management API (on Postman)
 
</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>Mobile APIs <i class="fa fa-mobile" style="float:right; font-size: 24px;"></i></h4></div>
+
<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-body">
 
<div class="panel-body">
Develop customer-facing mobile/web 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.3:Mobile-api-plugin-appery-io-tutorial/Purpose| Mobile API Plug-in for Appery.io Tutorial
* 5.3:Mobile-web-api-specification/Purpose| Mobile/Web API Specification
+
* 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 97: Line 97:
 
<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>SMS/MMS API <i class="fa fa-comments-o" style="float:right; font-size: 20px;"></i></h4></div>
+
<div class="panel-heading"><h4>SCIM-Compliant User Provisioning API <i class="fa fa-arrows-alt-h" style="float:right; font-size: 20px;"></i></h4></div>
 +
<div class="panel-body">
 +
Communicate user identity data between identity providers and service providers.
 +
<btn>
 +
Get APIs||btn-primary
 +
* https://documenter.getpostman.com/view/8336025/SVYwJbLw?version=latest| SCIM-Compliant User Provisioning API Specification (on Postman)
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 1-->
 +
 
 +
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<div class="panel panel-default">
 +
<div class="panel-heading"><h4>SMS/MMS API <i class="fa fa-comments" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
Send and receive SMS and MMS messages, as well as track delivery status with the SMS/MMS API.
 
Send and receive SMS and MMS messages, as well as track delivery status with the SMS/MMS API.
Line 106: Line 119:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 1-->
+
</div><!-- end of col 2-->
  
 
<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>Statistics API <i class="fa fa-bar-chart-o" style="float:right; font-size: 20px;"></i></h4></div>
+
<div class="panel-heading"><h4>Statistics API <i class="fa fa-chart-bar" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
 
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
* 5.3:Real-time-statistics-api/APIDescription| Real-Time Statistics API
+
* 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  
 
</btn><!-- end of button -->
 
</btn><!-- end of button -->
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 2-->
+
</div><!-- end of col 3-->
  
  

Revision as of 14:52, 4 May 2021

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

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.

Chat/Mobile App 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.