jambonz-python-sdk 0.2.0__py3-none-any.whl

jambonz_sdk/schema/verbs/sip-refer.schema.json

@@ -0,0 +1,58 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/sip:refer",
+  "minVersion": "0.9.6",
+  "title": "SIP Refer",
+  "description": "Sends a SIP REFER request to transfer the call to another party. Initiates an attended or unattended (blind) transfer.",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "const": "sip:refer"
+    },
+    "id": {
+      "type": "string",
+      "description": "An optional unique identifier for this verb instance."
+    },
+    "referTo": {
+      "type": "string",
+      "description": "The SIP URI or phone number to transfer the call to.",
+      "examples": [
+        "sip:alice@example.com",
+        "+15085551212"
+      ]
+    },
+    "referredBy": {
+      "type": "string",
+      "description": "The SIP URI to use in the Referred-By header."
+    },
+    "referredByDisplayName": {
+      "type": "string",
+      "description": "The display name to use in the Referred-By header."
+    },
+    "headers": {
+      "type": "object",
+      "description": "Custom SIP headers to include in the REFER request.",
+      "additionalProperties": {
+        "oneOf": [{ "type": "string" }, { "type": "number" }]
+      }
+    },
+    "actionHook": {
+      "$ref": "../components/actionHook",
+      "description": "A webhook invoked when the REFER completes (or fails)."
+    },
+    "eventHook": {
+      "$ref": "../components/actionHook",
+      "description": "A webhook invoked for NOTIFY events during the REFER process, providing transfer progress updates."
+    }
+  },
+  "required": [
+    "referTo"
+  ],
+  "examples": [
+    {
+      "verb": "sip:refer",
+      "referTo": "sip:alice@example.com",
+      "actionHook": "/refer-complete"
+    }
+  ]
+}

jambonz_sdk/schema/verbs/sip-request.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/sip:request",
+  "minVersion": "0.9.6",
+  "title": "SIP Request",
+  "description": "Sends a SIP request within the current dialog. Used to send INFO, NOTIFY, or other SIP methods to the remote party during an active call.",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "const": "sip:request"
+    },
+    "id": {
+      "type": "string",
+      "description": "An optional unique identifier for this verb instance."
+    },
+    "method": {
+      "type": "string",
+      "description": "The SIP method to send.",
+      "examples": [
+        "INFO",
+        "NOTIFY",
+        "MESSAGE"
+      ]
+    },
+    "body": {
+      "type": "string",
+      "description": "The body of the SIP request."
+    },
+    "headers": {
+      "type": "object",
+      "description": "Custom SIP headers to include in the request.",
+      "additionalProperties": {
+        "oneOf": [{ "type": "string" }, { "type": "number" }]
+      }
+    },
+    "actionHook": {
+      "$ref": "../components/actionHook",
+      "description": "A webhook invoked when the response to the SIP request is received."
+    }
+  },
+  "required": [
+    "method"
+  ],
+  "examples": [
+    {
+      "verb": "sip:request",
+      "method": "INFO",
+      "body": "Signal=1\nDuration=250",
+      "headers": {
+        "Content-Type": "application/dtmf-relay"
+      }
+    }
+  ]
+}

jambonz_sdk/schema/verbs/stream.schema.json

@@ -0,0 +1,103 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/stream",
+  "minVersion": "0.9.6",
+  "title": "Stream",
+  "description": "Streams real-time call audio to an external websocket endpoint. Functionally equivalent to 'listen' — this is an alias provided for naming clarity when the intent is audio streaming rather than recording.",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "const": "stream"
+    },
+    "id": {
+      "type": "string",
+      "description": "An optional unique identifier for this verb instance."
+    },
+    "url": {
+      "type": "string",
+      "format": "uri",
+      "description": "The websocket URL to stream audio to."
+    },
+    "actionHook": {
+      "$ref": "../components/actionHook",
+      "description": "A webhook invoked when the stream ends."
+    },
+    "wsAuth": {
+      "$ref": "../components/auth",
+      "description": "Authentication credentials for the websocket connection."
+    },
+    "mixType": {
+      "type": "string",
+      "enum": [
+        "mono",
+        "stereo",
+        "mixed"
+      ],
+      "description": "How to mix audio channels."
+    },
+    "metadata": {
+      "type": "object",
+      "description": "Metadata to send with the initial connection.",
+      "additionalProperties": true
+    },
+    "sampleRate": {
+      "type": "number",
+      "description": "Audio sample rate in Hz.",
+      "examples": [
+        8000,
+        16000
+      ]
+    },
+    "finishOnKey": {
+      "type": "string",
+      "description": "DTMF key that ends the stream."
+    },
+    "maxLength": {
+      "type": "number",
+      "description": "Maximum duration in seconds."
+    },
+    "passDtmf": {
+      "type": "boolean",
+      "description": "Forward DTMF events to the websocket."
+    },
+    "playBeep": {
+      "type": "boolean",
+      "description": "Play a beep before streaming begins."
+    },
+    "disableBidirectionalAudio": {
+      "type": "boolean",
+      "description": "Disable receiving audio from the websocket."
+    },
+    "bidirectionalAudio": {
+      "$ref": "../components/bidirectionalAudio",
+      "description": "Bidirectional audio configuration."
+    },
+    "timeout": {
+      "type": "number",
+      "description": "Inactivity timeout in seconds."
+    },
+    "transcribe": {
+      "$ref": "transcribe",
+      "description": "Nested transcribe verb — enables simultaneous real-time transcription of the streamed audio."
+    },
+    "earlyMedia": {
+      "type": "boolean",
+      "description": "Stream audio before the call is answered."
+    },
+    "channel": {
+      "type": "number",
+      "description": "Specific audio channel to stream. Used when streaming a single channel of a multi-channel call."
+    }
+  },
+  "required": [
+    "url"
+  ],
+  "examples": [
+    {
+      "verb": "stream",
+      "url": "wss://myapp.example.com/audio",
+      "sampleRate": 16000,
+      "mixType": "stereo"
+    }
+  ]
+}

jambonz_sdk/schema/verbs/tag.schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/tag",
+  "minVersion": "0.9.6",
+  "title": "Tag",
+  "description": "Attaches arbitrary metadata to the current call. Tagged data is included in all subsequent webhook requests and in the call detail record (CDR). Useful for tracking business context, routing decisions, or analytics data through the call lifecycle.",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "const": "tag"
+    },
+    "id": {
+      "type": "string",
+      "description": "An optional unique identifier for this verb instance."
+    },
+    "data": {
+      "type": "object",
+      "description": "An object containing the metadata to attach to the call. Keys and values are application-defined.",
+      "additionalProperties": true,
+      "examples": [
+        {
+          "customerId": "12345",
+          "department": "support",
+          "priority": "high"
+        }
+      ]
+    }
+  },
+  "required": [
+    "data"
+  ],
+  "examples": [
+    {
+      "verb": "tag",
+      "data": {
+        "customerId": "12345",
+        "intent": "billing-inquiry"
+      }
+    }
+  ]
+}

jambonz_sdk/schema/verbs/transcribe.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/transcribe",
+  "minVersion": "0.9.6",
+  "title": "Transcribe",
+  "description": "Enables real-time transcription of the call audio. Transcription results are sent to the transcriptionHook as they are produced. Runs as a background process — subsequent verbs execute immediately while transcription continues.",
+  "type": "object",
+  "properties": {
+    "verb": {
+      "const": "transcribe"
+    },
+    "id": {
+      "type": "string",
+      "description": "An optional unique identifier for this verb instance."
+    },
+    "enable": {
+      "type": "boolean",
+      "description": "Enable or disable transcription. Used when transcribe is nested inside a config or dial verb to start or stop background transcription."
+    },
+    "transcriptionHook": {
+      "type": "string",
+      "format": "uri",
+      "description": "The webhook URL to receive transcription results."
+    },
+    "translationHook": {
+      "type": "string",
+      "format": "uri",
+      "description": "The webhook URL to receive translated transcription results."
+    },
+    "recognizer": {
+      "$ref": "../components/recognizer",
+      "description": "STT configuration for the transcription."
+    },
+    "earlyMedia": {
+      "type": "boolean",
+      "description": "If true, begin transcribing before the call is answered."
+    },
+    "channel": {
+      "type": "number",
+      "description": "Specific audio channel to transcribe."
+    }
+  },
+  "examples": [
+    {
+      "verb": "transcribe",
+      "transcriptionHook": "https://myapp.example.com/transcription",
+      "recognizer": {
+        "vendor": "deepgram",
+        "language": "en-US",
+        "deepgramOptions": {
+          "model": "nova-2",
+          "smartFormatting": true
+        }
+      }
+    }
+  ]
+}

jambonz_sdk/schema/verbs/ultravox_s2s.schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://jambonz.org/schema/verbs/ultravox_s2s",
+  "minVersion": "10.1.0",
+  "title": "Ultravox S2S",
+  "description": "Shortcut for 'llm' with vendor automatically set to 'ultravox'. Connects the caller to an Ultravox model for real-time speech-to-speech voice conversation.",
+  "type": "object",
+  "allOf": [
+    {
+      "$ref": "../components/llm-base"
+    }
+  ],
+  "properties": {
+    "verb": {
+      "const": "ultravox_s2s",
+      "description": "The verb name."
+    },
+    "vendor": {
+      "type": "string",
+      "const": "ultravox",
+      "description": "The LLM vendor (always 'ultravox' for this shortcut)."
+    }
+  },
+  "required": [
+    "llmOptions"
+  ],
+  "examples": [
+    {
+      "verb": "ultravox_s2s",
+      "llmOptions": {
+        "messages": [
+          {
+            "role": "system",
+            "content": "You are a helpful voice assistant."
+          }
+        ]
+      },
+      "actionHook": "/s2s-complete"
+    }
+  ]
+}

jambonz_sdk/types/__init__.py

@@ -0,0 +1,139 @@
+"""Type definitions for jambonz SDK."""
+
+from jambonz_sdk.types.components import (
+    ActionHook,
+    ActionHookDelayAction,
+    ActionHookObject,
+    Amd,
+    AmdTimers,
+    Auth,
+    BargeIn,
+    BidirectionalAudio,
+    FillerNoise,
+    FromHeader,
+    LlmBase,
+    McpServer,
+    NoiseIsolation,
+    Recognizer,
+    Synthesizer,
+    Target,
+    TtsStream,
+    TurnTaking,
+    Vad,
+)
+from jambonz_sdk.types.rest import (
+    CallInfo,
+    CallStatus,
+    CreateCallRequest,
+    ListCallsFilter,
+)
+from jambonz_sdk.types.session import (
+    CallDirection,
+    CallSession,
+    WsMessage,
+    WsMessageType,
+)
+from jambonz_sdk.types.verbs import (
+    AlertVerb,
+    AnswerVerb,
+    AnyVerb,
+    ConferenceVerb,
+    ConfigVerb,
+    DeepgramS2sVerb,
+    DequeueVerb,
+    DialogflowVerb,
+    DialVerb,
+    DtmfVerb,
+    DubVerb,
+    ElevenlabsS2sVerb,
+    EnqueueVerb,
+    GatherVerb,
+    GoogleS2sVerb,
+    HangupVerb,
+    LeaveVerb,
+    ListenVerb,
+    LlmVerb,
+    MessageVerb,
+    OpenaiS2sVerb,
+    PauseVerb,
+    PipelineVerb,
+    PlayVerb,
+    RedirectVerb,
+    S2sVerb,
+    SayVerb,
+    SipDeclineVerb,
+    SipReferVerb,
+    SipRequestVerb,
+    StreamVerb,
+    TagVerb,
+    TranscribeVerb,
+    UltravoxS2sVerb,
+)
+
+__all__ = [
+    # Components
+    "ActionHook",
+    "ActionHookDelayAction",
+    "ActionHookObject",
+    "Amd",
+    "AmdTimers",
+    "Auth",
+    "BargeIn",
+    "BidirectionalAudio",
+    "FillerNoise",
+    "FromHeader",
+    "LlmBase",
+    "McpServer",
+    "NoiseIsolation",
+    "Recognizer",
+    "Synthesizer",
+    "Target",
+    "TtsStream",
+    "TurnTaking",
+    "Vad",
+    # Verbs
+    "AlertVerb",
+    "AnswerVerb",
+    "AnyVerb",
+    "ConferenceVerb",
+    "ConfigVerb",
+    "DeepgramS2sVerb",
+    "DequeueVerb",
+    "DialVerb",
+    "DialogflowVerb",
+    "DtmfVerb",
+    "DubVerb",
+    "ElevenlabsS2sVerb",
+    "EnqueueVerb",
+    "GatherVerb",
+    "GoogleS2sVerb",
+    "HangupVerb",
+    "LeaveVerb",
+    "ListenVerb",
+    "LlmVerb",
+    "MessageVerb",
+    "OpenaiS2sVerb",
+    "PauseVerb",
+    "PipelineVerb",
+    "PlayVerb",
+    "RedirectVerb",
+    "S2sVerb",
+    "SayVerb",
+    "SipDeclineVerb",
+    "SipReferVerb",
+    "SipRequestVerb",
+    "StreamVerb",
+    "TagVerb",
+    "TranscribeVerb",
+    "UltravoxS2sVerb",
+    # REST
+    "CallInfo",
+    "CallStatus",
+    "CreateCallRequest",
+    "ListCallsFilter",
+    # Session
+    "CallDirection",
+    "CallSession",
+    "WsMessage",
+    "WsMessageType",
+]