Public
Documentation Settings
No Environment
Double Column
cURL - cURL
BPCC Mobile/Web Messaging API v2
Introduction
Audience
Sample Applications
General Information
Methods
Events

BPCC Mobile/Web Messaging API v2

The Bright Pattern Contact Center (BPCC) Mobile/Web Messaging API v2 is a RESTful API that allows developers to integrate chat and voice interactions with mobile devices or third-party applications. The BPCC Mobile/Web Messaging API v2 expands on our existing Mobile/Web Messaging API v1, and can be used for development of rich contact applications, such as customer-facing mobile, web, and messaging applications for advanced chat, voice, and video communications with Bright Pattern Contact Center-based contact centers.

Features

In addition to all the methods and events included in the v1 API, the Mobile/Web Messaging API v2 includes the following:

  • Support for the Apple Push Notification service (iOS) and Firebase Cloud Messaging push notifications (Android and iOS) with the Mobile Notification Subscription method

  • The Get Case History method, which returns the combined transcripts of all chat sessions linked to a specific CRM Case object

  • The Close Case method, which allows a client application request to close the case associated with the chat session

  • The Get Version method, which returns the version of Bright Pattern Contact Center used on the server.

  • Server and client events indicating that a chat session message was delivered or read

  • A server event indicating if a chat session case was set

Note

The BPCC Mobile/Web Messaging API v2 endpoint prefix is as follows:

https://[tenant_url]/clientweb/api/v2/

Audience

This documentation is intended for the IT personnel and developers of custom applications for Bright Pattern Contact Center-based contact centers. Readers of this documentation are expected to have expertise in web and mobile application development as well as a solid understanding of contact center operations and resources that are involved in such operations.

Sample Applications

Bright Pattern provides source code of sample customer-facing rich contact applications. This source code can be used as a reference for in-house application development or it can be embedded directly into the customer-facing mobile applications and/or web applications of your organization.

For web chat applications, you can download the source code by clicking the Client application button on the Messaging/Chat Scenario Entry page of the Contact Center Administrator application.

For mobile applications, you can obtain the source code by submitting a service request to Bright Pattern Customer Success Management.