Bria Desktop API - Developer Guide - CounterPath
Bria Desktop API - Developer Guide - CounterPath
Bria Desktop API - Developer Guide - CounterPath
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
<strong>CounterPath</strong> Corporation<br />
<strong>Bria</strong> <strong>Desktop</strong> <strong>API</strong> – <strong>Developer</strong> <strong>Guide</strong><br />
2. Working with the <strong>API</strong><br />
Connecting to <strong>Bria</strong> 3<br />
Connect to <strong>Bria</strong> by establishing a pipe connection to the named pipe “apipipe”. This pipe is full-duplex<br />
and message-oriented.<br />
You can make unlimited connections to the same instance of <strong>Bria</strong>, but all connections will receive the<br />
same information (events and responses) from <strong>Bria</strong>.<br />
The <strong>Bria</strong> <strong>API</strong> supports two types of communications:<br />
Events from <strong>Bria</strong>. See page 6.<br />
Request/response messages. See page 15.<br />
Events, requests and responses are in XML format with UTF-8 encoding.<br />
<strong>API</strong> Format<br />
The message format resembles HTTP but does not follow all HTTP conventions.<br />
The content-type is always application/xml, which means that the body always starts with <br />
Escape Character Handling<br />
These special characters must be escaped in requests.<br />
In responses, the characters will be represented by the escape sequence.<br />
" "<br />
' '<br />
< <<br />
> ><br />
& &<br />
Rev 8 Page 6
Change language