Skip to main content
GET
/
api
/
v1
/
Account
/
{auth_id}
/
Recording
List recordings
curl --request GET \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/ \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "objects": [
    {
      "recording_id": "rec_XXXXXXXXXX",
      "recording_url": "https://storage.vobiz.ai/recordings/rec_XXXXXXXXXX.mp3",
      "duration": 120,
      "file_format": "mp3"
    }
  ]
}

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/
Retrieve a paginated list of call recordings for your account. Filter recordings by type (trunk or extension) and control the number of results returned per request.
Use Cases: Retrieve recordings for archival, compliance, quality assurance, or to provide playback links to customers. The response includes recording IDs, call IDs for cross-referencing with CDRs, and download URLs.
Case Sensitivity Notice: Note that Account and Recording are capitalized in the URL path. Some APIs are case-sensitive, so ensure the capitalization matches exactly.
Authentication required:
  • X-Auth-ID - Your account ID (e.g., MA_XXXXXXXX)
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

​
Query Parameters

FieldTypeRequiredDescription
limitintegerNoThe number of recording records to return in one request (default: 20, max: 100).
offsetintegerNoWhere to start the list for pagination. Set to 20 to see the next page after the first 20 results (default: 0).
call_uuidstringNoFilter recordings by a specific call UUID. Returns only recordings associated with the given call.
recording_typestringNoFilter by recording type. Common values: “trunk” or “extension”.

​
Response

A successful request returns a 200 OK status with a JSON array of recording objects.
Success Response - 200 OK
{
  "api_id": "319ab584-cfc4-452c-a0ea-2f2f2f506a20",
  "meta": {
    "limit": 20,
    "next": "/v1/Account/MA_XXXXXXXX/Recording/?limit=20&offset=20",
    "offset": 0,
    "previous": null,
    "total_count": 721
  },
  "objects": [
    {
      "add_time": "2026-05-07 09:45:35.79276+05:30",
      "call_uuid": "11223344-5566-7788-99aa-bbccddeeff00",
      "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": "aabbccdd-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/aabbccdd-1234-5678-90ab-cdef12345678/",
      "rounded_recording_duration": 60,
      "to_number": "+918012345678"
    },
    {
      "add_time": "2026-05-02 10:12:39.347981+05:30",
      "call_uuid": "11223344-5566-7788-99aa-bbccddeeff00",
      "conference_name": "",
      "from_number": "+919876543210",
      "monthly_recording_storage_amount": 0,
      "recording_duration_ms": "31040.00000",
      "recording_end_ms": "1777696958218.00000",
      "recording_format": "mp3",
      "recording_id": "aabbccdd-1234-5678-90ab-cdef12345678",
      "recording_start_ms": "1777696927178.00000",
      "recording_storage_duration": 11,
      "recording_storage_rate": 0.005,
      "recording_type": "call",
      "recording_url": "https://recordings.vobiz.ai/example/abc123.mp3",
      "resource_uri": "/v1/Account/MA_XXXXXXXX/Recording/aabbccdd-1234-5678-90ab-cdef12345678/",
      "rounded_recording_duration": 60,
      "to_number": "+918012345678"
    }
  ]
}

​
Response Fields

  • recording_id - Unique identifier for the recording (used for download)
  • call_uuid - Cross-reference with CDR records
  • recording_url - Link to the actual audio file (MP3/WAV)
  • add_time - Timestamp when the recording was added
  • recording_duration_ms - Recording length in milliseconds
  • rounded_recording_duration - Recording length rounded up (seconds, billing basis)
  • recording_format - File format (mp3 or wav)
  • recording_type - Type of recording (e.g. trunk, call)
  • from_number / to_number - Caller and callee numbers on the call
  • resource_uri - Canonical API path for the recording resource
  • meta - Pagination metadata (limit, offset, next, previous, total_count)

​
Examples

​
cURL - List Trunk Recordings

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/?limit=20&offset=0&recording_type=trunk" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json"

​
cURL - Filter by Call UUID

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/Recording/?call_uuid=7f8e9d2c-1a3b-4c5d-6e7f-8g9h0i1j2k3l" \
  -H "X-Auth-ID: MA_XXXXXXXX" \
  -H "X-Auth-Token: your_auth_token" \
  -H "Content-Type: application/json"

​
Generic Template (Use Your Own Values)

cURL Template
curl -X GET "https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/?limit={LIMIT}&offset={OFFSET}&recording_type={TYPE}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json"

​
Parameter Quick Reference

ParameterExampleDescription
limit20Number of records to return
offset0Starting position (0 for first page, 20 for second, etc.)
call_uuid7f8e9d2c-1a3b-4c5d-6e7f-8g9h0i1j2k3lFilter recordings for a specific call
recording_typetrunkFilter by type: “trunk” or “extension”
Quick Tips:
  • Pagination: Use offset to navigate through pages (offset = page × limit)
  • Recording Type: Filter by “trunk” or “extension” to get specific recording types
  • Case Sensitive: Ensure “Account” and “Recording” are capitalized in the URL
  • Filter by Call: Use call_uuid to get recordings for a specific call
  • Cross-Reference: Use call_id to match recordings with CDR entries
Next Steps:
  • Use the recording_id to download specific recordings
  • Cross-reference with CDR data using call_id for complete call information
  • Store recording URLs for playback or archival purposes
  • Implement pagination to retrieve all recordings efficiently

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"

Query Parameters

​
limit
integer
default:20
​
offset
integer
default:0

Response

200 - application/json

List of recordings

​
api_id
string
required
​
meta
object
required
​
objects
object[]
required