Skip to main content
POST
/
api
/
v1
/
account
/
{auth_id}
/
export
/
recording
Export Historical Recordings
curl --request POST \
  --url https://api.example.com/api/v1/account/{auth_id}/export/recording/

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.

POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/
Export recordings matching your filter criteria. Recordings are packaged as a downloadable archive and sent via email. This is an asynchronous operation that processes in the background.
Authentication required:
  • X-Auth-ID - Your account auth_id (e.g., {auth_id})
  • X-Auth-Token - Your account Auth Token
  • Content-Type: application/json
Async Operation Workflow:
  1. Request is validated and queued as async task
  2. System processes recordings matching your filters
  3. Recordings are packaged as downloadable archive
  4. Download link is emailed to all recipient addresses
  5. Archive typically available within 15-60 minutes depending on volume
Important: Only one export request can run at a time per account. If an export is already in progress, you must wait for it to complete before starting a new one.

​
Request Body

​
Required Parameters

FieldTypeRequiredDescription
recipient.customer_accountarrayYesArray of email addresses to receive the download link. All emails must be in valid format. Example: ["admin@example.com", "user@example.com"]

​
Date Range Filters (Option 1)

FieldTypeRequiredDescription
fromstringNoStart date for export. Format: YYYY-MM-DD HH:MM:SS. Defaults to 7 days ago if not specified.
tostringNoEnd date for export. Format: YYYY-MM-DD HH:MM:SS. Defaults to current time if not specified.

​
Storage Duration Filters (Option 2 - Alternative to Date Range)

FieldTypeRequiredDescription
recording_storage_durationstringNoExport recordings exactly N days old. Example: "7" = recordings from exactly 7 days ago.
recording_storage_duration__gtestringNoExport recordings N days old or older. Example: "7" = recordings 7+ days old.
recording_storage_duration__gtstringNoExport recordings older than N days. Example: "7" = recordings 8+ days old.
recording_storage_duration__ltestringNoExport recordings N days old or newer. Example: "30" = recordings 0-30 days old.
recording_storage_duration__ltstringNoExport recordings newer than N days. Example: "30" = recordings 0-29 days old.

​
Additional Filters (Only for ranges ≤ 30 days)

FieldTypeRequiredDescription
from_numberstringNoFilter by caller phone number.
to_numberstringNoFilter by destination phone number.
call_uuidstringNoFilter by call UUID (also use for conference_uuid or mpc_uuid).
conference_namestringNoFilter by conference name (also use for mpc_name).
recording_formatstringNoFilter by format. Values: “mp3”, “wav”.
recording_idstringNoFilter by specific recording ID.
Additional filters (from_number, to_number, etc.) only apply when your date range or storage duration range is 30 days or less.

​
Constraints & Validation

  • Cannot combine from/to with storage duration filters
  • Cannot use __gt and __gte together (choose one)
  • Cannot use __lt and __lte together (choose one)
  • Maximum date range: 1 year (366 days)
  • Maximum storage duration range: 30 days
  • Filters only apply for ranges ≤ 30 days
  • When using range filters (__gte/__lte), both must be provided
  • Only one export can run at a time per account

​
Response

​
Success Response (202 Accepted)

The export request has been queued and will be processed in the background.
Response - 202 Accepted
{
    "api_id": "correlation-id-uuid",
    "status": "success"
}

​
Error Response (403 Forbidden)

Another export is already in progress.
Response - 403 Forbidden
{
    "status": "failure",
    "message": "An Export Historic Recording request is already in process. Please try again in sometime."
}

​
Error Response (400 Bad Request)

Invalid request parameters.
Response - 400 Bad Request
{
    "status": "failure",
    "message": "From/To cannot be used with recording storage duration"
}

​
Examples

​
Export Last 7 Days (Date Range)

cURL
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "2025-01-23 00:00:00",
    "to": "2025-01-30 23:59:59",
    "recipient": {
      "customer_account": ["admin@example.com"]
    }
  }'

​
Export Using Storage Duration

Export recordings exactly 7 days old.
cURL
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recording_storage_duration": "7",
    "recipient": {
      "customer_account": ["admin@example.com"]
    }
  }'

​
Export with Storage Duration Range

Export recordings between 7 and 30 days old.
cURL
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "recording_storage_duration__gte": "7",
    "recording_storage_duration__lte": "30",
    "recipient": {
      "customer_account": ["admin@example.com"]
    }
  }'

​
Export with Filters (Conference Recordings)

Export conference recordings in MP3 format from last 30 days.
cURL
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "2025-01-01 00:00:00",
    "to": "2025-01-30 23:59:59",
    "conference_name": "TeamMeeting",
    "recording_format": "mp3",
    "recipient": {
      "customer_account": ["admin@example.com", "backup@example.com"]
    }
  }'

​
Export with Phone Number Filter

cURL
curl -X POST https://api.vobiz.ai/api/v1/account/{auth_id}/export/recording/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": "2025-01-15 00:00:00",
    "to": "2025-01-30 23:59:59",
    "from_number": "+14155551234",
    "recipient": {
      "customer_account": ["admin@example.com"]
    }
  }'
Use Cases:
  • Backup recordings to external storage before deletion
  • Archive old recordings for compliance
  • Export specific conference recordings for review
  • Download recordings for specific phone numbers
  • Create monthly recording backups
For large date ranges (greater than 30 days), do not use additional filters. Export in smaller batches if you need filtered results.
Email Delivery:
  • Check spam/junk folders if not received within 1 hour
  • Verify email addresses are valid before requesting
  • Use multiple recipients for redundancy
  • Wait for completion email before starting another export