baresipy

A python wrapper around baresip, the portable SIP user-agent.

Use it to place and receive VoIP calls from python. You can dial out, answer inbound calls, stream text-to-speech or arbitrary audio into a call, send and receive DTMF, transcribe what a caller says, and build interactive voice bots, with or without a SIP registrar, with or without a sound card.

Install

sudo apt-get install baresip ffmpeg   # Debian/Ubuntu, see docs/setup.md for other distros
pip install baresipy

baresip is the SIP engine baresipy drives through pexpect. ffmpeg is used by pydub for audio conversion. See docs/setup.md for per-distro install commands, SIP account requirements, and troubleshooting.

Optional extras:

Quickstart

Scripted call

Dial a number, speak, hang up:

from baresipy import BareSIP
from time import sleep

b = BareSIP("your_user", "your_password", "your_sip_gateway.example")
b.call("someone@your_sip_gateway.example")

while b.running:
    sleep(0.5)
    if b.call_established:
        b.speak("hello, this is a test")
        b.hang()
        b.quit()
        break

Full runnable version: examples/scripted_call.py.

Answering bot

Subclass BareSIP and override the event handlers:

from baresipy import BareSIP
from time import sleep


class JokeBOT(BareSIP):
    def handle_incoming_call(self, number):
        self.accept_call()

    def handle_call_established(self):
        self.speak("Welcome to the jokes bot")
        self.speak("Goodbye")
        self.hang()


b = JokeBOT("your_user", "your_password", "your_sip_gateway.example")
while b.running:
    sleep(1)

Full runnable version: examples/events.py.

OVOS voice bot

Answer a call and transcribe the caller with an OVOS STT/VAD pipeline, using the incoming call audio as a microphone source:

from baresipy import BareSIP
from baresipy.ovos import BareSIPMicrophone
from ovos_plugin_manager.stt import OVOSSTTFactory
from ovos_plugin_manager.vad import OVOSVADFactory
from ovos_simple_listener import SimpleListener, ListenerCallbacks


class VoiceBot(BareSIP):
    def handle_incoming_call(self, number):
        self.accept_call()

    def handle_call_established(self):
        mic = BareSIPMicrophone(sip=self)
        SimpleListener(mic=mic, wakeword=None,
                        vad=OVOSVADFactory.create(),
                        stt=OVOSSTTFactory.create(),
                        callbacks=ListenerCallbacks()).start()


bot = VoiceBot("your_user", "your_password", "your_sip_gateway.example", record_rx=True)

Full runnable version with two-way TTS replies: examples/voice_bot.py. See docs/ovos-integration.md for the complete walkthrough.

Examples

See docs/call-control.md for transfer, DTMF, barge-in, and call-metadata details used across these examples.

Features

Documentation

• docs/setup.md: system dependencies, install, verifying with a first call, troubleshooting
• docs/configuration.md: config directory, render_config, full BareSIP constructor reference
• docs/call-control.md: transfer, DTMF, barge-in, call metadata, login retries
• docs/direct-calls.md: registrar-less/direct SIP mode
• docs/ivr.md: declarative IVR phone-tree menus
• docs/ovos-integration.md: building a full OVOS voice bot
• docs/http-gateway.md: driving baresipy over HTTP/WebSocket through baresipy-gateway
• docs/docker.md: container image usage and the e2e rig
• docs/testing.md: running and writing tests

Related projects

• OpenVoiceOS: the voice-assistant platform baresipy's optional STT/VAD/TTS pipeline is built on
• ovos-plugin-manager: the plugin factory system used to load STT, VAD, and TTS engines
• phoonnx: the default TTS engine used by speak()/say()

Credits

This work has been sponsored by Matt Keys, eZuce Inc

License

MIT