List All Recordings

Retrieve a paginated list of call recordings for your account.

This API endpoint allows you to fetch a list of call recordings with pagination support. You can 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.

HTTP Request

GEThttps://api.vobiz.ai/api/v1/Account/{ACCOUNT_ID}/Recording/

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

Query String Parameters

NameTypeDescription
limit
integerThe number of recording records to return in one request (default: 20, max: 100).
offset
integerWhere to start the list for pagination. Set to 20 to see the next page after the first 20 results (default: 0).
call_uuid
stringFilter recordings by a specific call UUID. Returns only recordings associated with the given call.
recording_type
stringFilter 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
{
  "recordings": [
    {
      "recording_id": "REC_abc123def456",
      "call_id": "7f8e9d2c-1a3b-4c5d-6e7f-8g9h0i1j2k3l",
      "recording_type": "trunk",
      "url": "https://recordings.vobiz.ai/files/REC_abc123def456.mp3",
      "download_path": "/v1/Account/MA_XXXXXXXX/Recording/REC_abc123def456/download",
      "duration": 312,
      "created_at": "2026-01-23T10:30:00Z",
      "file_size": 2457600,
      "format": "mp3"
    },
    {
      "recording_id": "REC_xyz789uvw012",
      "call_id": "2a3b4c5d-6e7f-8g9h-0i1j-2k3l4m5n6o7p",
      "recording_type": "trunk",
      "url": "https://recordings.vobiz.ai/files/REC_xyz789uvw012.mp3",
      "download_path": "/v1/Account/MA_XXXXXXXX/Recording/REC_xyz789uvw012/download",
      "duration": 125,
      "created_at": "2026-01-23T09:15:00Z",
      "file_size": 987600,
      "format": "mp3"
    }
  ],
  "pagination": {
    "limit": 20,
    "offset": 0,
    "total": 150,
    "has_more": true
  }
}

Response Fields

  • recording_id - Unique identifier for the recording (used for download)
  • call_id - Cross-reference with CDR records
  • url or download_path - Link to the actual audio file (MP3/WAV)
  • created_at - Timestamp when the recording was made
  • duration - Recording length in seconds
  • recording_type - Type of recording (trunk/extension)

Examples

cURL - List Trunk Recordings

cURL Request
curl -X GET "https://api.vobiz.ai/api/v1/Account/{ACCOUNT_ID}/Recording/?limit=20&offset=0&recording_type=trunk" \
  -H "X-Auth-ID: {ACCOUNT_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/{ACCOUNT_ID}/Recording/?limit={LIMIT}&offset={OFFSET}&recording_type={TYPE}" \
  -H "X-Auth-ID: {ACCOUNT_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