From Bright Pattern Documentation
Wyler.metge (talk | contribs) (Updated via BpClonePage extension. Source page: draft:Api) |
Wyler.metge (talk | contribs) (→API Reference: clarifies that SMS/MMS API also supports some messenger integrations) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 10: | Line 10: | ||
==<i class="fa fa-user"></i> Configuration API== | ==<i class="fa fa-user"></i> Configuration API== | ||
Automate user provisioning with third-party systems using the Configuration API. | Automate user provisioning with third-party systems using the Configuration API. | ||
| − | * [https://documenter.getpostman.com/view/6711197/S1EUtanN | + | * [https://documenter.getpostman.com/view/6711197/S1EUtanN Configuration API (on Postman)] |
</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--> | <div class="col-xs-12 col-md-6 col-lg-4"><!-- start of col 2--> | ||
==<i class="fa fa-user"></i> Embedded Desktop API== | ==<i class="fa fa-user"></i> Embedded Desktop API== | ||
The Embedded Agent Desktop API allows you to use Agent Desktop directly from your webpage. | 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]] | * [[Embedded-agent-desktop-sdk-specification/Purpose| Embedded Agent Desktop API]] | ||
| + | |||
</div><!-- end of col 3--> | </div><!-- end of col 3--> | ||
<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"><!-- start of col 3--> | ||
| + | |||
==<i class="fa fa-microphone"></i> Interaction Content API== | ==<i class="fa fa-microphone"></i> Interaction Content API== | ||
Download recordings as audio files along with their associated metadata with the 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 | + | * [https://documenter.getpostman.com/view/6711197/S1EUtb1f Interaction Content API (on Postman)] |
</div><!-- end of col 3--> | </div><!-- end of col 3--> | ||
</div><!-- End of row 1--> | </div><!-- End of row 1--> | ||
| Line 27: | Line 32: | ||
==<i class="fa fa-list"></i> List Management API== | ==<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. | ||
| − | * [https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest | + | * [https://documenter.getpostman.com/view/6735878/T1DtdFDu?version=latest List Management API v2.0 (on Postman)] |
| + | * [https://documenter.getpostman.com/view/8336025/2sA3Qy5U4z?version=latest List Management API v3.0 (on Postman)] | ||
</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"><!-- start of col 2--> | ||
| + | |||
==<i class="fa fa-mobile"></i> Mobile/Web Messaging APIs== | ==<i class="fa fa-mobile"></i> Mobile/Web Messaging APIs== | ||
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. | ||
* [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]] | * [[Mobile-SDK-Instruction-Manual/About| Mobile SDK Instruction Manual]] | ||
| − | * [https://documenter.getpostman.com/view/6735878/TzXwFJFP?version=latest | + | * [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 | + | * [https://documenter.getpostman.com/view/6735877/T1LHGpBY?version=latest Mobile/Web Messaging API v1 (on Postman)] |
</div><!-- start of col 2--> | </div><!-- start 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"><!-- start of col 3--> | ||
==<i class="fa fa-arrows-alt-h"></i> SCIM-Compliant User Provisioning API== | ==<i class="fa fa-arrows-alt-h"></i> SCIM-Compliant User Provisioning API== | ||
Communicate user identity data between identity providers and service providers. | Communicate user identity data between identity providers and service providers. | ||
| − | * [https://documenter.getpostman.com/view/8336025/SVYwJbLw?version=latest | + | * [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--> | ||
| Line 45: | Line 52: | ||
<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"><!-- start of col 1--> | ||
==<i class="fa fa-comments"></i> SMS/MMS API== | ==<i class="fa fa-comments"></i> SMS/MMS API== | ||
| − | Send and | + | Send, receive, and monitor the delivery of messages via SMS, MMS, and certain [[latest:Messenger-integrations/overview-messenger-integrations| integrated messenger platforms]]. |
| − | * [https://documenter.getpostman.com/view/6711197/S1ETRbny | + | * [https://documenter.getpostman.com/view/6711197/S1ETRbny SMS/MMS API Specification (on Postman)] |
</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"><!-- start of col 2--> | ||
==<i class="fa fa-chart-bar"></i> Statistics API== | ==<i class="fa fa-chart-bar"></i> Statistics API== | ||
Work with subscriptions, real-time statistics, dispositions, and more with the Real-Time 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 | + | * [https://documenter.getpostman.com/view/6735878/T1DwbtSk?version=latest Real-Time Statistics API (on Postman)] |
| − | * [[Real-time-statistics-api/ListofStatistics| List of Statistics ]] | + | * [[Real-time-statistics-api/ListofStatistics|List of Statistics ]] |
</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"><!-- start of col 1--> | ||
==<i class="fa fa-check"></i> Task Routing API== | ==<i class="fa fa-check"></i> Task Routing API== | ||
Create and manage tasks with the Task Routing API. | Create and manage tasks with the Task Routing API. | ||
| − | * [https://documenter.getpostman.com/view/31590362/2sA3XTfLhk | + | * [https://documenter.getpostman.com/view/31590362/2sA3XTfLhk Task Routing API (on Postman)] |
</div><!-- end of col 3--> | </div><!-- end of col 3--> | ||
</div><!-- end of row 3 --> | </div><!-- end of row 3 --> | ||
Latest revision as of 03:38, 21 November 2024
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.