Bria Desktop API - Developer Guide - CounterPath

More documents

Recommendations

Info

CounterPath Corporation Bria Desktop API – Developer Guide 2. Working with the API Connecting to Bria 3 Connect to Bria by establishing a pipe connection to the named pipe “apipipe”. This pipe is full-duplex and message-oriented. You can make unlimited connections to the same instance of Bria, but all connections will receive the same information (events and responses) from Bria. The Bria API supports two types of communications: Events from Bria. See page 6. Request/response messages. See page 15. Events, requests and responses are in XML format with UTF-8 encoding. API Format The message format resembles HTTP but does not follow all HTTP conventions. The content-type is always application/xml, which means that the body always starts with Escape Character Handling These special characters must be escaped in requests. In responses, the characters will be represented by the escape sequence. " " ' ' < < > > & & Rev 8 Page 6
CounterPath Corporation Bria Desktop API – Developer Guide 3. Typical Sequences 3.1. Startup Startup The following diagram shows a recommended startup sequence. Keep in mind that at any time before, during, or after this sequence, you may receive events completely independent of this sequence. For example, if a call ends. Your app Bria 3 GET /status “phone” response GET /status “systemSettings” response GET /status “call” response Rev 8 Page 7
Page 1 and 2: Bria Desktop API Developer Guide
Page 3 and 4: CounterPath Corporation Bria Deskto
Page 5: CounterPath Corporation Bria Deskto
Page 13 and 14: CounterPath Corporation Missed Call
Page 17 and 18: CounterPath Corporation maxLines:
Page 23 and 24: CounterPath Corporation disabled di

Bria Desktop API - Developer Guide - CounterPath

Create successful ePaper yourself

Delete template?

Save as template?