Export Historical Recordings

POST

api

Account

{auth_id}

export

recording

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/export/recording/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "recipient": {
    "customer_account": [
      "admin@example.com"
    ]
  }
}
'

{
  "api_id": "correlation-id-uuid",
  "status": "success"
}

{
  "status": "failure",
  "message": "From/To cannot be used with recording storage duration"
}

{
  "status": "failure",
  "message": "An Export Historic Recording request is already in process. Please try again in sometime."
}

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:

Request is validated and queued as async task
System processes recordings matching your filters
Recordings are packaged as downloadable archive
Download link is emailed to all recipient addresses
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

Field	Type	Required	Description
`recipient.customer_account`	array	Yes	Array 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)

Field	Type	Required	Description
`from`	string	No	Start date for export. Format: YYYY-MM-DD HH:MM:SS. Defaults to 7 days ago if not specified.
`to`	string	No	End 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)

Field	Type	Required	Description
`recording_storage_duration`	string	No	Export recordings exactly N days old. Example: `"7"` = recordings from exactly 7 days ago.
`recording_storage_duration__gte`	string	No	Export recordings N days old or older. Example: `"7"` = recordings 7+ days old.
`recording_storage_duration__gt`	string	No	Export recordings older than N days. Example: `"7"` = recordings 8+ days old.
`recording_storage_duration__lte`	string	No	Export recordings N days old or newer. Example: `"30"` = recordings 0-30 days old.
`recording_storage_duration__lt`	string	No	Export recordings newer than N days. Example: `"30"` = recordings 0-29 days old.

Additional Filters (Only for ranges ≤ 30 days)

Field	Type	Required	Description
`from_number`	string	No	Filter by caller phone number.
`to_number`	string	No	Filter by destination phone number.
`call_uuid`	string	No	Filter by call UUID (also use for conference_uuid or mpc_uuid).
`conference_name`	string	No	Filter by conference name (also use for mpc_name).
`recording_format`	string	No	Filter by format. Values: “mp3”, “wav”.
`recording_id`	string	No	Filter 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

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"

Body

application/json

recipient

object

required

Email delivery targets for the export archive.

Show child attributes

from

string

Start date for the export. Format: YYYY-MM-DD HH:MM:SS. Defaults to 7 days ago.

Example:

"2025-01-23 00:00:00"

string

End date for the export. Format: YYYY-MM-DD HH:MM:SS. Defaults to the current time.

Example:

"2025-01-30 23:59:59"

recording_storage_duration

string

Export recordings exactly N days old. "7" exports recordings from exactly 7 days ago.

Example:

"7"

recording_storage_duration__gte

string

Export recordings N days old or older. "7" exports recordings 7 days old and older.

Example:

"7"

recording_storage_duration__gt

string

Export recordings older than N days. "7" exports recordings 8 days old and older.

Example:

"7"

recording_storage_duration__lte

string

Export recordings N days old or newer. "30" exports recordings 0-30 days old.

Example:

"30"

recording_storage_duration__lt

string

Export recordings newer than N days. "30" exports recordings 0-29 days old.

Example:

"30"

from_number

string

Filter by caller phone number. Applies when the range is 30 days or less.

Example:

"+14155551234"

to_number

string

Filter by destination phone number. Applies when the range is 30 days or less.

call_uuid

string

Filter by call UUID. Also use this field for a conference_uuid or mpc_uuid. Applies when the range is 30 days or less.

conference_name

string

Filter by conference name. Also use this field for an mpc_name. Applies when the range is 30 days or less.

Example:

"TeamMeeting"

recording_format

enum<string>

Filter by recording format. Applies when the range is 30 days or less.

Available options:

mp3,

wav

recording_id

string

Filter by a specific recording ID. Applies when the range is 30 days or less.

Response

Export request queued. The archive download link is emailed to the recipients when processing completes.

api_id

string

status

string

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/export/recording/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "recipient": {
    "customer_account": [
      "admin@example.com"
    ]
  }
}
'

{
  "api_id": "correlation-id-uuid",
  "status": "success"
}

{
  "status": "failure",
  "message": "From/To cannot be used with recording storage duration"
}

{
  "status": "failure",
  "message": "An Export Historic Recording request is already in process. Please try again in sometime."
}

​Request Body

​Required Parameters

​Date Range Filters (Option 1)

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

​Additional Filters (Only for ranges ≤ 30 days)

​Constraints & Validation

​Response

​Success Response (202 Accepted)

​Error Response (403 Forbidden)

​Error Response (400 Bad Request)

​Examples

​Export Last 7 Days (Date Range)

​Export Using Storage Duration

​Export with Storage Duration Range

​Export with Filters (Conference Recordings)

​Export with Phone Number Filter

Authorizations

Path Parameters

Body

Response

Request Body

Required Parameters

Date Range Filters (Option 1)

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

Additional Filters (Only for ranges ≤ 30 days)

Constraints & Validation

Response

Success Response (202 Accepted)

Error Response (403 Forbidden)

Error Response (400 Bad Request)

Examples

Export Last 7 Days (Date Range)

Export Using Storage Duration

Export with Storage Duration Range

Export with Filters (Conference Recordings)

Export with Phone Number Filter