Skip to main content

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.

The Recording API lets you manage recordings stored in your Vobiz account. Retrieve recording details including storage duration and billing information, list recordings with advanced filtering options, and delete recordings when they are no longer needed.
Capabilities
  • Call Recordings - Manage recordings from regular voice calls with detailed metadata.
  • Conference Recordings - Access recordings from conference calls and multiparty calls.
  • Storage Management - Track storage duration and associated monthly costs.
  • File Formats - Recordings are available in MP3 and WAV formats.
Important: Recordings are stored securely and accessible via HTTPS URLs. Storage costs are calculated monthly based on the recording duration and storage time.

API Endpoint

Base URL
Base URL
https://api.vobiz.ai/api/v1
Recording Base URI
Recording Base URI
https://api.vobiz.ai/api/v1/Account/{auth_id}/Recording/
Authentication required:
  • X-Auth-ID - Your account ID (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json

Available Operations

MethodOperationDescription
OBJECTThe Recording objectComplete structure and attributes of a Recording object including storage and billing details.
GETRetrieve a recordingGet details of a specific recording based on its recording ID.
GETList all recordingsRetrieve a list of all recordings with extensive filtering options.
GETDownload a recordingStep-by-step guide to download physical recording files and resolve playback issues.
DELETEDelete a recordingPermanently delete a specific recording from your account.
POSTExport historical recordingsExport recordings as a downloadable archive sent via email (async operation).
DELETEBulk delete recordingsDelete multiple recordings matching filter criteria (async operation).
Note: Vobiz automatically rounds recording durations to the nearest 60-second interval. Recordings shorter than 60 seconds are rounded up to 60 seconds for billing purposes.