Latest revision as of 03:38, 21 November 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.

Configuration API (on Postman)

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.

Interaction Content API (on Postman)

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.

SCIM-Compliant User Provisioning API Specification (on Postman)

SMS/MMS API

Send, receive, and monitor the delivery of messages via SMS, MMS, and certain integrated messenger platforms.

SMS/MMS API Specification (on Postman)

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.

Task Routing API (on Postman)

@@ Line 1: / Line 1: @@
-<translate>
 = API Reference =
+Bright Pattern uses Postman to host documentation for Bright Pattern Contact Center REST APIs.
-<div class="flex-row row"><!--beginning of row 1 -->
+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.
-<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-->
-<div class="col-xs-12 col-md-6 col-lg-4">
+Note that JavaScript API documentation is available only on help.brightpattern.com (see the links shown on this page).
-<div class="panel panel-default">
+<br /><div class="flex-row row"><!--beginning of row 1 -->
-<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="col-xs-12 col-md-6 col-lg-4"> <!-- start of col 2-->
-<div class="panel-body">
+==<i class="fa fa-user"></i> Configuration API==
+Automate user provisioning with third-party systems using the Configuration API.
+* [https://documenter.getpostman.com/view/6711197/S1EUtanN Configuration API (on Postman)]
+</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==
 The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
-<btn>
+* [[latest:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop JS API - (+demo)]]
-Get APIs||btn-primary
+* [[latest:AgentDesktop-client-side-javascript-api-specification/APIMethods | New Widget Client-Side JS API]] - [https://help.brightpattern.com/crm-client-example/ (+demo)]
-* 5.3:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API
+* [[latest:Desktop-javascript-api-specification/Purpose | Simple JS API for screen-popped pages]]
-</btn><!-- end of button -->
+* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
-</div>
-</div><!-- End of pan -->
+</div><!-- end of col 3-->
-</div><!-- end of col 2-->
+<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">
+==<i class="fa fa-microphone"></i> Interaction Content API==
-<div class="panel panel-default">
+Download recordings as audio files along with their associated metadata with the Interaction Content API.
-<div class="panel-heading"><h4>List Management API <i class="fa fa-list" style="float:right; font-size: 20px;"></i></h4></div>
+* [https://documenter.getpostman.com/view/6711197/S1EUtb1f Interaction Content API (on Postman)]
-<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
-* List-management-api-specification/Purpose | List Management API Specification
-</btn><!-- end of button -->
-</div>
-</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="flex-row row"><!--beginning of row 2 -->
+<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
-<div class="col-xs-12 col-md-6 col-lg-4">
+==<i class="fa fa-list"></i> List Management API==
-<div class="panel panel-default">
+Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.
-<div class="panel-heading"><h4>Mobile  APIs <i class="fa fa-mobile" style="float:right; font-size: 24px;"></i></h4></div>
+* [https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest List Management API v2.0 (on Postman)]
-<div class="panel-body">
+* [https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z?version=latest List Management API v3.0 (on Postman)]
-Develop customer-facing mobile/web 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
-* 5.3:Mobile-web-api-specification/Purpose| Mobile/Web 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"><!-- start of col 2-->
-<div class="col-xs-12 col-md-6 col-lg-4">
+==<i class="fa fa-mobile"></i> Mobile/Web Messaging APIs==
-<div class="panel panel-default">
+Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
-<div class="panel-heading"><h4>Recording  API <i class="fa fa-microphone" style="float:right; font-size: 20px;"></i></h4></div>
+* [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]]
-<div class="panel-body">
+* [https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest Mobile/Web Messaging API v2 (on Postman)]
-Download recording audio files along with their associated metadata with the Recording Retrieval API.
+* [https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest Mobile/Web Messaging API v1 (on Postman)]
-<btn>
+</div><!-- start of col 2-->
-Get APIs||btn-primary
+<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
-* 5.3:Recording-retrieval-api-specification/About| Recording Retrieval API Specification
+==<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 2-->
-<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-o" 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
-* 5.3:Sms-mms-api-specification/Introduction| SMS/MMS API Specification
-</btn><!-- end of button -->
-</div>
-</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="flex-row row"><!--beginning of row 3 -->
+<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
-<div class="col-xs-12 col-md-6 col-lg-4">
+==<i class="fa fa-comments"></i> SMS/MMS API==
-<div class="panel panel-default">
+Send, receive, and monitor the delivery of messages via SMS, MMS, and certain [[latest:Messenger-integrations/overview-messenger-integrations| integrated messenger platforms]].
-<div class="panel-heading"><h4>Statistics  API <i class="fa fa-bar-chart-o" style="float:right; font-size: 20px;"></i></h4></div>
+* [https://documenter.getpostman.com/view/6711197/S1ETRbny SMS/MMS API Specification (on Postman)]
-<div class="panel-body">
+</div><!-- end of col 1-->
+<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
+==<i class="fa fa-chart-bar"></i> Statistics API==
 Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
-<btn>
+* [https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest Real-Time Statistics API (on Postman)]
-Get APIs||btn-primary
+* [[Real-time-statistics-api/ListofStatistics|List of Statistics ]]
-* 5.3:Real-time-statistics-api/APIDescription| Real-Time Statistics API
-</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>Tenant Management API</h4></div>
-<div class="panel-body">
-Transfer tenant configuration between various environments, create tenants from templates, and more.
-<btn>
-Get APIs||btn-primary
-* 5.3:Tenant-management-api-specification/Purpose| Tenant Management API Specification
-</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 1-->
-<div class="col-xs-12 col-md-6 col-lg-4">
+==<i class="fa fa-check"></i> Task Routing API==
-<div class="panel panel-default">
+Create and manage tasks with the Task Routing API.
-<div class="panel-heading"><h4>User Management API <i class="fa fa-user" style="float:right; font-size: 20px;"></i></h4></div>
+* [https://documenter.getpostman.com/view/31590362/2sA3XTfLhk Task Routing API (on Postman)]
-<div class="panel-body">
-Automate user provisioning with third-party systems using the User Management API.
-<btn>
-Get APIs||btn-primary
-* 5.3:User-management-api-specification/Purpose| User Management API Specification
-</btn><!-- end of button -->
-</div>
-</div><!-- End of pan -->
 </div><!-- end of col 3-->
 </div><!-- end of row 3 -->
-</translate>

Navigation menu