Overview

Overview

The Bria Desktop API allows third-party applications to control Bria for Windows softphone clients. By leveraging the Application API, third-party applications can perform commands such as starting an audio or video call, answering a call or placing a call on hold.

The Bria for Desktop API was originally used by CounterPath in conjunction with a Microsoft Outlook® Add-In, to enable Bria calls to be placed from within the Outlook® application. It has therefore been “hardened” for commercial use.

CounterPath is now encouraging third-party-application developers to integrate their applications with Bria. Suggested applications range from simple functions such as enabling click-to-call from web pages, to integration with sophisticated Call Center, Customer Relationship Management (CRM) and Health Care applications.

Please note that that the Bria for Desktop API is not a substitute for CounterPath’s Software Development Kit (SDK), which provides significantly more flexibility and does not require the Bria for Windows softphone client to be running.
Functions

The Bria for Desktop API provides functions that enable third-party applications to control Bria 3 for Windows softphones.

For example, your application may have a web page that provides information about customers for your employees to phone.

• The employee clicks on the customer phone number, which invokes a function from the Bria for Desktop API to place the phone call through the employee's Bria desktop softphone.
• Bria executes the request and sends events to your application. These events provide information about the status of the request
• The employee manages the call using Bria. They can put the call on hold, transfer the call, mute the call, and so on.
• When the call ends, your application will receive notification that the call has ended.

Please note that while the API provides some control over Bria, it does not have complete control. The user may have to interact with the Bria user interface in order to manage specific features such as Call Transfer.

By leveraging the Application API, third-party applications can perform commands such as:

• Place audio or video call
• Bring Bria GUI to front
• Call history
• Send an Instant Message
• Retrieve Contacts information, including Presence status
• Call status / System settings
• Answer call
• Call hold
• End call
• Voice Mail / MWI / Connect to VM Server