Revision as of 03:46, 20 August 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 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.

@@ Line 1: / Line 1: @@
 = 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.
+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).
-<br /><div class="flex-row row"><!--beginning of row 1 -->
-<div class="col-xs-12 col-md-6 col-lg-4"> <!-- start of col 2-->
-==<i class="fa fa-user"></i> Configuration API==
+<div class="flex-row row"><!--beginning of row 1 -->
+<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.8:Desktop-integration-api-net-version-tutorial/Purpose| Desktop Integration API .NET Version Tutorial
+* 5.8:Simplified-desktop-net-api-specification/Purpose| Simplified Desktop .NET API Specification
+* 5.8:Desktop-javascript-api-specification/Purpose|  Desktop JavaScript API Specification
+* 5.8:AgentDesktop-client-side-javascript-api-specification/Purpose | Agent Desktop Client Side Javascript API Specification
+</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>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.
-* [https://documenter.getpostman.com/view/6711197/S1EUtanN| Configuration API (on Postman)]
+<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-->
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
-==<i class="fa fa-user"></i> Embedded Desktop API==
+<div class="col-xs-12 col-md-6 col-lg-4">
+<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.
-* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
+<btn>
-</div><!-- end of col 3-->
+Get APIs||btn-primary
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
+* 5.8:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API
-==<i class="fa fa-microphone"></i> Interaction Content API==
+</btn><!-- end of button -->
-Download recordings as audio files along with their associated metadata with the Interaction Content API.
+</div>
-* [https://documenter.getpostman.com/view/6711197/S1EUtb1f| Interaction Content API (on Postman)]
+</div><!-- End of pan -->
 </div><!-- end of col 3-->
 </div><!-- End of row 1-->
-<br /><div class="flex-row row"><!--beginning of row 2 -->
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
+<div class="flex-row row"><!--beginning of row 2 -->
-==<i class="fa fa-list"></i> List Management API==
+<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-->
+<div class="col-xs-12 col-md-6 col-lg-4">
+<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.
-* [https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest| List Management API (on Postman)]
+<btn>
-</div><!-- end of col 1-->
+Get APIs||btn-primary
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
+* https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest | List Management API (on Postman)
-==<i class="fa fa-mobile"></i> Mobile/Web Messaging APIs==
+</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>Mobile/Web Messaging 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.
-* [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]]
+<btn>
-* [https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest| Mobile/Web Messaging API v2 (on Postman)]
+Get APIs||btn-primary
-* [https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest| Mobile/Web Messaging API v1 (on Postman)]
+* 5.8:Mobile-SDK-Instruction-Manual/About | Mobile SDK Instruction Manual
-</div><!-- start of col 2-->
+* https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest | Mobile/Web Messaging API v2 (on Postman)
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
+* https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest | Mobile/Web Messaging API v1 (on Postman)
-==<i class="fa fa-arrows-alt-h"></i> SCIM-Compliant User Provisioning API==
+</btn><!-- end of button -->
-Communicate user identity data between identity providers and service providers.
+</div>
-* [https://documenter.getpostman.com/view/8336025/SVYwJbLw?version=latest| SCIM-Compliant User Provisioning API Specification (on Postman)]
+</div><!-- End of pan -->
 </div><!-- end of col 3-->
 </div><!-- End of row 2-->
-<br /><div class="flex-row row"><!--beginning of row 3 -->
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
+<div class="flex-row row"><!--beginning of row 3 -->
-==<i class="fa fa-comments"></i> SMS/MMS API==
+<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.
-* [https://documenter.getpostman.com/view/6711197/S1ETRbny| SMS/MMS API Specification (on Postman)]
+<btn>
-</div><!-- end of col 1-->
+Get APIs||btn-primary
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
+* https://documenter.getpostman.com/view/6711197/S1ETRbny | SMS/MMS API Specification (on Postman)
-==<i class="fa fa-chart-bar"></i> Statistics API==
+</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.
-* [https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest| Real-Time Statistics API (on Postman)]
+<btn>
-* [[Real-time-statistics-api/ListofStatistics| List of Statistics ]]
+Get APIs||btn-primary
-</div><!-- end of col 2-->
+* https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest| Real-Time Statistics API (on Postman)
-<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
+* 5.8:Real-time-statistics-api/ListofStatistics | List of Statistics
-==<i class="fa fa-check"></i> Task Routing API==
+</btn><!-- end of button -->
-Create and manage tasks with the Task Routing API.
+</div>
-* [https://documenter.getpostman.com/view/31590362/2sA3XTfLhk| Task Routing API (on Postman)]
+</div><!-- End of pan -->
 </div><!-- end of col 3-->
 </div><!-- end of row 3 -->

Navigation menu