Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.
The Stream object represents an audio stream attached to an active call. It captures the configuration you provided when starting the stream (WebSocket URL, codec, track, bidirectional mode) along with runtime metadata such as status, start time, and end time.
A single call may have multiple concurrent streams. Each stream is identified by a unique stream_id and can be stopped independently.
Attributes
Field
Type
Description
stream_id
string
Unique identifier for the stream. Used in API operations to identify specific streams.
call_uuid
string
The UUID of the call this stream is attached to.
service_url
string
WebSocket URL (wss:// or ws://) to which Vobiz forwards the forked audio.
audio_track
string
Which audio track is being streamed. One of “inbound”, “outbound”, “both”.
bidirectional
boolean
Whether the WebSocket is also allowed to send audio back into the call.
content_type
string
Format used for inbound audio sent to the WebSocket. One of “audio/x-l16;rate=8000”, “audio/x-l16;rate=16000”, or “audio/x-mulaw;rate=8000”. Vobiz reports this format in start.mediaFormat.
sampling_rate
integer
Inbound audio sample rate in Hz, parsed from content_type. One of 8000 or 16000 for L16; μ-law is fixed at 8000.
stream_timeout
integer
Maximum stream duration in seconds. The stream is automatically stopped when this limit is reached.
status_callback_url
string
URL invoked via HTTP POST when the stream status changes (connected, stopped, timeout, failed).
status_callback_method
string
HTTP method used to invoke status_callback_url. One of “GET”, “POST”. Default: “POST”.
status
string
Current status of the stream. One of “in-progress”, “completed”, “failed”.
start_time
string
Timestamp when the stream started (ISO 8601 with timezone).
end_time
string
Timestamp when the stream ended. Null while the stream is still active.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Vobiz","colors":{"primary":"#E83C00","light":"#E86A00","dark":"#c93400"},"logo":{"light":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c","dark":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/dark.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=57b37e5694f01e6933c9ec02a871250a","href":"https://www.vobiz.ai/docs/introduction"},"favicon":"https://mintcdn.com/vobizai/BDRzOqCvIsC8CJvN/favicon.svg?fit=max\u0026auto=format\u0026n=BDRzOqCvIsC8CJvN\u0026q=85\u0026s=b38182f12bc6b0e3a5df2a8ae1474f83","api":{"openapi":["openapi.yaml","openapi-sms.yaml","openapi-whatsapp.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true},"mdx":{"auth":{"method":"key","name":"X-Auth-Token"},"server":"https://api.vobiz.ai"}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:support@vobiz.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.vobiz.ai"}},"footer":{"socials":{"x":"https://x.com/Vobiz_Ai","github":"https://github.com/vobiz-ai","linkedin":"https://linkedin.com/company/vobizai"}},"seo":{"metatags":{"canonical":"https://www.vobiz.ai/docs","og:site_name":"Vobiz Docs","og:type":"website","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@Vobiz_Ai","twitter:creator":"@Vobiz_Ai","theme-color":"#E83C00","color-scheme":"dark light","author":"Vobiz","publisher":"Vobiz","copyright":"Copyright 2025 Vobiz","reply-to":"support@vobiz.ai","robots":"index, follow","format-detection":"telephone=no","referrer":"origin-when-cross-origin","rating":"general","language":"en","category":"Technology","coverage":"Worldwide","distribution":"global","target":"all"},"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-YD6M3FF3P4"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"markdown":{"schema":true},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vobizai","hasAudioNarration":false,"actualSubdomain":"vobizai","customDomains":["www.vobiz.ai"],"gitSource":{"type":"github","owner":"vobiz-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae8948acb9fa025302af88e"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b00db3c4dbe5d10f9185131","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":386},{"language":"default","tag":"Voice \u0026 XML","count":119},{"language":"default","tag":"Documentation","count":99},{"language":"default","tag":"SMS \u0026 RCS","count":92},{"language":"default","tag":"Blogs","count":82},{"language":"default","tag":"Articles","count":80},{"language":"default","tag":"Integrations","count":79},{"language":"default","tag":"Examples \u0026 Tutorials","count":59},{"language":"default","tag":"Regular APIs","count":40},{"language":"default","tag":"SIP Trunking","count":32}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@vobiz.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/docs/_mintlify/custom/vobizai/c4c76a1b5bc930af/custom.css"}]}
{"page":{"pagePath":"audio-streams/stream-object","slug":"/audio-streams/stream-object","pageMetadata":{"title":"The Stream Object","sidebarTitle":"Stream Object","description":"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.","keywords":["stream object","stream_id field","stream_url attribute","track field stream","codec attribute","bidirectional flag","stream status","stream start time","stream end time","Vobiz stream schema","stream data model","audio stream fields","stream configuration object","WebSocket URL field","stream metadata model","stream object attributes","stream object schema India","developer stream object","audio stream structure","stream_id unique identifier"],"href":"/audio-streams/stream-object"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Stream object represents an audio stream attached to an active call. It captures the configuration you provided when starting the stream (WebSocket URL, codec, track, bidirectional mode) along with runtime metadata such as status, start time, and end time.`}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`A single call may have multiple concurrent streams. Each stream is identified by a unique `,_jsx(_components.code,{children:`stream_id`}),` and can be stopped independently.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`attributes`,children:`Attributes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stream_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Unique identifier for the stream. Used in API operations to identify specific streams.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`call_uuid`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The UUID of the call this stream is attached to.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`service_url`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`WebSocket URL (wss:// or ws://) to which Vobiz forwards the forked audio.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`audio_track`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Which audio track is being streamed. One of “inbound”, “outbound”, “both”.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`bidirectional`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`Whether the WebSocket is also allowed to send audio back into the call.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`content_type`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Format used for inbound audio sent to the WebSocket. One of “audio/x-l16;rate=8000”, “audio/x-l16;rate=16000”, or “audio/x-mulaw;rate=8000”. Vobiz reports this format in `,_jsx(_components.code,{children:`start.mediaFormat`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sampling_rate`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[`Inbound audio sample rate in Hz, parsed from `,_jsx(_components.code,{children:`content_type`}),`. One of 8000 or 16000 for L16; μ-law is fixed at 8000.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stream_timeout`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`Maximum stream duration in seconds. The stream is automatically stopped when this limit is reached.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status_callback_url`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`URL invoked via HTTP POST when the stream status changes (connected, stopped, timeout, failed).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status_callback_method`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`HTTP method used to invoke status_callback_url. One of “GET”, “POST”. Default: “POST”.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`status`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Current status of the stream. One of “in-progress”, “completed”, “failed”.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`start_time`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Timestamp when the stream started (ISO 8601 with timezone).`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`end_time`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Timestamp when the stream ended. Null while the stream is still active.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`resource_uri`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Relative URI of this Stream resource.`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:`Stream Object`,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"api_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"15b27100-1231-11ee-b875-0242ac110003\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"call_uuid\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"6e558798-499c-4a68-bc77-46f2c53d1f69\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stream_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2b1b3f8e-4c9a-4f2a-9e2d-7f9d0b1c2a34\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"service_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"wss://example.com/audio-stream\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"audio_track\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"inbound\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"bidirectional\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"content_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"audio/x-l16\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"sampling_rate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`8000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"stream_timeout\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`86400`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_callback_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/stream-status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status_callback_method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"in-progress\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"start_time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-11-06 13:49:10+00:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"end_time\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"resource_uri\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/Account/MA_XXXXXXXX/Call/6e558798-499c-4a68-bc77-46f2c53d1f69/Stream/2b1b3f8e-4c9a-4f2a-9e2d-7f9d0b1c2a34/\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"The Stream Object","sidebarTitle":"Stream Object","description":"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.","keywords":["stream object","stream_id field","stream_url attribute","track field stream","codec attribute","bidirectional flag","stream status","stream start time","stream end time","Vobiz stream schema","stream data model","audio stream fields","stream configuration object","WebSocket URL field","stream metadata model","stream object attributes","stream object schema India","developer stream object","audio stream structure","stream_id unique identifier"],"href":"/audio-streams/stream-object"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Attributes","slug":"attributes","depth":2,"children":[]},{"title":"Example","slug":"example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/vobizai/478834ae2c200a0e/blog-schema.js","/docs/_mintlify/custom/vobizai/13b0cd7ec6e39877/anchor-link-text.js"],"subdomain":"vobizai","siteName":"Vobiz","title":"The Stream Object - Vobiz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T20:13:57.298Z","originalFileLocation":"audio-streams/stream-object.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"The Stream Object - Vobiz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vobiz Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.vobiz.ai/docs/audio-streams/stream-object\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=Audio+Streams\u0026amp;title=The+Stream+Object\u0026amp;description=Understand+every+field+on+the+Vobiz+audio+Stream+object%3A+stream+ID%2C+status%2C+codec%2C+track+direction%2C+WebSocket+URL%2C+bidirectional+mode%2C+and+start%2Fend+timestamps.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=595105dc3d9521b1429bbda02c6848ecc0dfe99985237b9772782306d3cf96ad\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"The Stream Object - Vobiz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=Audio+Streams\u0026amp;title=The+Stream+Object\u0026amp;description=Understand+every+field+on+the+Vobiz+audio+Stream+object%3A+stream+ID%2C+status%2C+codec%2C+track+direction%2C+WebSocket+URL%2C+bidirectional+mode%2C+and+start%2Fend+timestamps.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=595105dc3d9521b1429bbda02c6848ecc0dfe99985237b9772782306d3cf96ad\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@Vobiz_Ai\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"dark light\">\u003cmeta data-mint-head name=\"author\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"publisher\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"copyright\" content=\"Copyright 2025 Vobiz\">\u003cmeta data-mint-head name=\"reply-to\" content=\"support@vobiz.ai\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin-when-cross-origin\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"category\" content=\"Technology\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"target\" content=\"all\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.vobiz.ai/docs/audio-streams/stream-object\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/audio-streams/stream-object.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.vobiz.ai/#organization\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.vobiz.ai/docs#website\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai/docs\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.vobiz.ai/docs/audio-streams/stream-object#webpage\",\"url\":\"https://www.vobiz.ai/docs/audio-streams/stream-object\",\"name\":\"The Stream Object\",\"description\":\"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\",\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.vobiz.ai/docs/audio-streams/stream-object#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.vobiz.ai/docs/audio-streams/stream-object#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Audio Streams\",\"item\":\"https://www.vobiz.ai/docs/audio-streams\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"The Stream Object\",\"item\":\"https://www.vobiz.ai/docs/audio-streams/stream-object\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.vobiz.ai/docs/audio-streams/stream-object#article\",\"headline\":\"The Stream Object\",\"name\":\"The Stream Object\",\"description\":\"Understand every field on the Vobiz audio Stream object: stream ID, status, codec, track direction, WebSocket URL, bidirectional mode, and start/end timestamps.\",\"url\":\"https://www.vobiz.ai/docs/audio-streams/stream-object\",\"mainEntityOfPage\":{\"@id\":\"https://www.vobiz.ai/docs/audio-streams/stream-object#webpage\"},\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"keywords\":\"stream object, stream_id field, stream_url attribute, track field stream, codec attribute, bidirectional flag, stream status, stream start time, stream end time, Vobiz stream schema, stream data model, audio stream fields, stream configuration object, WebSocket URL field, stream metadata model, stream object attributes, stream object schema India, developer stream object, audio stream structure, stream_id unique identifier\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vobiz\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vobiz\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/audio-streams/stream-object.md","siteName":"Vobiz","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","anchors":[{"anchor":"Regular APIs","icon":"database","pages":[{"title":"Regular APIs","href":"/account"}]},{"anchor":"SIP Trunking","icon":"network-wired","pages":[{"title":"SIP Trunking","href":"/trunks"}]},{"anchor":"Voice \u0026 XML","icon":"microphone","groups":[{"group":"Applications","icon":"grid-2","root":{"title":"Vobiz Applications API","sidebarTitle":"Applications","href":"/applications"},"pages":[{"title":"The Application Object","sidebarTitle":"Application Object","href":"/applications/application-object"},{"title":"Create an Application","sidebarTitle":"Create Application","openapi":"POST /api/v1/Account/{auth_id}/Application/","href":"/applications/create-application"},{"title":"Retrieve an Application","sidebarTitle":"Retrieve Application","openapi":"GET /api/v1/Account/{auth_id}/Application/{app_id}/","href":"/applications/retrieve-application"},{"title":"Update an Application","sidebarTitle":"Update Application","openapi":"POST /api/v1/Account/{auth_id}/Application/{app_id}/","href":"/applications/update-application"},{"title":"Delete an Application","sidebarTitle":"Delete Application","openapi":"DELETE /api/v1/Account/{auth_id}/Application/{app_id}/","href":"/applications/delete-application"},{"title":"List All Applications","sidebarTitle":"List Applications","openapi":"GET /api/v1/Account/{auth_id}/Application/","href":"/applications/list-all-applications"},{"title":"Attach Number to Application","sidebarTitle":"Attach Number","api":"POST /api/v1/Account/{auth_id}/numbers/{number}/application","href":"/applications/attach-number"},{"title":"Detach Number from Application","sidebarTitle":"Detach Number","api":"DELETE /api/v1/Account/{auth_id}/numbers/{number}/application","href":"/applications/detach-number"}]},{"group":"Endpoints","icon":"plug","root":{"title":"Vobiz Endpoint API","href":"/endpoint"},"pages":[{"title":"The Endpoint Object","sidebarTitle":"Endpoint Object","href":"/endpoint/endpoint-object"},{"title":"Create an Endpoint","sidebarTitle":"Create Endpoint","openapi":"POST /api/v1/Account/{auth_id}/Endpoint/","href":"/endpoint/create-endpoint"},{"title":"Retrieve an Endpoint","sidebarTitle":"Retrieve Endpoint","openapi":"GET /api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/","href":"/endpoint/retrieve-endpoint"},{"title":"Update an Endpoint","sidebarTitle":"Update Endpoint","openapi":"POST /api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/","href":"/endpoint/update-endpoint"},{"title":"Delete an Endpoint","sidebarTitle":"Delete Endpoint","openapi":"DELETE /api/v1/Account/{auth_id}/Endpoint/{endpoint_id}/","href":"/endpoint/delete-endpoint"},{"title":"List all endpoints","sidebarTitle":"List Endpoints","openapi":"GET /api/v1/Account/{auth_id}/Endpoint/","href":"/endpoint/list-all-endpoints"}]},{"group":"Call Management","icon":"phone-arrow-up-right","root":{"title":"Call Management Overview","href":"/call/overview"},"pages":[{"title":"The Call Object","sidebarTitle":"Call Object","href":"/call/call-object"},{"openapi":"POST /api/v1/Account/{auth_id}/Call/","title":"Make an Outbound Call","href":"/call/make-call"},{"title":"Machine Detection (Call API)","sidebarTitle":"Machine Detection","href":"/call/machine-detection"},{"title":"Transfer a Call (Call API)","sidebarTitle":"Transfer Call","api":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/","href":"/call/transfer-call"},{"title":"Hang Up a Call","sidebarTitle":"Hang Up Call","api":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/","href":"/call/hangup-call"},{"openapi":"GET /api/v1/Account/{auth_id}/Call/{call_uuid}","title":"Retrieve a live call","href":"/call/retrieve-live-call"},{"openapi":"GET /api/v1/Account/{auth_id}/Call","title":"Retrieve all live calls","href":"/call/retrieve-all-live-calls"},{"title":"Retrieve a queued call","sidebarTitle":"Get Queued Call","openapi":"GET /api/v1/Account/{auth_id}/Call/{call_uuid}/","href":"/call/retrieve-queued-call"},{"title":"Retrieve all queued calls","sidebarTitle":"List Queued Calls","openapi":"GET /api/v1/Account/{auth_id}/Call/","href":"/call/retrieve-all-queued-calls"},{"group":"Record calls","icon":"circle-dot","root":{"title":"Record calls","href":"/call/record-calls"},"pages":[{"openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/Record/","title":"Start recording a call","href":"/call/record-calls/start-recording"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/Record/","title":"Stop recording a call","href":"/call/record-calls/stop-recording"}]},{"group":"Play audio","icon":"play","root":{"title":"Play audio on calls","href":"/call/play-audio"},"pages":[{"openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/Play/","title":"Play audio on a call","href":"/call/play-audio/play-audio"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/Play/","title":"Stop playing audio on a call","href":"/call/play-audio/stop-audio"}]},{"group":"Speak text","icon":"microphone-lines","root":{"title":"Speak text on calls","href":"/call/speak-text"},"pages":[{"openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/","title":"Speak text on a call","href":"/call/speak-text/speak-text"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/Speak/","title":"Stop speaking text during a call","href":"/call/speak-text/stop-speak"}]},{"group":"DTMF","icon":"keyboard","root":{"openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/","title":"DTMF","href":"/call/dtmf"},"pages":[{"title":"Send digits on an active call","sidebarTitle":"Send Digits","openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/DTMF/","href":"/call/dtmf/send-digits"}]}]},{"group":"Conferences","icon":"users","root":{"title":"The Conference Object","href":"/conference/conference-object"},"pages":[{"openapi":"GET /api/v1/Account/{auth_id}/Conference/{conference_name}/","title":"Retrieve a Conference","href":"/conference/retrieve-conference"},{"openapi":"GET /api/v1/Account/{auth_id}/Conference/","title":"List All Conferences","href":"/conference/retrieve-all-conferences"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/","title":"Hang Up a Conference","href":"/conference/hang-up-conference"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/","title":"Hang Up All Conferences","href":"/conference/hang-up-all-conferences"},{"group":"Conference Members","icon":"user-group","pages":[{"title":"Conference Members","href":"/conference/members"},{"openapi":"POST /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/","title":"Play Audio to a Member","href":"/conference/members/play-audio"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Play/","title":"Stop Playing Audio to a Member","href":"/conference/members/stop-audio"},{"openapi":"POST /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/","title":"Deaf a Member","href":"/conference/members/deaf-member"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Deaf/","title":"Undeaf a Member","href":"/conference/members/undeaf-member"},{"openapi":"POST /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/","title":"Mute a Member","href":"/conference/members/mute-member"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Mute/","title":"Unmute a member","href":"/conference/members/unmute-member"},{"openapi":"POST /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/Kick/","title":"Kick a member","href":"/conference/members/kick-member"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/Member/{member_id}/","title":"Hang up a member","href":"/conference/members/hang-up-member"}]},{"group":"Conference Recording","icon":"record-vinyl","pages":[{"title":"Conference recording","href":"/conference/recording"},{"openapi":"POST /api/v1/Account/{auth_id}/Conference/{conference_name}/Record/","title":"Start conference recording","href":"/conference/recording/start-recording"},{"openapi":"DELETE /api/v1/Account/{auth_id}/Conference/{conference_name}/Record/","title":"Stop conference recording","href":"/conference/recording/stop-recording"}]}]},{"group":"Audio Streams","icon":"radio","root":{"title":"Vobiz Audio Streams API: Real-Time Call Audio","sidebarTitle":"Audio Streams","description":"Fork live call audio to a WebSocket server in real time with the Vobiz Audio Streams API - for AI voice agents, transcription, and sentiment analysis.","href":"/audio-streams"},"pages":[{"title":"The Stream Object","sidebarTitle":"Stream Object","href":"/audio-streams/stream-object"},{"title":"Start an Audio Stream","sidebarTitle":"Start Stream","openapi":"POST /api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/","description":"Fork live call audio over a WebSocket connection to your AI pipeline in near real time - configure codec, track direction, and bidirectional mode per stream.","href":"/audio-streams/start-audio-stream"},{"title":"Retrieve an Audio Stream","sidebarTitle":"Retrieve Stream","openapi":"GET /api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/","href":"/audio-streams/retrieve-audio-stream"},{"title":"List all Audio Streams","sidebarTitle":"List Streams","openapi":"GET /api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/","href":"/audio-streams/list-audio-streams"},{"title":"Stop a Specific Audio Stream","sidebarTitle":"Stop Stream","openapi":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/","href":"/audio-streams/stop-audio-stream"},{"title":"Stop all Audio Streams","sidebarTitle":"Stop All Streams","api":"DELETE /api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/","href":"/audio-streams/stop-all-audio-streams"}]},{"group":"Voice Campaign Manager","icon":"bullhorn","root":{"title":"Campaign Manager API Overview","sidebarTitle":"Overview","href":"/campaign-manager/overview"},"pages":[{"title":"Campaign API authentication","sidebarTitle":"Authentication","href":"/campaign-manager/authentication"},{"group":"Agents","icon":"user-gear","pages":[{"api":"POST /api/v1/account/{account_id}/campaign/agents","title":"Create a campaign agent","sidebarTitle":"Create an agent","href":"/campaign-manager/agents/create-agent"},{"api":"GET /api/v1/account/{account_id}/campaign/agents","title":"List campaign agents","sidebarTitle":"List agents","href":"/campaign-manager/agents/list-agents"},{"api":"GET /api/v1/account/{account_id}/campaign/agents/{agent_id}","title":"Retrieve a campaign agent","sidebarTitle":"Retrieve an agent","href":"/campaign-manager/agents/retrieve-agent"},{"api":"PUT /api/v1/account/{account_id}/campaign/agents/{agent_id}","title":"Update a campaign agent","sidebarTitle":"Update an agent","href":"/campaign-manager/agents/update-agent"},{"api":"DELETE /api/v1/account/{account_id}/campaign/agents/{agent_id}","title":"Delete a campaign agent","sidebarTitle":"Delete an agent","href":"/campaign-manager/agents/delete-agent"}]},{"group":"Campaigns","icon":"bullhorn","pages":[{"api":"POST /api/v1/account/{account_id}/campaigns","title":"Campaign Manager: Create a Campaign","sidebarTitle":"Create a campaign","href":"/campaign-manager/campaigns/create-campaign"},{"api":"GET /api/v1/account/{account_id}/campaigns","title":"Campaign Manager: List Campaigns","sidebarTitle":"List campaigns","href":"/campaign-manager/campaigns/list-campaigns"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}","title":"Campaign Manager: Retrieve a Campaign","sidebarTitle":"Retrieve a campaign","href":"/campaign-manager/campaigns/retrieve-campaign"},{"api":"PUT /api/v1/account/{account_id}/campaigns/{campaign_id}","title":"Campaign Manager: Update a Campaign","sidebarTitle":"Update a campaign","href":"/campaign-manager/campaigns/update-campaign"}]},{"group":"Lifecycle controls","icon":"sliders","pages":[{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/start","title":"Start a campaign","sidebarTitle":"Start","href":"/campaign-manager/controls/start-campaign"},{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/pause","title":"Pause a campaign","sidebarTitle":"Pause","href":"/campaign-manager/controls/pause-campaign"},{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/resume","title":"Resume a campaign","sidebarTitle":"Resume","href":"/campaign-manager/controls/resume-campaign"},{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/cancel","title":"Cancel a campaign","sidebarTitle":"Cancel","href":"/campaign-manager/controls/cancel-campaign"},{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/archive","title":"Archive a campaign","sidebarTitle":"Archive","href":"/campaign-manager/controls/archive-campaign"}]},{"group":"Contacts and results","icon":"address-book","pages":[{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/upload","title":"Upload campaign contacts","sidebarTitle":"Upload contacts","href":"/campaign-manager/contacts/upload-contacts"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}/contacts","title":"List campaign contacts","sidebarTitle":"List contacts","href":"/campaign-manager/contacts/list-contacts"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}/calls","title":"List campaign call attempts","sidebarTitle":"List call attempts","href":"/campaign-manager/contacts/list-calls"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}/results","title":"Download campaign results","sidebarTitle":"Download results","href":"/campaign-manager/contacts/download-results"}]},{"group":"Caller-ID pool","icon":"phone","pages":[{"api":"POST /api/v1/account/{account_id}/campaigns/{campaign_id}/pool","title":"Add caller pool numbers","sidebarTitle":"Add pool numbers","href":"/campaign-manager/caller-pool/add-pool-numbers"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}/pool","title":"List caller pool numbers","sidebarTitle":"List pool numbers","href":"/campaign-manager/caller-pool/list-pool-numbers"},{"api":"PUT /api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}","title":"Update a caller pool number","sidebarTitle":"Update pool number","href":"/campaign-manager/caller-pool/update-pool-number"},{"api":"DELETE /api/v1/account/{account_id}/campaigns/{campaign_id}/pool/{number_id}","title":"Remove a caller pool number","sidebarTitle":"Remove pool number","href":"/campaign-manager/caller-pool/delete-pool-number"}]},{"group":"Capacity and lookup","icon":"gauge-high","pages":[{"api":"GET /api/v1/account/{account_id}/capacity","title":"Get account capacity","sidebarTitle":"Account capacity","href":"/campaign-manager/capacity/account-capacity"},{"api":"GET /api/v1/account/{account_id}/campaigns/{campaign_id}/call-lookup/{call_uuid}","title":"Look up a campaign call","sidebarTitle":"Call lookup","href":"/campaign-manager/capacity/call-lookup"}]},{"title":"Campaign webhook events","sidebarTitle":"Webhook events","href":"/campaign-manager/webhooks"}]},{"group":"XML Overview","icon":"file-code","pages":[{"title":"How VobizXML Works: Event-Driven Call Flows","sidebarTitle":"How XML Works","href":"/xml/overview/how-it-works"},{"title":"Getting Started with VobizXML: Build Your First App","sidebarTitle":"Getting Started with XML","href":"/xml/overview/getting-started"},{"title":"VobizXML Best Practices for Reliable Voice Apps","sidebarTitle":"XML Best Practices","href":"/xml/overview/best-practices"}]},{"group":"Stream","icon":"wave-square","root":{"title":"Stream XML Element: Real-Time WebSocket Audio","sidebarTitle":"Stream","href":"/xml/stream"},"pages":[{"title":"Audio formats: 8, 16, and 24 kHz","sidebarTitle":"8, 16, and 24 kHz","href":"/xml/stream/audio-formats"},{"title":"Initiate a WebSocket Audio Stream — Stream XML How-To","href":"/xml/stream/initiate"},{"title":"Stream Events — Playback, Checkpoints \u0026 Interruption","href":"/xml/stream/stream-events"},{"title":"Checkpoint Event — Custom WebSocket Marker Mid-Stream","href":"/xml/stream/checkpoint-event"},{"title":"Clear Audio Stream — Stop Injected Audio Mid-Call","href":"/xml/stream/clear-audio"},{"title":"DTMF in Audio Streams — Receive Keypresses and Send Digits","href":"/xml/stream/dtmf"},{"title":"Play Audio Event — Inject Audio into a WebSocket Stream","href":"/xml/stream/play-audio"},{"title":"Stop Event — WebSocket Signal When Audio Stream Ends","href":"/xml/stream/stop-event"}]},{"group":"Dial","icon":"phone-volume","root":{"title":"Dial XML Element — Connect to Phone Numbers, SIP and Users","sidebarTitle":"Dial","href":"/xml/dial"},"pages":[{"title":"Number XML Element — Dial to PSTN Phone Number","sidebarTitle":"Number","href":"/xml/dial/number"},{"title":"User XML Element — Dial to SIP Endpoint or Registered App","sidebarTitle":"User","href":"/xml/dial/user"},{"title":"Sequential Dialing — Try Numbers in Order with Dial XML","href":"/xml/dial/sequential-dialing"},{"title":"Simultaneous Dialing — Ring Multiple Numbers with Dial XML","href":"/xml/dial/simultaneous-dialing"},{"title":"Dial Answer Confirmation — Require a Keypress to Connect","sidebarTitle":"Confirm to answer","href":"/xml/dial/confirm-to-answer-call"},{"title":"Custom Caller Tone — Override Ringback Sound for Dial XML","href":"/xml/dial/custom-caller-tone"},{"title":"Dial Status Reporting — Track Outbound Leg Outcomes","href":"/xml/dial/dial-status-reporting"},{"title":"Transferred Call Flow End to End — Dial XML Reference","sidebarTitle":"Transferred calls","href":"/xml/dial/transferred-calls"}]},{"group":"Gather","icon":"ear-listen","root":{"title":"Gather XML Element: DTMF \u0026 Speech Input","sidebarTitle":"Gather","href":"/xml/gather"},"pages":[{"title":"Detecting Speech Inputs — Gather XML Voice Recognition Config","href":"/xml/gather/detecting-speech-inputs"},{"title":"Speech Recognition Pricing — Gather XML Transcription Costs","href":"/xml/gather/pricing-for-speech-recognition"},{"title":"Supported Languages — Gather XML Speech Recognition","href":"/xml/gather/supported-languages"}]},{"group":"Speak","icon":"microphone-lines","root":{"title":"Speak XML Element: Text-to-Speech on Live Calls","sidebarTitle":"Speak","href":"/xml/speak"},"pages":[{"title":"Play a TTS Message — Speak XML Example","href":"/xml/speak/play-a-message"},{"title":"Play Audio in a Loop — Speak XML Loop Attribute Example","href":"/xml/speak/play-in-a-loop"},{"title":"SSML in Vobiz Speak XML — Speech Synthesis Markup Reference","href":"/xml/speak/ssml"}]},{"group":"Play","icon":"play","root":{"title":"Play XML Element: Play Audio Files to Callers","sidebarTitle":"Play","href":"/xml/play"},"pages":[{"title":"Play Hold Music — Play XML Audio File Example","href":"/xml/play/play-music"}]},{"group":"Record","icon":"record-vinyl","root":{"title":"Record XML Element: Call \u0026 Conference Recording","sidebarTitle":"Record","href":"/xml/record"},"pages":[{"title":"Record a Voicemail — Capture Voice Messages with Record XML","href":"/xml/record/record-a-voicemail"},{"title":"Stream with Simultaneous Recording — WebSocket + Record XML","href":"/xml/record/stream-with-record"}]},{"group":"Redirect","icon":"share","root":{"title":"Redirect XML Element: Dynamic Call Flow Routing","sidebarTitle":"Redirect","href":"/xml/redirect"},"pages":[{"title":"Transfer a Call with Redirect XML","sidebarTitle":"Transfer a call","href":"/xml/redirect/transfer-a-call"}]},{"group":"Hangup","icon":"phone-slash","root":{"title":"Hangup XML Element: End or Reject Calls","sidebarTitle":"Hangup","href":"/xml/hangup"},"pages":[{"title":"Hang Up Call After N Seconds — Hangup XML Timer Pattern","href":"/xml/hangup/hang-up-after-a-minute"}]},{"group":"Wait","icon":"clock","root":{"title":"Wait XML Element: Pauses \u0026 Machine Detection","sidebarTitle":"Wait","href":"/xml/wait"},"pages":[{"title":"Basic Wait — Insert Silence or Pause in a Call Flow","href":"/xml/wait/basic-wait"},{"title":"Beep Detection — Detect Voicemail Beep After AMD","href":"/xml/wait/beep-detection"},{"title":"Delayed Call Answer — Ring Without Bridging Immediately","href":"/xml/wait/delayed-call-answer"},{"title":"Machine Detection with Wait XML","sidebarTitle":"Machine detection","href":"/xml/wait/machine-detection"}]},{"group":"PreAnswer","icon":"bell","root":{"title":"PreAnswer XML Element: Early Media Before Answer","sidebarTitle":"PreAnswer","href":"/xml/preanswer"},"pages":[{"title":"Notify Callers Before Answering — PreAnswer XML Pattern","href":"/xml/preanswer/notify-callers"}]},{"group":"Conference","icon":"users-rectangle","root":{"title":"Conference XML Element: Multi-Party Call Rooms","sidebarTitle":"Conference","href":"/xml/conference"},"pages":[{"title":"Conference Attributes — All Conference XML Options Reference","href":"/xml/conference/attributes"},{"title":"Conference Callbacks — Webhooks for Join, Leave \u0026 End Events","href":"/xml/conference/conference-callbacks"}]},{"group":"Request","icon":"arrow-right-to-bracket","root":{"title":"VobizXML Request: Webhook Parameters \u0026 Call Payload","sidebarTitle":"XML Request","href":"/xml/request"},"pages":[{"title":"Call Status Reference — Vobiz Call State Values Explained","href":"/xml/request/call-status"},{"title":"Event XML Element — Trigger Webhooks Mid-Call Flow","href":"/xml/request/event"},{"title":"SIP Headers in VobizXML — Pass Custom Data via X-Header","href":"/xml/request/sip-headers"}]},{"group":"Response \u0026 DTMF","icon":"keyboard","root":{"title":"Response XML Element: Root of Call Instructions","sidebarTitle":"Response","href":"/xml/response"},"pages":[{"title":"DTMF XML Element: Send Tones on Live Calls","sidebarTitle":"DTMF","href":"/xml/dtmf"}]}]},{"anchor":"SMS \u0026 RCS","icon":"comment-sms","pages":[{"title":"SMS \u0026 RCS","href":"/sms/overview"}]},{"anchor":"WhatsApp","icon":"comment-dots","pages":[{"title":"WhatsApp","href":"/whatsapp/getting-started/introduction"}]},{"anchor":"Partner API","icon":"handshake","pages":[{"title":"Partner API","href":"/partner"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Examples \u0026 Tutorials","pages":[{"title":"Examples \u0026 Tutorials","href":"/guides/ai-voice-agent"}]},{"tab":"Blogs","pages":[{"title":"Blogs","href":"/blogs"}]}]},"basePath":"","title":"The Stream Object - Vobiz","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}