Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Recording
/
{recording_id}
Retrieve a recording
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/{recording_id}/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "add_time": "2026-03-25 10:00:00.000000+05:30",
  "api_id": "55667788-1234-5678-90ab-cdef12345678",
  "call_uuid": "55667788-1234-5678-90ab-cdef12345678",
  "conference_name": null,
  "from_number": "+919876543210",
  "monthly_recording_storage_amount": 0,
  "recording_duration_ms": "7880.00000",
  "recording_end_ms": null,
  "recording_format": "wav",
  "recording_id": "55667788-1234-5678-90ab-cdef12345678",
  "recording_start_ms": null,
  "recording_storage_duration": 6,
  "recording_storage_rate": 0.005,
  "recording_type": "trunk",
  "recording_url": "https://recordings.vobiz.ai/example/abc123.mp3",
  "resource_uri": "/v1/Account/MA_XXXXXXXX/Recording/55667788-1234-5678-90ab-cdef12345678/",
  "rounded_recording_duration": 60,
  "to_number": "+918012345678"
}

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.

GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/{recording_id}/
Retrieve the details of a specific recording by its recording ID. The response includes complete information about the recording file, associated call details, storage duration, and billing.
Authentication required:
  • X-Auth-ID - Your account auth_id (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
You can obtain the recording_id from the List All Recordings endpoint or from webhook notifications when recordings are created.

​
Path parameters

FieldTypeRequiredDescription
auth_idstringYesYour account ID.
recording_idstringYesThe unique recording identifier.

​
Response

Returns a complete Recording object with all attributes if the recording ID is valid.
Response - 200 OK
{
    "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"
        }
    ]
}
Response - 404 Not Found
{
    "api_id": "correlation-id-uuid",
    "error": "Recording not found"
}

​
Examples

​
cURL Request

cURL
curl -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/abc123def456/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Download Recording File

Use the recording_url from the response to download the actual audio file. For a complete step-by-step guide including authentication details and troubleshooting, see the Download Recording Guide.

​
Using jq to Extract URL

Bash Script with jq
# Get recording URL and download in one command
RECORDING_URL=$(curl -s -X GET https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/abc123def456/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  | jq -r '.recording_url')

curl -o recording.mp3 "$RECORDING_URL"
Use Cases:
  • Verify recording details before downloading
  • Check storage duration for billing purposes
  • Confirm recording format (MP3 vs WAV)
  • Get the download URL for archiving
  • Validate recording metadata (call_uuid, phone numbers)
The recording_url provides direct access to the audio file and can be used in media players or downloaded programmatically. These URLs may be temporary, so download recordings promptly for permanent storage.
Important: Always check the api_id field in responses for correlation and debugging purposes. This ID is useful when contacting support about specific requests.

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Path Parameters

​
auth_id
string
required

Your account Auth ID

Example:

"MA_XXXXXX"

​
recording_id
string
required
Example:

"rec_XXXXXXXXXX"

Response

200 - application/json

Recording details

​
add_time
string
required
​
api_id
string
required
​
call_uuid
string
required
​
conference_name
unknown
required
​
from_number
string
required
​
monthly_recording_storage_amount
integer
required
​
recording_duration_ms
string
required
​
recording_end_ms
unknown
required
​
recording_format
string
required
​
recording_id
string
required
​
recording_start_ms
unknown
required
​
recording_storage_duration
integer
required
​
recording_storage_rate
number
required
​
recording_type
string
required
​
recording_url
string
required
​
resource_uri
string
required
​
rounded_recording_duration
integer
required
​
to_number
string
required