VoIP 0.1.0

Python asyncio library for VoIP calls.

Documentation | Issues | Changelog | Funding 💚

Python VoIP library

[!WARNING] This library is in early development and may contain breaking changes. Use with caution.

Python asyncio library for SIP telephony (RFC 3261).

All signalling uses SIP over TLS (SIPS, RFC 3261 §26) and all media is protected with SRTP (RFC 3711) using the AES_CM_128_HMAC_SHA1_80 cipher suite with SDES key exchange (RFC 4568).

Setup

pip install voip[audio,cli,pygments]

Usage

CLI

Answer calls and transcribe them live from the terminal:

voip sip transcribe sips:[e-mail] --password secret

Python API

Subclass WhisperCall and override transcription_received to handle results. Pass it as call_class when answering an incoming call:

import asyncio
import ssl
from voip.audio import WhisperCall
from voip.sip.protocol import SIP


class MyCall(WhisperCall):
    def transcription_received(self, text: str) -> None:
        print(f"[{self.caller}] {text}")


class MySession(SIP):
    def call_received(self, request) -> None:
        asyncio.create_task(self.answer(request=request, call_class=MyCall))


async def main():
    loop = asyncio.get_running_loop()
    ssl_context = ssl.create_default_context()
    await loop.create_connection(
        lambda: MySession(
            aor="sips:[e-mail]",
            username="alice",
            password="secret",
        ),
        host="sip.example.com",
        port=5061,
        ssl=ssl_context,
    )
    await asyncio.Future()


asyncio.run(main())

For raw audio access without transcription, subclass AudioCall and override audio_received(self, audio: np.ndarray) instead.