Verbs & Webhooks¶
Response¶
jambonz.webhook.response.JambonzResponse
¶
Bases: RootModel[list[Verb]]
A list of jambonz verbs to return as a webhook response.
Usage
FastAPI — type hint, return raw list¶
@app.post("/call") def handle() -> JambonzResponse: return [Say(text="Hello"), Hangup()]
Flask / Django — construct and serialize¶
response = JambonzResponse([Say(text="Hello"), Hangup()]) response.model_dump() # → list[dict] response.model_dump_json() # → str
Outgoing verbs¶
jambonz.webhook.verbs.Say
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Play
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Gather
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Pause
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Hangup
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Redirect
¶
Bases: _JambonzBase
jambonz.webhook.verbs.LLM
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Dial
¶
Bases: _JambonzBase
Incoming webhooks¶
jambonz.webhook.incoming.CallWebhook
¶
Bases: _JambonzModel
Payload jambonz sends to your call_hook when a new call arrives. https://docs.jambonz.org/reference/webhooks/call-webhook
jambonz.webhook.incoming.CallStatusEvent
¶
Bases: _JambonzModel
Payload jambonz sends to your call_status_hook.
jambonz.webhook.incoming.GatherResult
¶
Bases: _JambonzModel
Payload jambonz sends to gather's actionHook.
transcript
property
¶
Shortcut to get the best transcript.
jambonz.webhook.incoming.DialResult
¶
Bases: _JambonzModel
Payload jambonz sends to dial's actionHook.
jambonz.webhook.incoming.LLMResult
¶
Bases: _JambonzModel
Payload jambonz sends to llm's actionHook when session ends.
jambonz.webhook.incoming.ToolCall
¶
Bases: _JambonzModel
Payload jambonz sends to llm's toolHook.
jambonz.webhook.incoming.ToolResult
¶
Bases: _JambonzModel
Response to send back for a tool call.
Shared types¶
jambonz.webhook.verbs.Synthesizer
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Recognizer
¶
Bases: _JambonzBase
jambonz.webhook.verbs.Input
¶
Bases: str, Enum