pipecat-vobiz
Connect a Pipecat voice agent to phone calls on Vobiz, a global telephony provider for voice AI.
VobizFrameSerializer translates between Pipecat frames and the WebSocket protocol opened by the Vobiz <Stream> XML verb. It follows the same structure as Pipecat's built-in telephony serializers.
This integration is maintained by Vobiz.
Installation
uv add pipecat-vobiz
Or use pip install pipecat-vobiz.
How it works
Phone call <-> Vobiz <-> WebSocket <-> FastAPIWebsocketTransport + VobizFrameSerializer <-> your pipeline
| Pipecat | Vobiz |
|---|---|
media event |
InputAudioRawFrame |
OutputAudioRawFrame |
playAudio event |
InterruptionFrame |
clearAudio event |
EndFrame or CancelFrame |
REST DELETE on the call, when auto_hang_up is on |
Usage
Answer the call with XML that opens a bidirectional stream:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Stream bidirectional="true" keepCallAlive="true" contentType="audio/x-mulaw;rate=8000">wss://your-domain.com/ws/your-secret</Stream>
</Response>
Then read the start event and give the serializer to the transport:
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams, FastAPIWebsocketTransport
from pipecat_vobiz import VobizFrameSerializer, parse_vobiz_start
await websocket.accept()
start = await parse_vobiz_start(websocket)
serializer = VobizFrameSerializer(
stream_id=start["stream_id"],
call_id=start["call_id"],
auth_id=os.environ["VOBIZ_AUTH_ID"],
auth_token=os.environ["VOBIZ_AUTH_TOKEN"],
params=VobizFrameSerializer.InputParams(
encoding=start["encoding"],
vobiz_sample_rate=start["sample_rate"],
),
)
transport = FastAPIWebsocketTransport(
websocket=websocket,
params=FastAPIWebsocketParams(
audio_in_enabled=True,
audio_out_enabled=True,
serializer=serializer,
),
)
Run the transport in a pipeline at the sample rate from the start event:
pipeline = Pipeline(
[
transport.input(),
stt,
user_aggregator,
llm,
tts,
transport.output(),
assistant_aggregator,
]
)
worker = PipelineWorker(
pipeline,
params=PipelineParams(
audio_in_sample_rate=start["sample_rate"],
audio_out_sample_rate=start["sample_rate"],
),
)
examples/bot.py is the complete agent in one file, including stt, llm, tts and the aggregators.
Configuration
VobizFrameSerializer takes stream_id, call_id, auth_id, auth_token and params. The three credentials are required while auto_hang_up is on.
InputParams field |
Default | Description |
|---|---|---|
encoding |
audio/x-mulaw |
Inbound encoding: audio/x-mulaw or audio/x-l16. Must match the <Stream> contentType. |
vobiz_sample_rate |
8000 |
Inbound rate. μ-law supports 8000 Hz. L16 supports 8000 and 16000 Hz. |
output_encoding |
inbound encoding | Outbound encoding, set independently of inbound. |
output_sample_rate |
inbound rate | Outbound rate. L16 also supports 24000 Hz outbound. |
sample_rate |
None |
Overrides the pipeline input sample rate. |
auto_hang_up |
True |
End the call on EndFrame or CancelFrame. |
L16 audio is little-endian on the wire.
auto_hang_up deletes the whole call. If your XML has a verb after <Stream>, such as <Dial> for a transfer, set auto_hang_up=False so that the verb can run.
Run the example
You need a Vobiz account with a phone number, plus Deepgram and Google API keys.
-
Install the dependencies and add your keys:
uv pip install "pipecat-vobiz[example]" cp examples/env.example .env
-
Start the bot, and expose port 8765 at a public HTTPS URL:
python examples/bot.py ngrok http 8765
-
In the Vobiz console, create an application with
https://<your-url>/answeras its answer URL, and attach your number to it. -
Call the number.
For recording, transfers and a dashboard, see Vobiz-X-Pipecat. The full setup guide is at vobiz.ai/docs/integrations/pipecat.
Pipecat compatibility
Tested with Pipecat v1.15.0. The serializer code ran on real phone calls in every inbound and outbound format above, with auto_hang_up off. examples/bot.py ran with real Deepgram and Gemini against a simulated Vobiz stream, not on a phone call. Unit tests run against Pipecat 1.12.0 and 1.15.0, on Python 3.11 to 3.13.
DTMF digits sent through the Vobiz REST API did not reach the stream in testing, so treat InputDTMFFrame as unverified.
Development
uv pip install -e ".[dev]"
pytest
ruff check .
License
BSD 2-Clause. See LICENSE.
Metadata
Release files for pipecat-vobiz 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pipecat_vobiz-0.1.0.tar.gz | 14.2 kB | Without provenance | Details for pipecat_vobiz-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pipecat_vobiz-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for pipecat_vobiz-0.1.0-py3-none-any.whl |
Total release size: 23.2 kB
Release files / pipecat_vobiz-0.1.0.tar.gz
| Download URL | pipecat_vobiz-0.1.0.tar.gz |
|---|---|
| Size | 14.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9991fb75ae69604ed65efdfdd67688d92727e77ac537121e0de533c6d48c246a
|
|
BLAKE2b-256 checksum How to use checksums |
95af743ce8ccf2af33eeff198a749fe0d557e197a73fea8d747a7a7151fc16af
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / pipecat_vobiz-0.1.0-py3-none-any.whl
| Download URL | pipecat_vobiz-0.1.0-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a13ea498f5e00d7e444a68f2015a1914886549fc1fc462aada66dd667667d5a4
|
|
BLAKE2b-256 checksum How to use checksums |
b30ed40c4c7a94ea9a4020ee2ec235976f28273246b5ed724fc87ef34347327b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.1 {"installer":{"name":"uv","version":"0.11.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Security for pipecat-vobiz 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.