Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Protocols

brisvox speaks three protocols to the outside, each with its own reference page:

ProtocolForDirectionReference
Websocket protocol (version 1)Browsers, apps and test clients: one websocket connection is one call. Binary frames carry audio, text frames carry JSON control messages (start, started, clear, mark, dtmf, stop, ...).Client connects to the server (BRISVOX_WS_ADDR)WebSocket protocol
Agent protocol (version 1)Your application logic in another process: tools, events, commands. The Python and TypeScript SDKs implement it.The server connects out to your agent (BRISVOX_AGENT_URL)Agent protocol
RTVIPipecat's client SDKs talking to brisvox.Client connects to the server (BRISVOX_RTVI_ADDR)RTVI

Carrier and browser transports have their own pages: Twilio Media Streams, Telnyx media streaming, SIP trunk and WebRTC. All listeners and their settings are in Operations.