Vobiz Logo
Vobiz
|API Documentation
Console
← Back to Recording

List all Recordings

Retrieve a paginated list of all recordings with extensive filtering options.

This API allows you to retrieve a list of all recordings stored in your Vobiz account. You can filter recordings by phone numbers, conference details, time ranges, format, and more.

Tip: Combine multiple filters to narrow down results. For example, filter by conference name and date range to find specific meeting recordings.

HTTP Request

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

Authentication Headers

X-Auth-ID:Your account auth_id (e.g., {Auth_ID})
X-Auth-Token:Your account auth token

Request Parameters

Pagination Parameters

NameTypeDescription
limit
integerNumber of results per page. Default: 20.
offset
integerNumber of records to skip (used for pagination). For example, with limit=20 and offset=20, results will include records 21 through 40. Default: 0.

Filter Parameters

NameTypeDescription
from_number
stringFilter by caller phone number. Supports exact match or partial match (contains). Example: +14155551234 or 4155551234.
to_number
stringFilter by destination phone number. Supports exact match or partial match (contains).
call_uuid
stringFilter by specific call UUID (exact match).
conference_name
stringFilter by conference name. Supports exact match or partial match (contains).
recording_format
stringFilter by audio format. Values: "mp3", "wav".
recording_id
stringFilter by recording ID. Supports exact match or partial match (contains).
recording_type
stringFilter by recording type. Values: "call", "conference".

Date/Time Filter Parameters

NameTypeDescription
add_time__gte
stringRecordings created on or after this date. Format: YYYY-MM-DD HH:MM:SS. Example: 2025-01-01 00:00:00
add_time__lte
stringRecordings created on or before this date. Format: YYYY-MM-DD HH:MM:SS.
add_time__gt
stringRecordings created strictly after this date (exclusive). Format: YYYY-MM-DD HH:MM:SS.
add_time__lt
stringRecordings created strictly before this date (exclusive). Format: YYYY-MM-DD HH:MM:SS.

Date Format Requirements:

  • • Format: YYYY-MM-DD HH:MM:SS
  • • Example: 2025-01-15 10:30:45
  • • Use 24-hour time format
  • • Include seconds (even if 00)

Response

Returns a dictionary with an objects property containing an array of Recording objects, along with a meta object for pagination information.

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"
      }
  ]
}

Pagination: Use the meta.total_count field to determine the total number of recordings available. Calculate pages using: total_pages = ceil(total_count / limit).

Examples

List All Recordings (Default)

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?limit=20&offset=0" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Filter by Conference Name

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?conference_name=TeamMeeting" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Filter by Date Range

Get all recordings from January 2025:

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?add_time__gte=2025-01-01%2000:00:00&add_time__lte=2025-01-31%2023:59:59" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Filter by Phone Number

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?from_number=%2B14155551234" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Note: URL encode the + symbol as %2B in phone numbers

Filter by Recording Format

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?recording_format=mp3" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Combine Multiple Filters with Pagination

Get MP3 recordings from a specific number in the last 7 days, page 2:

cURL
curl -X GET "https://api.vobiz.ai/api/v1/Account/{Auth_ID}/Recording/?from_number=4155551234&recording_format=mp3&add_time__gte=2025-01-23%2000:00:00&limit=50&offset=50" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Common Use Cases:

  • • Build recording dashboards with filters
  • • Find recordings for specific conferences or calls
  • • Generate reports based on date ranges
  • • Search recordings by phone number
  • • Filter by audio format for compatibility

Tip: For better performance with large result sets, use specific filters to narrow down results before paginating. Combine date ranges with other filters for precise queries.

Pagination Example:

To get page 3 with 50 results per page: offset = (page - 1) × limit = (3 - 1) × 50 = 100

Retrieve a Recording
Delete a Recording