From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "<translate> = API Reference = FPO Desktop Integration API .NET Version Tutorial Learn how to use the Bright Patte...")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<translate>
 
<translate>
 
= API Reference =
 
= API Reference =
FPO
+
Bright Pattern uses Postman to host documentation for Bright Pattern Contact Center REST APIs.
  
[[5.3:desktop-integration-api-net-version-tutorial/Purpose|Desktop Integration API .NET Version Tutorial]]
+
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.
Learn how to use the Bright Pattern Contact Center Desktop Integration API to control agent states and handle calls from .NET-based applications.
 
  
[[5.3:desktop-javascript-api-specification/Purpose|Desktop JavaScript API Specification]]
+
Note that JavaScript API documentation is available only on help.brightpattern.com (see the links shown on this page).
This spec explains the Desktop JavaScript API that provides access to Agent Desktop functions.
 
  
[[5.3:list-management-api-specification/Purpose|List Management API Specification]]
 
This spec describes the methods and responses of the List Management API, which can be used to manage the contents of lists via third-party applications.
 
  
[[5.3:mobile-api-plugin-appery-io-tutorial/Purpose|Mobile API Plug-in for Appery.io Tutorial]]
 
Learn how to use the Mobile API plug-in to connect with the ServicePattern Mobile API.
 
  
[[5.3:mobile-web-api-specification/Purpose|Mobile/Web API Specification]]
+
<div class="flex-row row"><!--beginning of row 1 -->
This spec describes the methods, responses, and events of the Mobile API, which can be used to develop customer-facing mobile and web applications for advanced chat, voice, and video communications.
+
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<div class="panel panel-default">
 +
<div class="panel-heading"><h4>Agent Desktop APIs <i class="fa fa-desktop" style="float:right; font-size: 20px;"></i></h4></div>
 +
<div class="panel-body">
 +
Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.
 +
<btn>
 +
Get APIs||btn-primary
 +
* 5.3: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.3:Desktop-javascript-api-specification/Purpose|  Desktop JavaScript API Specification
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 1-->
  
[[5.3:real-time-statistics-api/APIDescription|Real-Time Statistics API]]
+
<div class="col-xs-12 col-md-6 col-lg-4">
This spec lists the methods and responses of the Real-Time Statistics API.
+
<div class="panel panel-default">
 +
<div class="panel-heading"><h4>Configuration API <i class="fa fa-user" style="float:right; font-size: 20px;"></i></h4></div>
 +
<div class="panel-body">
 +
Automate user provisioning with third-party systems using the Configuration API.
 +
<btn>
 +
Get APIs||btn-primary
 +
* https://documenter.getpostman.com/view/6711197/S1EUtanN| Configuration API (on Postman)
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 2-->
  
[[5.3:Recording-retrieval-api-specification/About | Recording Retrieval API Specification]]
+
<div class="col-xs-12 col-md-6 col-lg-4">
This spec lists the methods that are used to get recording files and recording metadata.
+
<div class="panel panel-default">
 +
<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">
 +
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
 +
<btn>
 +
Get APIs||btn-primary
 +
* 5.3:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 3-->
 +
</div><!-- End of row 1-->
  
[[5.3:simplified-desktop-net-api-specification/Purpose|Simplified Desktop .NET API Specification]]
+
<div class="flex-row row"><!--beginning of row 2 -->
This spec describes the methods and events of the Simplified Desktop .NET API, which provides access to Agent Desktop functions from .NET-based third-party applications.
+
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<div class="panel panel-default">
 +
<div class="panel-heading"><h4>Interaction Content  API <i class="fa fa-microphone" style="float:right; font-size: 20px;"></i></h4></div>
 +
<div class="panel-body">
 +
Download recording audio files along with their associated metadata with the Interaction Content API.
 +
<btn>
 +
Get APIs||btn-primary
 +
* https://documenter.getpostman.com/view/6711197/S1EUtb1f | Interaction Content API (on Postman) 
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 1-->
  
[[5.3:Sms-mms-api-specification/Introduction | SMS/MMS API Specification]]
+
<div class="col-xs-12 col-md-6 col-lg-4">
This spec describes the methods of the SMS/MMS API, which describes the methods that can be used to send and receive SMS/MMS messages, as well as track the delivery status of SMS/MMS messages.
+
<div class="panel panel-default">
 +
<div class="panel-heading"><h4>List Management API <i class="fa fa-list" style="float:right; font-size: 20px;"></i></h4></div>
 +
<div class="panel-body">
 +
Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.
 +
<btn>
 +
Get APIs||btn-primary
 +
* https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest | List Management API (on Postman)
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 2-->
 +
 
 +
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<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-body">
 +
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
 +
<btn>
 +
Get APIs||btn-primary
 +
* 5.3:Mobile-api-plugin-appery-io-tutorial/Purpose| Mobile API Plug-in for Appery.io Tutorial
 +
* https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest| Mobile/Web Messaging API v1 (on Postman)
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 3-->
 +
</div><!-- End of row 2-->
 +
 
 +
<div class="flex-row row"><!--beginning of row 3 -->
 +
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<div class="panel panel-default">
 +
<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">
 +
Send and receive SMS and MMS messages, as well as track delivery status with the SMS/MMS API.
 +
<btn>
 +
Get APIs||btn-primary
 +
* https://documenter.getpostman.com/view/6711197/S1ETRbny | SMS/MMS API Specification (on Postman)
 +
</btn><!-- end of button -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 2-->
 +
 
 +
<div class="col-xs-12 col-md-6 col-lg-4">
 +
<div class="panel panel-default">
 +
<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">
 +
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
 +
<btn>
 +
Get APIs||btn-primary
 +
* 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 -->
 +
</div>
 +
</div><!-- End of pan -->
 +
</div><!-- end of col 3-->
 +
 
 +
 
 +
</div><!-- end of row 3 -->
  
[[5.3:user-management-api-specification/Purpose|User Management API Specification]]
 
Learn about the methods and responses of the User Management API, which can be used for automated user provisioning with third-party systems.
 
  
  

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.