Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.
Was this page helpful?
⌘I
{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":"resources/stream-events-visualizer","slug":"/resources/stream-events-visualizer","pageMetadata":{"title":"Stream Events Visualizer","sidebarTitle":"Stream Events Visualizer","description":"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.","keywords":["Vobiz Stream Events visualizer","WebSocket event visualizer","playAudio visualizer","clearAudio barge-in","checkpoint playedStream","dtmf sendDTMF stream","Vobiz bidirectional stream","voice agent WebSocket flow","Stream event playground"],"mode":"wide","href":"/resources/stream-events-visualizer"},"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: \"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const StreamEventsVisualizer=()=>{const _components={a:`a`,..._provideComponents()};const[currentIndex,setCurrentIndex]=React.useState(0);const[delivered,setDelivered]=React.useState([]);const[activeIndex,setActiveIndex]=React.useState(null);const[isAnimating,setIsAnimating]=React.useState(false);const timerRef=React.useRef(null);const Payload=EventPayload;const nextStep=STREAM_FLOW[currentIndex];const activeStep=activeIndex===null?null:STREAM_FLOW[activeIndex];const isComplete=currentIndex>=STREAM_FLOW.length;React.useEffect(()=>()=>{if(timerRef.current!==null)window.clearTimeout(timerRef.current)},[]);const receivedByApp=React.useMemo(()=>{const index=[...delivered].reverse().find(item=>STREAM_FLOW[item].receiver===`app`);return index===undefined?null:STREAM_FLOW[index]},[delivered]);const receivedByVobiz=React.useMemo(()=>{const index=[...delivered].reverse().find(item=>STREAM_FLOW[item].receiver===`vobiz`);return index===undefined?null:STREAM_FLOW[index]},[delivered]);const visibleHistory=delivered.slice(-5).map(index=>({index,step:STREAM_FLOW[index]}));const hiddenHistoryCount=Math.max(0,delivered.length-visibleHistory.length);const connectionState=delivered.includes(STREAM_FLOW.length-1)?`closed`:delivered.includes(STREAM_FLOW.length-2)?`stopping`:delivered.includes(0)?`connected`:`waiting`;const runNext=actor=>{if(!nextStep||nextStep.sender!==actor||isAnimating)return;const stepIndex=currentIndex;const reduceMotion=window.matchMedia?.(`(prefers-reduced-motion: reduce)`).matches;setActiveIndex(stepIndex);setIsAnimating(true);timerRef.current=window.setTimeout(()=>{setDelivered(items=>[...items,stepIndex]);setCurrentIndex(index=>index+1);setActiveIndex(null);setIsAnimating(false);timerRef.current=null},reduceMotion?60:760)};const replay=()=>{if(timerRef.current!==null)window.clearTimeout(timerRef.current);timerRef.current=null;setCurrentIndex(0);setDelivered([]);setActiveIndex(null);setIsAnimating(false)};const actorButton=actor=>{const isTurn=nextStep?.sender===actor;const otherActor=actor===`vobiz`?`Application`:`Vobiz`;const label=isComplete?`Flow complete`:isTurn?nextStep.buttonLabel:`Waiting for ${otherActor}`;return _jsxs(`button`,{type:`button`,className:`sev-send-button ${isTurn?`is-ready`:``}`,onClick:()=>runNext(actor),disabled:!isTurn||isAnimating,children:[_jsx(`span`,{className:`sev-button-signal`,\"aria-hidden\":`true`,children:isTurn?`●`:`○`}),_jsx(`span`,{children:label}),_jsx(`span`,{\"aria-hidden\":`true`,children:isTurn?actor===`vobiz`?`→`:`←`:``})]})};const railDirection=activeStep?.sender===`app`||!activeStep\u0026\u0026nextStep?.sender===`app`?`app-to-vobiz`:`vobiz-to-app`;return _jsx(`div`,{className:`stream-events-visualizer not-prose`,children:_jsxs(`main`,{className:`sev-shell`,children:[_jsxs(`section`,{className:`sev-intro`,children:[_jsxs(`div`,{children:[_jsx(`p`,{className:`sev-eyebrow`,children:`Interactive WebSocket sequence`}),_jsx(`h1`,{children:`See every Stream event move between Vobiz and your application.`}),_jsx(`p`,{className:`sev-lede`,children:`Click the highlighted sender. Follow each JSON packet across the WebSocket, inspect what the receiver gets, and see how barge-in, keypresses, and stream shutdown behave.`})]}),_jsxs(`div`,{className:`sev-prerequisites`,\"aria-label\":`Stream prerequisites`,children:[_jsx(`span`,{children:`✓ bidirectional=\"true\"`}),_jsx(`span`,{children:`✓ Active WSS`}),_jsx(`span`,{children:`✓ JSON messages`})]})]}),_jsxs(`section`,{className:`sev-workbench`,\"aria-label\":`Interactive Stream event sequence`,children:[_jsxs(`div`,{className:`sev-progress-strip`,children:[_jsxs(`div`,{className:`sev-progress-copy`,children:[_jsx(`span`,{children:isComplete?`Sequence complete`:`Next step ${currentIndex+1}`}),_jsxs(`strong`,{children:[delivered.length,` of `,STREAM_FLOW.length,` delivered`]})]}),_jsx(`div`,{className:`sev-progress-track`,role:`progressbar`,\"aria-label\":`Sequence progress`,\"aria-valuemin\":`0`,\"aria-valuemax\":STREAM_FLOW.length,\"aria-valuenow\":delivered.length,children:_jsx(`div`,{className:`sev-progress-value`,style:{width:`${delivered.length/STREAM_FLOW.length*100}%`}})})]}),_jsxs(`div`,{className:`sev-workbench-grid`,children:[_jsxs(`article`,{className:`sev-actor sev-actor-vobiz`,children:[_jsxs(`div`,{className:`sev-actor-heading`,children:[_jsx(`div`,{className:`sev-actor-icon sev-vobiz-icon`,\"aria-hidden\":`true`,children:_jsx(`img`,{src:`/docs/favicon.svg`,alt:``})}),_jsxs(`div`,{children:[_jsx(`span`,{children:`Telephony platform`}),_jsx(`h2`,{children:`Vobiz`})]})]}),_jsx(`p`,{className:`sev-actor-description`,children:`Opens the stream, sends caller audio, plays queued audio, and acknowledges commands.`}),actorButton(`vobiz`),_jsx(`div`,{className:`sev-inbox-label`,children:`↳ Last command received`}),_jsx(Payload,{step:receivedByVobiz,empty:`The application has not sent a command yet.`})]}),_jsxs(`section`,{className:`sev-sequence-lane`,\"aria-label\":`WebSocket event lane`,children:[_jsxs(`div`,{className:`sev-lane-heading`,children:[_jsx(`strong`,{children:`WSS · bidirectional`}),_jsx(`span`,{children:`Audio + JSON events`})]}),_jsxs(`div`,{className:`sev-live-rail`,\"data-direction\":railDirection,children:[_jsx(`span`,{className:`sev-rail-endpoint`,children:`V`}),_jsx(`div`,{className:`sev-rail-line`}),_jsx(`span`,{className:`sev-rail-endpoint`,children:`A`}),isAnimating\u0026\u0026activeStep\u0026\u0026_jsx(`div`,{className:`sev-moving-packet is-${railDirection}`,children:activeStep.event})]}),_jsxs(`div`,{className:`sev-current-cue`,\"aria-live\":`polite`,children:[_jsx(`div`,{className:`sev-cue-icon ${isComplete?`is-complete`:``}`,\"aria-hidden\":`true`,children:isComplete?`✓`:currentIndex+1}),isComplete?_jsxs(`div`,{children:[_jsx(`span`,{children:`Sequence complete`}),_jsx(`h2`,{children:`The WebSocket close is the end-of-stream signal.`}),_jsxs(`p`,{children:[`No inbound `,_jsx(`code`,{children:`{ \"event\": \"stop\" }`}),` packet is expected.`]}),_jsx(`button`,{type:`button`,className:`sev-replay-button`,onClick:replay,children:`↻ Replay from start`})]}):_jsxs(`div`,{children:[_jsxs(`span`,{children:[`Next · click `,ACTOR_LABEL[nextStep.sender]]}),_jsx(`h2`,{children:nextStep.title}),_jsx(`p`,{children:nextStep.description})]})]}),_jsxs(`div`,{className:`sev-history-heading`,children:[_jsx(`span`,{children:`Sequence history`}),_jsxs(`span`,{children:[delivered.length,` delivered`]})]}),_jsxs(`div`,{className:`sev-history`,\"aria-label\":`Delivered event history`,children:[hiddenHistoryCount>0\u0026\u0026_jsxs(`div`,{className:`sev-earlier-events`,children:[`+ `,hiddenHistoryCount,` earlier events`]}),visibleHistory.length===0?_jsx(`div`,{className:`sev-history-empty`,children:`The first start event will appear here.`}):visibleHistory.map(({index,step})=>_jsxs(`div`,{className:`sev-history-row is-${step.sender}`,children:[_jsx(`span`,{className:`sev-history-number`,children:String(index+1).padStart(2,`0`)}),_jsx(`span`,{children:ACTOR_LABEL[step.sender]}),_jsx(`span`,{className:`sev-history-arrow`,\"aria-hidden\":`true`,children:step.sender===`vobiz`?`→`:`←`}),_jsx(`strong`,{children:step.event}),_jsx(`span`,{className:`sev-history-receiver`,children:ACTOR_LABEL[step.receiver]})]},step.id))]})]}),_jsxs(`article`,{className:`sev-actor sev-actor-app`,children:[_jsxs(`div`,{className:`sev-actor-heading`,children:[_jsx(`div`,{className:`sev-actor-icon`,\"aria-hidden\":`true`,children:`A`}),_jsxs(`div`,{children:[_jsx(`span`,{children:`Your WebSocket server`}),_jsx(`h2`,{children:`Application`})]})]}),_jsx(`p`,{className:`sev-actor-description`,children:`Processes inbound media, queues agent audio, checkpoints utterances, and handles barge-in.`}),actorButton(`app`),_jsx(`div`,{className:`sev-inbox-label`,children:`↳ Application inbox`}),_jsx(Payload,{step:receivedByApp,empty:`Click Vobiz to receive the start payload.`})]})]})]}),_jsxs(`section`,{className:`sev-rules`,\"aria-label\":`Important Stream event rules`,children:[_jsxs(`div`,{children:[_jsx(`strong`,{children:`media`}),_jsx(`span`,{children:`Inbound frames arrive about 50 times per second.`})]}),_jsxs(`div`,{children:[_jsx(`strong`,{children:`playedStream`}),_jsx(`span`,{children:`Only arrives after uninterrupted playback.`})]}),_jsxs(`div`,{children:[_jsx(`strong`,{children:`checkpoint`}),_jsx(`span`,{children:`Names the utterance being tracked.`})]}),_jsxs(`div`,{children:[_jsx(`strong`,{children:`stop`}),_jsx(`span`,{children:`Has no inbound JSON acknowledgment.`})]}),_jsxs(`div`,{children:[_jsx(`strong`,{children:`dtmf`}),_jsx(`span`,{children:`One event per keypress, on every stream.`})]}),_jsxs(`div`,{children:[_jsx(`strong`,{children:`sendDTMF`}),_jsx(`span`,{children:`Needs bidirectional; no acknowledgment.`})]})]}),_jsx(`div`,{className:`sev-footer-link`,children:_jsxs(_components.a,{href:`/xml/stream/stream-events`,children:[`Read the Stream Events reference `,_jsx(`span`,{\"aria-hidden\":`true`,children:`→`})]})})]})})};const __snippet_STREAM_ID_9p7sym=`c4dfd815-a92a-4140-ab85-5ff28c004116`;const STREAM_ID=__snippet_STREAM_ID_9p7sym;const STREAM_FLOW=[{id:`start`,event:`start`,sender:`vobiz`,receiver:`app`,buttonLabel:`Open stream and send start`,title:`Vobiz establishes the stream`,description:`The start event arrives once. Store start.streamId and use start.mediaFormat to decode inbound media.`,payload:{sequenceNumber:0,event:`start`,start:{callId:`5401fd2e-6344-40df-a22c-c8ffea7a92e7`,streamId:__snippet_STREAM_ID_9p7sym,accountId:`500025`,tracks:[`inbound`],mediaFormat:{encoding:`audio/x-l16`,sampleRate:8e3}},extra_headers:`{}`}},...[1,2,3].map(chunk=>({id:`greeting-chunk-${chunk}`,event:`playAudio`,sender:`app`,receiver:`vobiz`,buttonLabel:`Send greeting chunk ${chunk} of 3`,title:`The application queues greeting chunk ${chunk}`,description:`Outbound playback declares its own supported format. Small chunks keep interruption responsive.`,payload:{event:`playAudio`,streamId:__snippet_STREAM_ID_9p7sym,media:{contentType:`audio/x-mulaw`,sampleRate:8e3,payload:`\u003cbase64-greeting-chunk-${String(chunk).padStart(3,`0`)}>`}}})),{id:`greeting-checkpoint`,event:`checkpoint`,sender:`app`,receiver:`vobiz`,buttonLabel:`Mark the greeting checkpoint`,title:`The application marks the utterance boundary`,description:`Send the checkpoint after the final audio chunk. Its unique name identifies a future playback acknowledgment.`,payload:{event:`checkpoint`,streamId:__snippet_STREAM_ID_9p7sym,name:`greeting-complete`}},{id:`caller-media`,event:`media`,sender:`vobiz`,receiver:`app`,buttonLabel:`Deliver a caller media frame`,title:`The caller interrupts the greeting`,description:`Voice activity is detected while greeting audio remains queued. Inbound media uses the format from start.mediaFormat.`,payload:{sequenceNumber:2,streamId:__snippet_STREAM_ID_9p7sym,event:`media`,media:{track:`inbound`,timestamp:`1778597597091`,chunk:2,payload:`\u003cbase64-user-audio>`},extra_headers:`{}`}},{id:`barge-in-clear`,event:`clearAudio`,sender:`app`,receiver:`vobiz`,buttonLabel:`Clear queued audio`,title:`The application handles barge-in`,description:`Send clearAudio as soon as speech is detected. The interrupted greeting checkpoint will not emit playedStream.`,payload:{event:`clearAudio`,streamId:__snippet_STREAM_ID_9p7sym}},{id:`barge-in-cleared`,event:`clearedAudio`,sender:`vobiz`,receiver:`app`,buttonLabel:`Confirm the queue was cleared`,title:`Vobiz acknowledges the interruption`,description:`The pending playback queue is empty. The application can now send audio for the caller's new request.`,payload:{sequenceNumber:3,event:`clearedAudio`,streamId:__snippet_STREAM_ID_9p7sym}},{id:`new-response`,event:`playAudio`,sender:`app`,receiver:`vobiz`,buttonLabel:`Send the new response`,title:`The application queues a fresh response`,description:`The new response uses the same streamId and declares the format of its outbound audio payload.`,payload:{event:`playAudio`,streamId:__snippet_STREAM_ID_9p7sym,media:{contentType:`audio/x-mulaw`,sampleRate:8e3,payload:`\u003cbase64-new-response>`}}},{id:`response-checkpoint`,event:`checkpoint`,sender:`app`,receiver:`vobiz`,buttonLabel:`Checkpoint the new response`,title:`The application tracks the new response`,description:`A unique checkpoint name lets the application identify which utterance eventually finishes playing.`,payload:{event:`checkpoint`,streamId:__snippet_STREAM_ID_9p7sym,name:`response-3`}},{id:`response-played`,event:`playedStream`,sender:`vobiz`,receiver:`app`,buttonLabel:`Acknowledge completed playback`,title:`Vobiz confirms the response was played`,description:`The checkpoint completed without interruption. playedStream echoes its name and does not include streamId.`,payload:{event:`playedStream`,name:`response-3`}},{id:`caller-dtmf`,event:`dtmf`,sender:`vobiz`,receiver:`app`,buttonLabel:`Deliver a caller keypress`,title:`The caller presses a key`,description:`Each keypress arrives as its own dtmf event, on every stream on the call. The digit still reaches the rest of the call flow, such as a Gather.`,payload:{event:`dtmf`,sequenceNumber:4,streamId:__snippet_STREAM_ID_9p7sym,dtmf:{track:`inbound`,digit:`1`,timestamp:`1778597601523`},extra_headers:`{}`}},{id:`send-dtmf`,event:`sendDTMF`,sender:`app`,receiver:`vobiz`,buttonLabel:`Send digits into the call`,title:`The application sends DTMF digits`,description:`Use sendDTMF to navigate an IVR or enter a PIN on the other party's line. It needs bidirectional=\"true\" and gets no acknowledgment.`,payload:{event:`sendDTMF`,dtmf:`1234#`}},{id:`stop`,event:`stop`,sender:`app`,receiver:`vobiz`,buttonLabel:`Stop the stream`,title:`The application ends the stream`,description:`Vobiz stops streaming immediately and continues with the next XML element when one exists.`,payload:{event:`stop`,streamId:__snippet_STREAM_ID_9p7sym}},{id:`socket-close`,event:`WebSocket close`,sender:`vobiz`,receiver:`app`,buttonLabel:`Close the WebSocket`,title:`The WebSocket closes without a stop event`,description:`The close frame is the canonical end-of-stream signal. Vobiz does not send an inbound JSON stop event.`,payload:{transport:`WebSocket close frame`,state:`closed`,note:`Transport signal, not an inbound Vobiz JSON event`},transportSignal:true}];const EventPayload=({step,empty})=>_jsxs(`div`,{className:`sev-payload`,children:[_jsxs(`div`,{className:`sev-payload-heading`,children:[_jsx(`span`,{\"aria-hidden\":`true`,children:`{ }`}),_jsx(`span`,{children:step?step.transportSignal?`Transport signal`:`${step.event} payload`:`Waiting`})]}),step?_jsx(`pre`,{tabIndex:`0`,children:_jsx(`code`,{children:JSON.stringify(step.payload,null,2)})}):_jsx(`div`,{className:`sev-empty-payload`,children:empty})]});const ACTOR_LABEL={vobiz:`Vobiz`,app:`Application`};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`StreamEventsVisualizer`,children:_jsx(StreamEventsVisualizer,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{StreamEventsVisualizer,__snippet_STREAM_ID_9p7sym,STREAM_ID,STREAM_FLOW,EventPayload,ACTOR_LABEL,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":"Stream Events Visualizer","sidebarTitle":"Stream Events Visualizer","description":"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.","keywords":["Vobiz Stream Events visualizer","WebSocket event visualizer","playAudio visualizer","clearAudio barge-in","checkpoint playedStream","dtmf sendDTMF stream","Vobiz bidirectional stream","voice agent WebSocket flow","Stream event playground"],"mode":"wide","href":"/resources/stream-events-visualizer"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[142,14770,"null;const __snippet_STREAM_ID_9p7sym=undefined;const STREAM_ID=undefined;const STREAM_FLOW=undefined;const EventPayload=()=>null;const ACTOR_LABEL=undefined;fu"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/vobizai/478834ae2c200a0e/blog-schema.js","/docs/_mintlify/custom/vobizai/13b0cd7ec6e39877/anchor-link-text.js"],"subdomain":"vobizai","siteName":"Vobiz","title":"Stream Events Visualizer - Vobiz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T20:13:57.298Z","originalFileLocation":"resources/stream-events-visualizer.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=\"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\">\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=\"Stream Events Visualizer - Vobiz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vobiz Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.vobiz.ai/docs/resources/stream-events-visualizer\">\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=Tools\u0026amp;title=Stream+Events+Visualizer\u0026amp;description=Step+through+the+Vobiz+bidirectional+Stream+WebSocket+lifecycle+and+inspect+start%2C+media%2C+playback%2C+checkpoint%2C+barge-in%2C+DTMF%2C+and+stop+events.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=312daca0c95b436288b0fbc963e4dfea9ffa6ab7232b73fd43051f15069135e9\">\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=\"Stream Events Visualizer - Vobiz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=Tools\u0026amp;title=Stream+Events+Visualizer\u0026amp;description=Step+through+the+Vobiz+bidirectional+Stream+WebSocket+lifecycle+and+inspect+start%2C+media%2C+playback%2C+checkpoint%2C+barge-in%2C+DTMF%2C+and+stop+events.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=312daca0c95b436288b0fbc963e4dfea9ffa6ab7232b73fd43051f15069135e9\">\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/resources/stream-events-visualizer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/resources/stream-events-visualizer.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/resources/stream-events-visualizer#webpage\",\"url\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer\",\"name\":\"Stream Events Visualizer\",\"description\":\"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\",\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tools\",\"item\":\"https://www.vobiz.ai/docs/resources/calculator\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Stream Events Visualizer\",\"item\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer#article\",\"headline\":\"Stream Events Visualizer\",\"name\":\"Stream Events Visualizer\",\"description\":\"Step through the Vobiz bidirectional Stream WebSocket lifecycle and inspect start, media, playback, checkpoint, barge-in, DTMF, and stop events.\",\"url\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer\",\"mainEntityOfPage\":{\"@id\":\"https://www.vobiz.ai/docs/resources/stream-events-visualizer#webpage\"},\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"keywords\":\"Vobiz Stream Events visualizer, WebSocket event visualizer, playAudio visualizer, clearAudio barge-in, checkpoint playedStream, dtmf sendDTMF stream, Vobiz bidirectional stream, voice agent WebSocket flow, Stream event playground\",\"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/resources/stream-events-visualizer.md","siteName":"Vobiz","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"tabs":[{"tab":"Documentation","groups":[{"group":"Getting Started","boost":5,"icon":"rocket","pages":[{"title":"Vobiz Docs: Voice, SIP Trunking, SMS \u0026 WhatsApp APIs","sidebarTitle":"Introduction","href":"/introduction"},{"title":"Quick Start – Make Your First Vobiz Call","sidebarTitle":"Quick Start","href":"/quick-start"},{"title":"Vobiz API Authentication: X-Auth-ID \u0026 X-Auth-Token","sidebarTitle":"Authentication","href":"/api-reference/authentication"},{"title":"Buy a Phone Number on Vobiz – Step-by-Step Guide","sidebarTitle":"Buy a Phone Number","href":"/buy-a-phone-number"},{"title":"Vobiz API Errors: Status Codes \u0026 Response Formats","sidebarTitle":"Error Handling","href":"/errors"},{"title":"Vobiz API Rate Limits: 429 Errors \u0026 Retry-After","sidebarTitle":"Rate Limits","href":"/rate-limits"},{"title":"Vobiz API changelog","sidebarTitle":"Changelog","href":"/changelog"}]},{"group":"Core Concepts","icon":"lightbulb","root":{"title":"Vobiz Platform Concepts \u0026 Architecture","sidebarTitle":"Concepts","href":"/concepts"},"pages":[{"title":"What Is SIP Trunking? How It Works on Vobiz","href":"/concepts/sip-trunking"},{"title":"Bring Your Own Carrier (BYOC) — Connect Your SIP Trunk","sidebarTitle":"Bring Your Own Carrier","href":"/concepts/bring-your-own-carrier"},{"title":"Voice Streaming over WebSockets | Vobiz Stream API","href":"/concepts/streaming-websockets"},{"title":"SIP vs WebSockets: Which to Use for AI Voice Agents on Vobiz","href":"/concepts/sip-vs-websockets"},{"title":"Audio Quality — HD Voice, VAD \u0026 Noise Cancellation","sidebarTitle":"Audio Quality","href":"/concepts/audio-quality"},{"title":"Sub-Accounts vs Partner Accounts on Vobiz — When to Use Each","sidebarTitle":"Sub-accounts vs partner accounts","href":"/concepts/sub-accounts-vs-partner-accounts"},{"title":"Vobiz Webhooks (Callbacks): Real-Time Call Events","sidebarTitle":"Callbacks","href":"/concepts/callbacks"},{"title":"Vobiz Webhook (Callback) Configuration","sidebarTitle":"Callback Configurations","href":"/concepts/callback-configurations"},{"title":"How to Validate Vobiz Webhook Signatures (HMAC)","href":"/concepts/validating-callbacks"},{"title":"Vobiz IP Address Allowlist — Firewall \u0026 SIP Whitelist","href":"/concepts/ip-whitelisting"},{"title":"Voice API Hangup Causes – Codes \u0026 Troubleshooting","sidebarTitle":"Hangup Causes","href":"/concepts/hangup-causes"}]},{"group":"Best Practices","icon":"star","root":{"title":"Integration Best Practices: Security \u0026 Reliability","sidebarTitle":"Best Practices","href":"/best-practices"},"pages":[{"title":"How an Outbound Campaign Manager Works — Caps \u0026 Retries","sidebarTitle":"Outbound Campaign Manager","href":"/best-practices/outbound-campaign-manager"},{"title":"Phone Number Utilization — Rotation \u0026 Spam Prevention","href":"/best-practices/number-utilization"},{"title":"Phone Number Health — Spam Detection, Pacing \u0026 Recovery","href":"/best-practices/number-health-guide"},{"title":"DLT Entity Registration — TRAI Compliance for Voice \u0026 SMS","sidebarTitle":"DLT Entity Registration","href":"/best-practices/dlt-registration"},{"title":"India 140 \u0026 160 Number Acquisition — Documents \u0026 Timelines","href":"/best-practices/140-160-acquisition"},{"title":"140 \u0026 160 DID Provisioning — PE Certificate, LOI \u0026 DLT","sidebarTitle":"DID Provisioning","href":"/best-practices/did-provisioning"},{"title":"India 92-Series Numbers — OTP Calls, Pickup Rates \u0026 KYC","href":"/best-practices/92-series-guide"}]},{"group":"Using Vobiz Platform","icon":"grip","pages":[{"title":"Console Login \u0026 Signup","sidebarTitle":"Login \u0026 Signup","href":"/platform/login"},{"title":"Vobiz Console Dashboard: API Credentials \u0026 Call Analytics","sidebarTitle":"Dashboard","href":"/platform/dashboard"},{"group":"Voice Applications","icon":"phone-volume","pages":[{"title":"Voice Applications Overview","sidebarTitle":"Overview","href":"/platform/voice/overview"},{"title":"XML Applications: Create \u0026 Manage Voice Apps","sidebarTitle":"Applications","href":"/platform/voice/applications"},{"title":"SIP Endpoints: Softphone \u0026 WebRTC Logins","sidebarTitle":"Endpoints","href":"/platform/voice/endpoints"},{"title":"How to Receive an Inbound Call in Your Browser","sidebarTitle":"Receive an Inbound Call","href":"/guides/receive-inbound-call"},{"group":"Logs","icon":"list","pages":[{"title":"Voice Call Logs: Per-Call Records \u0026 Quality Metrics","sidebarTitle":"Call Logs","href":"/platform/voice/call-logs"},{"title":"Voice Call Recordings: Playback \u0026 AI Insights","sidebarTitle":"Recordings","href":"/platform/voice/recordings"}]},{"title":"Campaigns: Launch \u0026 Manage Outbound Runs","sidebarTitle":"Campaigns","href":"/platform/campaigns/list"},{"title":"Campaign Agents: Reusable Webhook Configs","sidebarTitle":"Agents","href":"/platform/campaigns/agents"},{"title":"Campaign Call Logs: Per-Attempt Outbound History","sidebarTitle":"Campaign Call Logs","href":"/platform/campaigns/call-logs"}]},{"group":"SIP Trunking","icon":"network-wired","pages":[{"title":"SIP Trunking Overview: Global Voice Connectivity","sidebarTitle":"Overview","href":"/platform/sip/overview"},{"group":"Outbound Trunks","icon":"arrow-up-right-from-square","pages":[{"title":"Outbound Trunks: SIP Termination from Your PBX","sidebarTitle":"Trunks","href":"/platform/sip/outbound-trunks"},{"title":"IP Access Control List (ACL): Whitelist PBX IPs","sidebarTitle":"IP Access Control List","href":"/platform/sip/ip-access-control-list"},{"title":"SIP Credentials List: Username \u0026 Password Auth","sidebarTitle":"Credentials List","href":"/platform/sip/credentials"}]},{"group":"Inbound Trunks","icon":"arrow-down-to-bracket","pages":[{"title":"Inbound Trunks: Receive PSTN Calls","sidebarTitle":"Trunks","href":"/platform/sip/inbound-trunks"},{"title":"Origination URI: SIP Destinations for Inbound Calls","sidebarTitle":"Origination URI","href":"/platform/sip/origination-uri"}]},{"group":"Logs","icon":"list","pages":[{"title":"SIP Call Logs: Per-Call Records \u0026 Quality","sidebarTitle":"Call Logs","href":"/platform/sip/call-logs"},{"title":"SIP Trunk Call Recordings: Playback \u0026 Transcripts","sidebarTitle":"Recordings","href":"/platform/sip/recordings"}]}]},{"group":"Phone Numbers","icon":"hashtag","pages":[{"title":"Buy a Number: Numbers Inventory","sidebarTitle":"Buy a Number","href":"/platform/numbers/buy"},{"title":"My Numbers: Your Number Inventory","sidebarTitle":"My Numbers","href":"/platform/numbers/my-numbers"}]},{"title":"Sub-Accounts: Child Accounts \u0026 Number Assignment","sidebarTitle":"Sub-Accounts","href":"/platform/subaccounts"},{"title":"Team Members: Roles, Access \u0026 Member Management","sidebarTitle":"Team Members","href":"/platform/team"},{"group":"Capacity","icon":"gauge-high","pages":[{"title":"CPS: Buy Call-Initiation Throughput","sidebarTitle":"CPS","href":"/platform/capacity/cps"},{"title":"Concurrency: Buy Simultaneous Call Capacity","sidebarTitle":"Concurrency","href":"/platform/capacity/concurrency"},{"title":"My Subscriptions: Manage Capacity Subscriptions","sidebarTitle":"My Subscriptions","href":"/platform/capacity/subscriptions"}]}]},{"group":"Messaging (SMS \u0026 RCS)","icon":"comment-sms","pages":[{"title":"Vobiz Messaging Numbers","sidebarTitle":"Messaging numbers","href":"/sms/numbers"},{"title":"Vobiz Messaging Compliance: 10DLC, Toll-Free \u0026 DLT","sidebarTitle":"Compliance overview","href":"/sms/compliance/overview"},{"title":"US 10DLC Brand Registration — Create, Submit \u0026 Verify","sidebarTitle":"US 10DLC brands","href":"/sms/compliance/us-10dlc-brands"},{"title":"US 10DLC Campaign Registration — Use Cases \u0026 Statuses","sidebarTitle":"US 10DLC campaigns","href":"/sms/compliance/us-10dlc-campaigns"},{"title":"US Toll-Free SMS Verification — Submission \u0026 Appeals","sidebarTitle":"US toll-free","href":"/sms/compliance/us-toll-free"},{"title":"India DLT SMS Compliance — Entity, Header \u0026 Template IDs","sidebarTitle":"India DLT","href":"/sms/compliance/india-dlt"}]},{"group":"Compliance","icon":"shield-halved","pages":[{"title":"Global Compliance — Voice \u0026 SMS Regulations by Country","href":"/compliance/overview"},{"group":"India","pages":[{"title":"India Calling Regulations","href":"/compliance/india/calling-regulations"},{"title":"India Number KYC","href":"/compliance/india/kyc"},{"title":"UCC \u0026 NDNC Compliance","sidebarTitle":"UCC \u0026 NDNC","href":"/compliance/india/ucc"}]},{"group":"United States","pages":[{"title":"US Calling Regulations — TCPA, STIR/SHAKEN \u0026 DNC Rules","href":"/compliance/us/calling-regulations"},{"title":"US SMS Regulations — TCPA, 10DLC, Quiet Hours \u0026 Opt-Out Rules","href":"/compliance/us/sms-regulations"}]}]},{"group":"FAQ","icon":"question","root":{"title":"Vobiz FAQ: Billing, API Limits \u0026 SIP Trunking","sidebarTitle":"FAQ","href":"/faq"},"pages":[{"title":"Can I connect my trial number for inbound calls?","href":"/faq/trial-inbound"},{"title":"SIP 480 \u0026 486 Errors: Temporarily Unavailable \u0026 Busy Here","sidebarTitle":"SIP 480 and 486","href":"/faq/sip-codes-480-486"},{"title":"Why am I receiving a 429 error?","href":"/faq/error-429"},{"title":"'From number not owned by account' Error","sidebarTitle":"From number not owned error","href":"/faq/from-number-not-owned"},{"title":"What Is Call Concurrency? Simultaneous Call Capacity Explained","href":"/faq/concurrency"},{"title":"What Is CPS? Calls Per Second and Voice Throughput Explained","href":"/faq/cps"},{"title":"Can I purchase additional Concurrency or CPS?","href":"/faq/purchase-concurrency-cps"},{"title":"Do you provide 140, 160, and 92 series numbers?","href":"/faq/number-series"},{"title":"What integrations do you support?","href":"/faq/integrations"},{"title":"Is call transfer supported?","href":"/faq/call-transfer"},{"title":"Do you support IVR?","href":"/faq/ivr"},{"title":"What documents are required for verification?","href":"/faq/verification-docs"},{"title":"How can I contact support?","href":"/faq/contact-support"},{"title":"What Is Domestic Calling? IN-to-IN Calling on Vobiz Explained","href":"/faq/domestic-calling-india"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"CPS \u0026 Concurrency Calculator","href":"/resources/calculator"},{"title":"Vobiz Visual XML Builder for Voice Call Flows","sidebarTitle":"XML Builder","description":"Compose Vobiz Voice XML visually - pick verbs, reorder them, and configure attributes with a live preview. The fastest way to prototype call flows globally.","href":"/xml-builder"},{"title":"Stream Events Visualizer","sidebarTitle":"Stream Events Visualizer","mode":"wide","href":"/resources/stream-events-visualizer"},{"title":"Dial XML Transfer Visualizer","sidebarTitle":"Dial Transfer Visualizer","description":"Step through a Vobiz call transfer: a caller reaches your AI agent, Dial rings a human on standby, and the human accepts or rejects. See every webhook and XML.","mode":"wide","href":"/resources/dial-transfer-visualizer"},{"title":"Gather XML Input Visualizer","sidebarTitle":"Gather Input Visualizer","mode":"wide","href":"/resources/gather-visualizer"},{"title":"SIP Trunk vs WebSocket Visualizer","sidebarTitle":"SIP vs WebSocket Visualizer","mode":"wide","href":"/resources/sip-vs-websocket-visualizer"},{"title":"CPS \u0026 Concurrency Visualizer","sidebarTitle":"CPS vs Concurrency Visualizer","mode":"wide","href":"/resources/cps-concurrency-visualizer"},{"title":"Conference XML Visualizer","sidebarTitle":"Conference Visualizer","mode":"wide","href":"/resources/conference-visualizer"},{"title":"Bulk and batch operations","sidebarTitle":"Bulk and batch","href":"/resources/bulk-operations"},{"group":"Sitemap","root":{"title":"Vobiz Documentation Sitemap","sidebarTitle":"Sitemap","href":"/resources/sitemap"},"pages":[{"title":"Vobiz Docs Sitemap - Documentation","sidebarTitle":"Documentation","href":"/resources/sitemap/documentation"},{"title":"Vobiz Docs Sitemap - API Reference: Regular APIs","sidebarTitle":"API Reference: Regular APIs","href":"/resources/sitemap/api-reference-regular-apis"},{"title":"Vobiz Docs Sitemap - API Reference: SIP Trunking","sidebarTitle":"API Reference: SIP Trunking","href":"/resources/sitemap/api-reference-sip-trunking"},{"title":"Vobiz Docs Sitemap - API Reference: Voice \u0026 XML","sidebarTitle":"API Reference: Voice \u0026 XML","href":"/resources/sitemap/api-reference-voice-xml"},{"title":"Vobiz Docs Sitemap - API Reference: SMS \u0026 RCS","sidebarTitle":"API Reference: SMS \u0026 RCS","href":"/resources/sitemap/api-reference-sms-rcs"},{"title":"Vobiz Docs Sitemap - API Reference: WhatsApp","sidebarTitle":"API Reference: WhatsApp","href":"/resources/sitemap/api-reference-whatsapp"},{"title":"Vobiz Docs Sitemap - API Reference: Partner API","sidebarTitle":"API Reference: Partner API","href":"/resources/sitemap/api-reference-partner-api"},{"title":"Vobiz Docs Sitemap - Integrations","sidebarTitle":"Integrations","href":"/resources/sitemap/integrations"},{"title":"Vobiz Docs Sitemap - Examples \u0026 Tutorials","sidebarTitle":"Examples \u0026 Tutorials","href":"/resources/sitemap/examples-tutorials"},{"title":"Vobiz Docs Sitemap - Blogs","sidebarTitle":"Blogs","href":"/resources/sitemap/blogs"}]}]},{"group":"AI agents","icon":"robot","pages":[{"title":"Vobiz Agent Skills","sidebarTitle":"Agent Skills","href":"/resources/skills"},{"title":"Vobiz MCP Server","sidebarTitle":"MCP Server","href":"/resources/vobiz-mcp"},{"title":"Vobiz Docs MCP Server","sidebarTitle":"Docs MCP Server","href":"/resources/mcp"},{"title":"Vobiz CLI — Calls, SMS \u0026 Numbers from Your Terminal","sidebarTitle":"CLI","href":"/resources/cli"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/account"}]},{"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":"Stream Events Visualizer - Vobiz","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":[],"chunks":[]}