From Bright Pattern Documentation
| Line 27: | Line 27: | ||
<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> | + | <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"> | <div class="panel-body"> | ||
| − | + | Automate user provisioning with third-party systems using the Configuration API. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * | + | * https://documenter.getpostman.com/view/6711197/S1EUtanN| Configuration API |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 40: | Line 40: | ||
<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> | + | <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"> | <div class="panel-body"> | ||
| − | + | The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * 5.3: | + | * 5.3:Embedded-agent-desktop-sdk-specification/Purpose | Embedded Agent Desktop API |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 55: | Line 55: | ||
<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> | + | <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"> | <div class="panel-body"> | ||
| − | + | Download recording audio files along with their associated metadata with the Interaction Content API. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * | + | * https://documenter.getpostman.com/view/6711197/S1EUtb1f | Interaction Content API |
| − | |||
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 69: | Line 68: | ||
<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> | + | <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. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * | + | * 5.3:List-management-api-specification/Purpose | List Management API Specification |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 82: | Line 81: | ||
<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> | + | <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. | |
<btn> | <btn> | ||
Get APIs||btn-primary | 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 --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 97: | Line 97: | ||
<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> | + | <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 and MMS messages, as well as track delivery status with the SMS/MMS API. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * | + | * https://documenter.getpostman.com/view/6711197/S1ETRbny | SMS/MMS API Specification |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 110: | Line 110: | ||
<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> | + | <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 with the Real-Time Statistics API. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * 5.3: | + | * 5.3:Real-time-statistics-api/APIDescription| Real-Time Statistics API |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
| Line 123: | Line 123: | ||
<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> | + | <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. | |
<btn> | <btn> | ||
Get APIs||btn-primary | Get APIs||btn-primary | ||
| − | * | + | * 5.3:Tenant-management-api-specification/Purpose| Tenant Management API Specification |
</btn><!-- end of button --> | </btn><!-- end of button --> | ||
</div> | </div> | ||
Revision as of 16:24, 23 April 2019
<translate>
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. For more information, see getpostman.com.
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 APIs
Develop customer-facing mobile/web apps for advanced chat, voice, and video communications.
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.
</translate>