From Bright Pattern Documentation
Jump to: navigation, search
Line 2: Line 2:
 
= API Reference =
 
= API Reference =
  
<div class="flex-row row">
+
<div class="flex-row row"><!--beginning of row 1 -->
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<div class="panel panel-default">
<div class="panel-heading"><h4>Agent Desktop APIs <i class="fa fa-wrench" style="float:right; font-size: 20px;"></i></h4></div>
+
<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">
 
<div class="panel-body">
 
Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.
 
Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.
Line 17: Line 17:
 
</div><!-- End of pan -->
 
</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">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<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 class="panel-heading"><h4>Embedded Desktop API <i class="fa fa-sign-in" 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 2-->
 +
 
 +
<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">
 
<div class="panel-body">
 
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.
Line 28: Line 42:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 1-->
+
</div><!-- end of col 3-->
 +
</div><!-- End of row 1-->
 +
 
 +
<div class="flex-row row"><!--beginning of row 2 -->
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<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-heading"><h4>Mobile  APIs <i class="fa fa-mobile" style="float:right; font-size: 24px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
Develop customer-facing mobile/web apps for advanced chat, voice, and video communications.
 
Develop customer-facing mobile/web apps for advanced chat, voice, and video communications.
Line 42: Line 59:
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
 
</div><!-- end of col 1-->
 
</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="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<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-heading"><h4>Recording  API <i class="fa fa-microphone" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
Download recording audio files along with their associated metadata.
+
Download recording audio files along with their associated metadata with the Recording Retrieval API.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
Line 55: Line 71:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 1-->
+
</div><!-- end of col 2-->
 +
 
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<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-heading"><h4>SMS/MMS  API <i class="fa fa-comments-o" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
Send and receive SMS/MMS messages, and track delivery status.
+
Send and receive SMS and MMS messages, as well as track delivery status with the SMS/MMS API.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
Line 67: Line 84:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 1-->
+
</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="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<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-heading"><h4>Statistics  API <i class="fa fa-bar-chart-o" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
Work with subscriptions, real-time statistics, dispositions, and more.
+
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time Statistics API.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
Line 80: Line 100:
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
 
</div><!-- end of col 1-->
 
</div><!-- end of col 1-->
</div><!-- End of row 2-->
+
 
<div class="flex-row row">
 
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<div class="panel panel-default">
<div class="panel-heading"><h4>Tenant Management API </h4></div>
+
<div class="panel-heading"><h4>Tenant Management API</h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
 
Transfer tenant configuration between various environments, create tenants from templates, and more.
 
Transfer tenant configuration between various environments, create tenants from templates, and more.
Line 93: Line 112:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 1-->
+
</div><!-- end of col 2-->
 +
 
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="col-xs-12 col-md-6 col-lg-4">
 
<div class="panel panel-default">
 
<div class="panel panel-default">
<div class="panel-heading"><h4>User Management API <i class="fa fa-check-circle" style="float:right; font-size: 20px;"></i></h4></div>
+
<div class="panel-heading"><h4>User Management API <i class="fa fa-user" style="float:right; font-size: 20px;"></i></h4></div>
 
<div class="panel-body">
 
<div class="panel-body">
Automate user provisioning with third-party systems.
+
Automate user provisioning with third-party systems using the User Management API.
 
<btn>
 
<btn>
 
Get APIs||btn-primary
 
Get APIs||btn-primary
Line 105: Line 125:
 
</div>
 
</div>
 
</div><!-- End of pan -->
 
</div><!-- End of pan -->
</div><!-- end of col 2-->
+
</div><!-- end of col 3-->
 
+
</div><!-- end of row 3 -->
  
  

Revision as of 22:05, 10 April 2019

• 5.2 • 5.3

API Reference

Agent Desktop APIs

Access Agent Desktop functions using JavaScript; control agent states and handle calls from .NET-based applications.

Embedded Desktop API

The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage.

List Management API

Manage the contents of outbound calling lists and Do Not Call lists via third-party applications.

Mobile APIs

Develop customer-facing mobile/web apps for advanced chat, voice, and video communications.

Recording API

Download recording audio files along with their associated metadata with the Recording Retrieval API.

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.

Tenant Management API

Transfer tenant configuration between various environments, create tenants from templates, and more.

User Management API

Automate user provisioning with third-party systems using the User Management API.