Skip to main content

Documentation Index

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

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

The Recording object represents a call or conference recording stored in your Vobiz account. It includes information about the recording file, associated call details, storage duration, and billing.
All recordings are automatically stored when call or conference recording is enabled. Storage costs are calculated based on duration and time stored, tracked in the recording_storage_duration and monthly_recording_storage_amount fields.

​
Attributes

​
Core Attributes

FieldTypeDescription
recording_idstringUnique identifier for the recording. Used in API operations to identify specific recordings.
recording_urlstringDirect HTTPS download URL for the audio file. Use this to download or stream the recording.
recording_formatstringAudio format of the recording file. Allowed values: “mp3”, “wav”.
call_uuidstringUUID of the call or conference that was recorded.
conference_namestringName of the conference that was recorded. Value is null if it was a regular call, not a conference.
recording_typestringType of recording. Values: “call” (regular call), “conference” (conference call).
add_timetimestampTimestamp when the recording was created. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SSZ).

​
Duration & Timing Attributes

FieldTypeDescription
recording_start_msfloatRecording start time in milliseconds since epoch.
recording_end_msfloatRecording end time in milliseconds since epoch.
recording_duration_msfloatActual duration of the recording in milliseconds.
rounded_recording_durationintegerRounded duration in seconds used for billing calculations.

​
Call Details

FieldTypeDescription
from_numberstringCaller phone number in E.164 format (e.g., +14155551234).
to_numberstringDestination phone number in E.164 format.

​
Storage & Billing Attributes

FieldTypeDescription
recording_storage_durationintegerNumber of days since the recording was created. Used to calculate storage costs.
recording_storage_ratefloatStorage rate per month in USD. This is the unit cost for storing this recording.
monthly_recording_storage_amountfloatMonthly storage cost in USD for the current billing cycle.

​
Example

​
Complete Recording Object (Conference)

JSON Response
{
    "api_id": "668470b7-7a8f-49b6-9011-50075754a50a",
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "add_time": "2025-11-06 13:49:10.751756+00:00",
            "call_uuid": "6e558798-499c-4a68-bc77-46f2c53d1f69",
            "conference_name": "",
            "from_number": "+918071387423",
            "monthly_recording_storage_amount": 0,
            "recording_duration_ms": "10080.00000",
            "recording_end_ms": "1762436949502.00000",
            "recording_format": "mp3",
            "recording_id": "d7801b2e-e76d-4dd8-be9c-9e015a7267b8",
            "recording_start_ms": "1762436939422.00000",
            "recording_storage_duration": 1,
            "recording_storage_rate": 0.005,
            "recording_type": "call",
            "recording_url": "https://media.vobiz.ai/api/v1/Account/MA_PU0XU668/Recording/d7801b2e-e76d-4dd8-be9c-9e015a7267b8.mp3",
            "resource_uri": "/v1/Account/MA_PU0XU668/Recording/d7801b2e-e76d-4dd8-be9c-9e015a7267b8/",
            "rounded_recording_duration": 60,
            "to_number": "919624705678"
        }
    ]
}

​
Regular Call Recording Example

JSON Response
{
    "api_id": "668470b7-7a8f-49b6-9011-50075754a50a",
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
            "add_time": "2025-11-06 13:49:10.751756+00:00",
            "call_uuid": "6e558798-499c-4a68-bc77-46f2c53d1f69",
            "conference_name": null,
            "from_number": "+918071387423",
            "monthly_recording_storage_amount": 0,
            "recording_duration_ms": "10080.00000",
            "recording_end_ms": "1762436949502.00000",
            "recording_format": "mp3",
            "recording_id": "d7801b2e-e76d-4dd8-be9c-9e015a7267b8",
            "recording_start_ms": "1762436939422.00000",
            "recording_storage_duration": 1,
            "recording_storage_rate": 0.005,
            "recording_type": "call",
            "recording_url": "https://media.vobiz.ai/api/v1/Account/MA_PU0XU668/Recording/d7801b2e-e76d-4dd8-be9c-9e015a7267b8.mp3",
            "resource_uri": "/v1/Account/MA_PU0XU668/Recording/d7801b2e-e76d-4dd8-be9c-9e015a7267b8/",
            "rounded_recording_duration": 60,
            "to_number": "919624705678"
        }
    ]
}
Key Differences:
  • Conference Recording: conference_name contains the conference name, recording_type is “conference”
  • Regular Call: conference_name is null, recording_type is “call”
  • Duration: recording_duration_ms is actual duration, rounded_recording_duration is used for billing
  • Storage Cost: Calculated from recording_storage_rate × recording_storage_duration
Important Notes:
  • Recording URLs may be temporary - download recordings for permanent storage
  • recording_storage_duration increments daily and affects monthly costs
  • Timestamps (recording_start_ms, recording_end_ms) are in milliseconds since Unix epoch
  • Storage rate and amount are in USD