baresip-python

Python bindings for the baresip SIP stack — a complete, embeddable SIP user agent for Python applications: registration, inbound and outbound calls, programmatic PCM audio and VP8 video access, and DTMF, with an asyncio-native API.

Status: alpha, under active development. Current release: v0.3.0a1 on PyPI. The API may still change between pre-releases; every break is called out in the CHANGELOG.

What this is

• pip install baresip-python, import baresip — no compiler, no system SIP stack needed (wheels statically bundle libre and libbaresip).
• A generic binding: nothing framework-specific inside. Audio can go to/from WAV files (baresip's built-in drivers) or to/from your application as raw PCM (the aumem driver) — which is how frameworks like pipecat consume it.
• BSD-2-Clause, on top of baresip/libre (BSD-3). No GPL code is ever published in our binaries.

Quick start

Releases install from PyPI (pip install --pre baresip-python — pre-releases need the flag). For development, build from a source checkout: you need uv, a C compiler, cmake, and the OpenSSL, opus, and libvpx development headers (apt install cmake libssl-dev libopus-dev libvpx-dev libv4l-dev on Debian/Ubuntu, brew install cmake openssl@3 opus libvpx on macOS):

git clone --recurse-submodules https://github.com/daily-co/baresip-python.git
cd baresip-python
uv sync --group dev
make native ext

Everything below runs against the bundled FreeSWITCH bench — a docker compose setup with test users (1001/1002, password bench1234) and an echo service at extension 9196 (see bench/README.md):

make bench-up

The examples are the tutorial, written to be read in order. Each is self-contained, heavily commented, and configured entirely through SIP_USER/SIP_PASS/SIP_DOMAIN environment variables whose defaults match the bench.

01 — register. The core lifecycle: one Runtime per process (it owns the SIP thread), a UserAgent bound to an Account, register(), a clean shutdown. Re-registration is automatic while it runs.

uv run python examples/01_register.py

02 — dial. An outbound call to the echo service and a call that fails: dial(), wait_established(), custom INVITE headers, and telephony outcomes as typed exceptions (CallBusy, CallDeclined, ...) instead of error codes.

uv run python examples/02_dial.py

03 — programmatic audio. The aumem driver, the shape a voice agent needs: call.audio.read() returns the far end's PCM, call.audio.write() queues yours — plain bytes, no sound card, no files.

uv run python examples/03_echo_aumem.py

04 — answer + WAV bot. A bot with zero custom audio code: answer an incoming call, play a greeting from a WAV file, record the caller — audio drivers as pure configuration. Have the bench call the bot from a second terminal:

uv run python examples/04_answer_wav_bot.py
docker exec baresip-bench-freeswitch fs_cli -x "originate user/1001 &echo()"

05 — DTMF IVR. DTMF in both directions: run one instance as a mini-IVR (press 1 for a tone, 2 to hang up), a second as the caller that presses the keys.

uv run python examples/05_dtmf_ivr.py
SIP_USER=1002 SIP_PASS=bench1234 uv run python examples/05_dtmf_ivr.py sip:1001@127.0.0.1:15060

06 — softphone. Real speakers-and-microphone audio: the platform's hardware driver is picked automatically (coreaudio on macOS, alsa on Linux). Register and auto-answer the first call, or set SIP_DIAL to dial out; type digits + Enter to send DTMF, received digits are printed, h hangs up. Dialing the bench's echo service lets you hear yourself — use a headset, there is no echo cancellation.

SIP_DIAL=sip:9196@127.0.0.1:15060 uv run python examples/06_softphone.py

07 — warm transfer. The receptionist pattern: answer a caller, consult a second destination, bridge the two calls in Python audio while staying in the path, then splice the parties together with an attended transfer and drop out. Run the bot, then call it with the softphone example from a second terminal (the caller must reach the bot bridged through the switch — see the example's docstring):

SIP_USER=1001 SIP_PASS=bench1234 uv run python examples/07_warm_transfer.py
SIP_USER=1002 SIP_DIAL=sip:1001@127.0.0.1:15060 uv run python examples/06_softphone.py

08 — video call. Your camera on a VP8 call, the far end's video in a window. Two instances call each other directly — no switch in the middle (the bench declines video) — each showing the other's camera; macOS asks for camera permission on first run. Add AUDIO_DRIVER=coreaudio (macOS) or alsa (Linux) for a full video softphone with real microphone and speakers:

SIP_LISTEN=127.0.0.1:5070 uv run python examples/08_video_call.py
SIP_LISTEN=127.0.0.1:5072 SIP_DIAL=sip:alice@127.0.0.1:5070 uv run python examples/08_video_call.py

Audio and device selection

Audio drivers are chosen when the runtime starts — Config(audio_source=..., audio_player=...), one driver per direction — and stay put for the runtime's lifetime; there is no mid-call driver switching. This is deliberate: audio a program decides on at runtime is what the aumem driver is for (it is just bytes your code reads and writes), and richer switching APIs are planned for a later release. What a "device" means belongs to each driver: a WAV path for aufile, a tone frequency for ausine, the sound card for the hardware drivers (coreaudio on macOS, alsa on Linux), nothing at all for aumem.

Custom headers

Outbound INVITEs take custom headers directly: ua.dial(uri, headers={...}) (example 02). On the receiving side, Config(expose_headers=[...]) allowlists header names whose values then ride along on call events.

One deliberate absence: the 100 Trying that answers an incoming INVITE cannot carry custom headers. The stack sends it automatically, before the application ever sees the call — and it is a hop-by-hop response, so a header on it would die at the first proxy anyway. Headers on the final response (answer/reject) are planned for a later release.

Transfers and hold

Hold/resume (call.hold(), with the far end's hold state in call.remote_on_hold), blind transfer (call.transfer(uri)), attended transfer (call.attended_transfer(consult)), and the receiving side — a peer's REFER as a typed TransferRequest, governed by a transfer_policy that defaults to manual because a transfer is the far end instructing your agent to place a call. The semantics have real surprises (a successful transfer closes your call; that is the protocol, not the binding) — read docs/TRANSFER.md before building on them. Example 07 is the runnable version.

Video

Calls made or answered with video=True negotiate VP8, and call.video exchanges it as packed I420 frames — write_frame() feeds the paced encoder, read_frame() takes decoded frames, and camera capture (avcapture on macOS, v4l2 on Linux) is pure configuration via Config(video_source=...). The library deliberately ships no display: rendering belongs to the application on its main thread, and docs/VIDEO.md explains the frames contract, the readiness and renegotiation semantics, and why that display stance is the only one that works.

SIP trunks

Trunk-style connections — no registration, and a digest username that differs from the URI user — are Account(reg_interval=0) and Account(auth_user=...). What each means, which provider products want which shape (Twilio's SIP Domains vs Elastic SIP Trunking split as the worked example), and the fail-fast behaviors around them are in docs/TRUNKS.md.

Fleet operations

Two controls for running agents at scale. Config(max_concurrent_calls=...) caps the runtime's calls natively — beyond the limit, inbound INVITEs are refused with 486 before any call object exists. The default is 2 (one conversation plus a consultation leg, the warm-transfer shape); None removes the cap. await runtime.drain() is the rollout half of shutdown: new inbound calls are refused on the SIP thread, dial() raises DrainingError, and the call resolves once the last live call ends — drain, then close(), and the fleet can retire the instance without dropping anyone mid-sentence.

Logging

The library logs into the standard baresip.* logger hierarchy and never touches handlers or output itself. Records carry correlation fields in extra — most importantly sip_call_id, the spine that ties Python-side events, native-stack lines, and SIP traces to one call. The native stack's own logs surface under baresip.native, and a full SIP message trace is available under baresip.native.sip. Per-call DEBUG on a busy server is a filter problem, not a level problem — see PerCallFilter in docs/LOGGING.md, along with the loguru bridge for applications (pipecat among them) that log through loguru.

Platform support

Linux (x86_64, aarch64) and macOS (Apple Silicon and Intel), CPython 3.11–3.13. On Windows, WSL2 is the supported path for now — the Linux build runs there as-is; native Windows support is a design goal the code keeps its door open for, but it is not built or tested today.

Building with GPL codecs (H.264)

The published wheels never contain GPL code. H.264 via ffmpeg's avcodec is available as a source-build opt-in — your machine, your build, your license terms — documented in docs/GPL-CODECS.md, including the x264 encode-vs-decode nuance that decides whether GPL applies at all. Support level, honestly: the avcodec build is compile-verified weekly in CI (built and unit-tested, never distributed); its runtime behavior is community-supported.

Security

See SECURITY.md — how to report a vulnerability, which versions receive fixes, and a short threat-model note for operators: a registered user agent is a server as well as a client, and a publicly addressable one will receive unsolicited INVITEs and scanner traffic.

API stability policy

The public API is exactly what baresip.__all__ exports and these docs describe; everything else is internal. Versioning is SemVer with the 0.x caveat: minor bumps before 1.0 may break, and every break is called out in the CHANGELOG. Deprecated names keep working for one minor version with a DeprecationWarning before removal. The package is fully typed (py.typed).

License

BSD 2-Clause. Copyright (c) 2026, Daily. Bundled third-party components (libre, libbaresip) are BSD-3-Clause; their notices ship with every distribution. Built wheels additionally bundle OpenSSL, libopus, and libvpx — and, on Linux, ALSA's libasound — under their respective licenses; see docs/UPGRADING.md for how security releases in those propagate here.