From Bright Pattern Documentation
Jump to: navigation, search
(→‎API Reference: clarifies that SMS/MMS API also supports some messenger integrations)
 
(41 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
<translate>
+
 
 
= API Reference =
 
= API Reference =
−
[[5.3:Api/GeneralInformation |  General Information]]
+
Bright Pattern uses Postman to host documentation for Bright Pattern Contact Center REST APIs.  
  
−
<div class="flex-row row">
+
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">
+
Note that JavaScript API documentation is available only on help.brightpattern.com (see the links shown on this page).
−
<div class="panel-heading"><h4>Agent Desktop APIs <i class="fa fa-wrench" style="float:right; font-size: 20px;"></i></h4></div>
+
<br /><div class="flex-row row"><!--beginning of row 1 -->
−
<div class="panel-body">
+
<div class="col-xs-12 col-md-6 col-lg-4"> <!-- start of col 2-->
−
Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.
+
==<i class="fa fa-user"></i> Configuration API==
−
<btn>
+
Automate user provisioning with third-party systems using the Configuration API.
−
Get APIs||btn-primary
+
* [https://documenter.getpostman.com/view/6711197/S1EUtanN Configuration API (on Postman)]
−
* 5.3:Desktop-integration-api-net-version-tutorial/Purpose| Desktop Integration API .NET Version Tutorial
+
</div><!-- end of col 2-->
−
* 5.3:Simplified-desktop-net-api-specification/Purpose| Simplified Desktop .NET API Specification
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
−
* 5.3:Desktop-javascript-api-specification/Purpose| Desktop JavaScript API Specification
+
==<i class="fa fa-user"></i> Embedded Desktop API==
−
</btn><!-- end of button -->
+
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.
−
</div>
+
* [[latest:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop JS API - (+demo)]]
−
</div><!-- End of pan -->
+
* [[latest:AgentDesktop-client-side-javascript-api-specification/APIMethods | New Widget Client-Side JS API]] - [https://help.brightpattern.com/crm-client-example/ (+demo)]
−
</div><!-- end of col 1-->
+
* [[latest:Desktop-javascript-api-specification/Purpose | Simple JS API for screen-popped pages]]
−
<div class="col-xs-12 col-md-6 col-lg-4">
+
* [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]]
−
<div class="panel panel-default">
+
 
−
<div class="panel-heading"><h4>List Management API <i class="fa fa-phone" style="float:right; font-size: 20px;"></i></h4></div>
+
</div><!-- end of col 3-->
−
<div class="panel-body">
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
 +
 
 +
==<i class="fa fa-microphone"></i> Interaction Content API==
 +
Download recordings as audio files along with their associated metadata with the Interaction Content API.
 +
* [https://documenter.getpostman.com/view/6711197/S1EUtb1f Interaction Content API (on Postman)] 
 +
</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-->
 +
==<i class="fa fa-list"></i> List Management API==
 
Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.
 
Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.
−
<btn>
+
* [https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest List Management API v2.0 (on Postman)]
−
Get APIs||btn-primary
+
* [https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z?version=latest List Management API v3.0 (on Postman)]
−
* List-management-api-specification/Purpose | List Management 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>Mobile  APIs <i class="fa fa-check-circle" style="float:right; font-size: 20px;"></i></h4></div>
 
−
<div class="panel-body">
 
−
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><!-- End of row 1-->
 
−
<div class="flex-row row">
 
−
<div class="col-xs-12 col-md-6 col-lg-4">
 
−
<div class="panel panel-default">
 
−
<div class="panel-heading"><h4>Recording  API <i class="fa fa-plug" style="float:right; font-size: 20px;"></i></h4></div>
 
−
<div class="panel-body">
 
−
Download recording audio files along with their associated metadata.
 
−
<btn>
 
−
Get APIs||btn-primary
 
−
* 5.3:Recording-retrieval-api-specification/About| Recording Retrieval 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>SMS/MMS  API <i class="fa fa-filter" style="float:right; font-size: 20px;"></i></h4></div>
 
−
<div class="panel-body">
 
−
Send and receive SMS/MMS messages, and track delivery status.
 
−
<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 1-->
 
−
<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-code" style="float:right; font-size: 20px;"></i></h4></div>
 
−
<div class="panel-body">
 
−
Work with subscriptions, real-time statistics, dispositions, and more.
 
−
<btn>
 
−
Get APIs||btn-primary
 
−
* 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><!-- end of col 1-->
 +
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2-->
 +
 +
==<i class="fa fa-mobile"></i> Mobile/Web Messaging APIs==
 +
Develop customer-facing mobile/web messaging apps for advanced chat, voice, and video communications.
 +
* [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]]
 +
* [https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest Mobile/Web Messaging API v2 (on Postman)]
 +
* [https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest Mobile/Web Messaging API v1 (on Postman)]
 +
</div><!-- start of col 2-->
 +
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 3-->
 +
==<i class="fa fa-arrows-alt-h"></i> SCIM-Compliant User Provisioning API==
 +
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 row 2-->
 
</div><!-- End of row 2-->
−
<div class="flex-row row">
+
<br /><div class="flex-row row"><!--beginning of row 3 -->
−
<div class="col-xs-12 col-md-6 col-lg-4">
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
−
<div class="panel panel-default">
+
==<i class="fa fa-comments"></i> SMS/MMS API==
−
<div class="panel-heading"><h4>User  Management API <i class="fa fa-check-circle" style="float:right; font-size: 20px;"></i></h4></div>
+
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-body">
+
* [https://documenter.getpostman.com/view/6711197/S1ETRbny SMS/MMS API Specification (on Postman)]
−
Automate user provisioning with third-party systems.
 
−
<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 1-->
 
</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.
−
 
+
* [https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest Real-Time Statistics API (on Postman)]
−
 
+
* [[Real-time-statistics-api/ListofStatistics|List of Statistics ]]
−
 
+
</div><!-- end of col 2-->
−
 
+
<div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 1-->
−
</translate>
+
==<i class="fa fa-check"></i> Task Routing API==
 +
Create and manage tasks with the Task Routing API.
 +
* [https://documenter.getpostman.com/view/31590362/2sA3XTfLhk Task Routing API (on Postman)]
 +
</div><!-- end of col 3-->
 +
</div><!-- end of row 3 -->

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"