Retrieve an Audio Stream

This method lets you retrieve the details of an audio stream.

Use this endpoint to retrieve information about a specific audio stream, including its configuration, status, duration, and billing details. You'll need the stream_id (also called stream_uuid) that was returned when the stream was initiated.

Use Case: Retrieve stream details to monitor stream status, verify configuration, check billing information, or audit stream usage.

HTTP Request

GEThttps://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_uuid}/

Authentication: Include X-Auth-ID and X-Auth-Token headers.

Arguments

No arguments need to be passed. The stream_uuid is specified in the URL path.

Response

Returns the complete audio stream object with all configuration details, timestamps, and billing information.

Response - 200 OK

{
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "audio_track": "both",
  "bidirectional": false,
  "bill_duration": 27,
  "billed_amount": "0.00300",
  "call_uuid": "call-uuid-xxxx-yyyy-zzzz-abcd",
  "created_at": "2025-11-14 13:23:44.136962+00:00",
  "end_time": "2025-11-14 18:53:43+05:30",
  "account_id": "MA_AABBCC",
  "resource_uri": "/v1/Account/MA_AABBCC/Call/call-uuid-xxxx-yyyy-zzzz-abcd/Stream/stream-id-aabbcc-ddeeff/",
  "rounded_bill_duration": 60,
  "service_url": "wss://yourapp.example.com/audiostream",
  "start_time": "2025-11-14 18:53:16+05:30",
  "stream_id": "stream-id-aabbcc-ddeeff"
}

Examples

cURL - Retrieve Stream

cURL Request

curl -X GET https://api.vobiz.ai/api/v1/Account/MA_AABBCC/Call/call-uuid-xxxx-yyyy/Stream/stream-id-aabbcc-ddeeff/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Node.js Example

Node.js

const axios = require('axios');

const authId = 'MA_AABBCC';
const callUuid = 'call-uuid-xxxx-yyyy';
const streamId = 'stream-id-aabbcc-ddeeff';

axios.get(`https://api.vobiz.ai/api/v1/Account/${authId}/Call/${callUuid}/Stream/${streamId}/`, {
  headers: {
    'X-Auth-ID': 'YOUR_AUTH_ID',
    'X-Auth-Token': 'YOUR_AUTH_TOKEN'
  }
})
.then(response => {
  console.log('Stream details:', response.data);
  console.log('Stream status:', response.data.end_time ? 'Ended' : 'Active');
  console.log('Duration:', response.data.bill_duration, 'seconds');
})
.catch(error => {
  console.error('Error retrieving stream:', error.response.data);
});

Python Example

Python

import requests

auth_id = 'MA_AABBCC'
call_uuid = 'call-uuid-xxxx-yyyy'
stream_id = 'stream-id-aabbcc-ddeeff'

url = f'https://api.vobiz.ai/api/v1/Account/{auth_id}/Call/{call_uuid}/Stream/{stream_id}/'

headers = {
    'X-Auth-ID': 'YOUR_AUTH_ID',
    'X-Auth-Token': 'YOUR_AUTH_TOKEN'
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    stream_data = response.json()
    print(f"Stream ID: {stream_data['stream_id']}")
    print(f"Service URL: {stream_data['service_url']}")
    print(f"Duration: {stream_data['bill_duration']} seconds")
    print(f"Cost: {stream_data['billed_amount']}")
else:
    print(f"Error: {response.status_code}")

Tip: Use this endpoint to:

• Monitor stream status and verify it's active
• Check billing duration and cost
• Verify stream configuration (codec, audio track, etc.)
• Audit stream usage across your account

Initiate an Audio Stream

Retrieve All Audio Streams