jambonz-python-sdk 0.2.0

Python SDK for jambonz CPaaS platform

jambonz Python SDK

Python SDK for the jambonz CPaaS platform.

Installation

pip install jambonz-python-sdk

Quick Start

Webhook (HTTP)

from aiohttp import web
from jambonz_sdk.webhook import WebhookResponse

async def handle_incoming(request: web.Request) -> web.Response:
    jambonz = WebhookResponse()
    jambonz.say(text="Hello!").gather(
        input=["speech"],
        actionHook="/handle-input",
        timeout=10,
        say={"text": "Please say something."},
    ).hangup()
    return web.json_response(jambonz.to_json())

app = web.Application()
app.router.add_post("/incoming", handle_incoming)
web.run_app(app, port=3000)

WebSocket

import asyncio
from jambonz_sdk.websocket import create_endpoint

async def main():
    make_service, runner = await create_endpoint(port=3000)
    svc = make_service(path="/")

    async def handle_session(session):
        session.say(text="Hello!").hangup()
        await session.send()

    svc.on("session:new", handle_session)
    await asyncio.Future()

asyncio.run(main())

REST Client

from jambonz_sdk.client import JambonzClient

async with JambonzClient(
    base_url="https://api.jambonz.us",
    account_sid="your-account-sid",
    api_key="your-api-key",
) as client:
    call_sid = await client.calls.create({
        "from": "[phone]",
        "to": {"type": "phone", "number": "[phone]"},
        "call_hook": "/incoming",
    })

How It Works

Spec-driven verb generation

The SDK does not hardcode verb method signatures. Instead, verb methods (.say(), .gather(), .dial(), .pipeline(), etc.) are auto-generated at import time from JSON Schema files — the same schemas used by the Node.js SDK and the jambonz server.

What this means:

• When the schema adds a new property to a verb, the SDK picks it up automatically — no code change needed
• Every method has real typed parameters (not **kwargs: Any) so IDEs show autocomplete and type hints
• Verb synonyms (stream ↔ listen, openai_s2s → llm with vendor: "openai") are handled by the registry

Updating the schema

# Download the pinned version from @jambonz/schema:
python scripts/sync_schema.py

# Or copy from a local clone:
python scripts/sync_schema.py --local /path/to/schema

If a new verb was added (not just new properties), add one line to verb_registry.py:

VerbDef("new_verb", "new_verb", doc="Description.")

Features

• All 31 jambonz verbs: say, play, gather, dial, conference, enqueue/dequeue, hangup, pause, redirect, config, tag, dtmf, dub, message, alert, answer, leave, listen/stream, transcribe, openai_s2s, google_s2s, deepgram_s2s, elevenlabs_s2s, ultravox_s2s, s2s, llm, dialogflow, pipeline, sip_decline, sip_request, sip_refer
• Fluent chainable API: .say(...).gather(...).hangup()
• Webhook transport: WebhookResponse for HTTP apps (works with aiohttp, FastAPI, Flask, etc.)
• WebSocket transport: create_endpoint with Session, event handling, send()/reply()
• REST client: JambonzClient with calls, conferences, queues, mid-call control
• Audio streaming: Bidirectional audio via AudioStream
• Mid-call control: inject commands (mute, whisper, record, DTMF, tag)
• TTS token streaming: send_tts_tokens() / flush_tts_tokens()
• Pipeline updates: update_pipeline() for mid-conversation LLM changes
• Signature verification: HMAC-SHA256 webhook signature validation
• Env vars: Portal discovery via OPTIONS + runtime reading

Examples

See the examples/ directory:

Example	Webhook	WebSocket	Description
hello-world	webhook	websocket	Minimal greeting
echo	webhook	websocket	Speech echo with gather
ivr-menu	webhook	—	IVR menu with speech + DTMF
voice-agent	webhook	websocket	LLM pipeline with tool calls
dial	webhook	—	Outbound dial with fallback
listen-record	webhook	websocket	Audio recording

Development

# Create venv and install
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"

# Run tests
pytest tests/unit/          # Fast unit tests (253)
pytest tests/integration/   # Real server tests (26)
pytest                      # All 279 tests

# Sync schema from upstream
python scripts/sync_schema.py

License

MIT