Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
May 2026

​
Week of May 11

​
Bidirectional Stream control events

The <Stream> element now exposes a full set of WebSocket control events for real-time voice agents:
  • playAudio - push buffered audio (l16 or μ-law) back into a live call.
  • clearAudio - drop everything buffered to support barge-in and mid-turn interruption.
  • checkpoint - mark a position in your audio queue and receive a playedStream acknowledgement when it plays out, so you can sync application state with playback.
Together these let you build interruptible AI voice agents that speak, pause, and recover without juggling a separate TTS pipeline.

​
XML Builder

Added an interactive XML Builder for composing Voice XML responses. Pick verbs, reorder them, edit attributes, and copy the generated XML - useful for prototyping IVRs, gather flows, and dial plans before wiring up your webhook.

​
Stream + Record together

You can now combine <Stream> and <Record> in the same response to fork live call audio to your WebSocket while also writing a recording to storage - no separate API call required.

​
Machine Detection (AMD)

Detect whether an answering machine or voicemail box picked up your outbound call - without guessing from call duration. New parameters on POST /Account/{auth_id}/Call/:
ParameterDescription
machine_detection"true" to continue the call on machine detect; "hangup" to disconnect automatically
machine_detection_urlAsync callback URL - Vobiz posts detection results in the background while the call continues
machine_detection_timeAnalysis window in milliseconds (2000–10000, default 5000)
machine_detection_maximum_speech_lengthCap on speech length analyzed (1000–6000 ms)
Two modes are supported:
  • Synchronous - Detection result is included in the call state before your Answer URL is invoked.
  • Asynchronous - Set machine_detection_url to receive a callback mid-call; ideal for long outbound campaigns where you don’t want to delay call setup.
See the Machine Detection guide for the full parameter reference and callback payload.

​
WebRTC & Browser Calling

Added a WebRTC integration guide covering browser-based calling using the Vobiz WebRTC SDK. Includes setup steps for obtaining a token, initializing the client, and handling inbound/outbound audio in the browser. See the WebRTC Application Setup guide.

​
Documentation Launch

The Vobiz developer documentation site launched with full coverage of:
  • Account & Sub-accounts API - Create and manage child accounts under a master account
  • Phone Numbers API - List inventory, purchase numbers, BYOC porting
  • SIP Trunking - Trunks, credentials, IP ACLs, origination URIs, SIP endpoints
  • Call Management - Make, transfer, hangup, queue, and retrieve calls; conference rooms; call recordings
  • Audio Streams - Fork live call audio to a WebSocket server; bidirectional streaming supported
  • Voice XML - Full reference for all XML verbs: Dial, Gather, Speak, Play, Record, Stream, Redirect, Hangup, Wait, PreAnswer, DTMF, Conference
  • WhatsApp Business API - Send and receive messages, manage channels, webhook events
  • CDR & Recordings - Query call detail records, download recordings
  • Partner API - Manage child accounts and billing as a reseller partner
  • AI Platform Integrations - Setup guides for Vapi, Retell AI, ElevenLabs, LiveKit, Pipecat, Bolna, Ultravox, and OpenAI Realtime
  • Official SDKs - Python, Node.js, Ruby, Go, C#

​
April 2026

​
Audio Streams - Bidirectional Mode

The Audio Streams API now supports sending audio back into a live call from your WebSocket server. Set bidirectional=true when starting a stream. Your server can then push raw audio frames into the call - enabling real-time AI voice agents to speak without a separate TTS step. Supported codecs: audio/x-l16 and audio/x-mulaw at 8 kHz or 16 kHz. See Audio Streams for the full API reference and WebSocket frame format.

​
WhatsApp Business API

Vobiz now supports the WhatsApp Business API for outbound and inbound messaging. Key capabilities:
  • Send text, media, templates, and interactive messages
  • Receive inbound messages and status webhooks
  • Manage WhatsApp channels via API or the Vobiz Console
See the WhatsApp getting started guide.

​
March 2026

​
Partner API

Reseller partners can now programmatically create and manage child accounts, configure billing, and view usage across their customer base through the Partner API. The Partner API is disabled by default. Contact support@vobiz.ai to enable it on your account. See the Partner Portal overview.

​
Conference Recording

Recordings can now be started and stopped mid-conference via API, without hanging up or interrupting participants. New endpoints:
  • POST /Conference/{conference_name}/Record/ - Start recording a conference
  • DELETE /Conference/{conference_name}/Record/ - Stop recording
See Conference Recordings.

​
SIP Endpoint Management

Added support for registering and managing SIP endpoints (softphones, IP phones, SIP apps) directly via the API. Endpoints can be associated with trunks and used as origination/termination targets. See SIP Endpoints.