Skip to main content
GET
List recordings
Retrieve a paginated list of call recordings for your account. Filter by call UUID or recording type, and page through results with limit and offset.
Pagination here is offset-based (limit + offset), not page-based. This differs from the CDR list, which uses page + per_page. To get the next page, add limit to offset (page 2 of 20 = offset=20), or follow the ready-made meta.next URL in the response.
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

Response

A successful request returns a 200 OK status with a JSON array of recording objects.
Success Response - 200 OK

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 (call, conference, or trunk)
  • 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 - Filter by Call UUID

cURL Request

Generic Template (Use Your Own Values)

cURL Template

Parameter Quick Reference

Quick Tips:
  • Pagination: Use offset to navigate through pages (offset = page × limit), or follow meta.next.
  • Recording Type: Filter by call, conference, or trunk 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: Match a recording’s call_uuid against a CDR’s uuid to tie audio to call metadata.

Edge cases

  • Empty account / no matches: returns 200 with objects: [] and meta.total_count: 0 - not a 404.
  • Last page: meta.next is null once you reach the end; stop paging when it is null.
  • Timestamp fields: recording_start_ms / recording_end_ms can be null (e.g. for some trunk captures); recording_duration_ms is a string of milliseconds. rounded_recording_duration is the integer-seconds value used for billing.
  • No cross-account access: this endpoint returns recordings for the auth_id in the path only.
Next Steps:
  • Use the recording_id to retrieve or download a specific recording.
  • Cross-reference with CDR data via call_uuid ↔ CDR uuid for complete call information.
  • Store recording URLs for playback or archival purposes.
  • Implement offset pagination (or follow meta.next) 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

Offset-based pagination metadata returned in the meta object of the Application, Endpoint and Recording list endpoints. To fetch the next page, add limit to offset, or request the next URL as-is.

objects
object[]
required