From Bright Pattern Documentation
Jump to: navigation, search
(→‎API Reference: clarifies that SMS/MMS API also supports some messenger integrations)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<translate>
+
 
 
= API Reference =
 
= API Reference =
 
Bright Pattern uses Postman to host documentation for Bright Pattern Contact Center REST APIs.  
 
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.
+
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).
 
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.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">
 
−
<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.
 
Automate user provisioning with third-party systems using the Configuration API.
−
<btn>
+
* [https://documenter.getpostman.com/view/6711197/S1EUtanN Configuration API (on Postman)]
−
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><!-- 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.
 +
* [[latest:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop JS API - (+demo)]]
 +
* [[latest:AgentDesktop-client-side-javascript-api-specification/APIMethods | New Widget Client-Side JS API]] - [https://help.brightpattern.com/crm-client-example/ (+demo)]
 +
* [[latest:Desktop-javascript-api-specification/Purpose | Simple JS API for screen-popped pages]]
 +
* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
  
−
<div class="col-xs-12 col-md-6 col-lg-4">
+
</div><!-- end of col 3-->
−
<div class="panel panel-default">
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
−
<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">
+
==<i class="fa fa-microphone"></i> Interaction Content API==
−
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
+
Download recordings as audio files along with their associated metadata with the Interaction Content API.
−
<btn>
+
* [https://documenter.getpostman.com/view/6711197/S1EUtb1f Interaction Content API (on Postman)] 
−
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 col 3-->
 
</div><!-- End of row 1-->
 
</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>Interaction Content  API <i class="fa fa-microphone" style="float:right; font-size: 20px;"></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)]
−
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><!-- 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">
 
−
<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.
 
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
−
<btn>
+
* [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]]
−
Get APIs||btn-primary
+
* [https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest Mobile/Web Messaging API v2 (on Postman)]
−
* [[5.3: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/6735877/T1LHGpBY?version=latest| Mobile/Web Messaging API v1 (on Postman)
+
</div><!-- start of col 2-->
−
</btn><!-- end of button -->
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
−
</div>
+
==<i class="fa fa-arrows-alt-h"></i> SCIM-Compliant User Provisioning API==
−
</div><!-- End of pan -->
+
Communicate user identity data between identity providers and service providers.
 +
* [https://documenter.getpostman.com/view/8336025/SVYwJbLw?version=latest SCIM-Compliant User Provisioning API Specification (on Postman)]
 
</div><!-- end of col 3-->
 
</div><!-- end of col 3-->
 
</div><!-- End of row 2-->
 
</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>SCIM-Compliant User Provisioning API <i class="fa fa-arrows-alt-h" 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">
 
−
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><!-- 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-chart-bar"></i> Statistics API==
−
<div class="panel panel-default">
+
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
−
<div class="panel-heading"><h4>SMS/MMS API <i class="fa fa-comments" style="float:right; font-size: 20px;"></i></h4></div>
+
* [https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest Real-Time Statistics API (on Postman)]
−
<div class="panel-body">
+
* [[Real-time-statistics-api/ListofStatistics|List of Statistics ]]
−
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><!-- 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>Statistics API <i class="fa fa-chart-bar" 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">
 
−
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 col 3-->
−
 
−
 
 
</div><!-- end of row 3 -->
 
</div><!-- end of row 3 -->
−
 
−
 
−
 
−
 
−
 
−
 
−
</translate>
 

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.

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.


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, receive, and monitor the delivery of messages via SMS, MMS, and certain integrated messenger platforms.

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.

Retrieved from "https://help.brightpattern.com/index.php?title=5.19:Api&oldid=161267"