Skip to main content
POST
/
calling
/
history
/
download
cURL
curl --request POST \
  --url 'https://prod-api.ringg.ai/ca/api/v0/calling/history/download?start_date=2025-09-25T00:00:00%2B05:30&end_date=2025-09-25T23:59:59%2B05:30&agent_id=830f767a-397e-4b39-82ff-235cd344e2f9&status=completed&include_analysis=true&call_type=outbound&bulk_list_id=123e4567-e89b-12d3-a456-426614174000&voicemail=false&from_number=%2B1234567890&to_number=%2B0987654321&call_id=550e8400-e29b-41d4-a716-446655440000&limit=5000&offset=0' \
  --header 'X-API-KEY: <x-api-key>'
{
  "message": "Call history export has been queued. You will receive an email shortly."
}

​
Download Call History

This endpoint queues call history data for download and sends it via email. The export includes comprehensive call records with optional filtering capabilities.
Email Delivery:
  • Large datasets may take several minutes to process
  • You’ll receive an email with the download link once processing is complete

​
Key Features

  • Comprehensive Data Export: Includes call details, transcripts, recordings, and metadata
  • Flexible Filtering: Filter by date range, agent, status, and more
  • Analysis Data: Optionally include call analysis and insights
  • Email Delivery: Secure download link sent to your email

​
Export Format

The download contains a CSV file with the following data:
  • Call basic information (ID, numbers, duration, cost)
  • Call status and timestamps
  • Agent and campaign details
  • Transcript and recording URLs
  • Custom variables and analysis data (when enabled)

​
Important Notes

  • Processing Time: Large exports may take 5-10 minutes to process
  • File Size: Very large datasets are automatically compressed
  • Recording Validity: Recording URLs in the export are valid for 24 hours after each call. Download any recordings you need to keep within that window.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
start_date
string<date-time>
default:2025-09-25T00:00:00+05:30

Filter calls starting from this date (ISO 8601 format with timezone)

Example:

"2025-09-25T00:00:00+05:30"

​
end_date
string<date-time>
default:2025-09-25T23:59:59+05:30

Filter calls up to this date (ISO 8601 format with timezone)

Example:

"2025-09-25T23:59:59+05:30"

​
agent_id
string[]

Filter by agent ID(s) - can be repeated for multiple agents.

Example:
["830f767a-397e-4b39-82ff-235cd344e2f9"]
​
status
enum<string>

Filter by call status.

Available options:
registered,
ongoing,
retry,
error,
completed,
failed,
cancelled,
forwarded
Example:

"completed"

​
include_analysis
boolean
default:false

Include call analysis data (platform_analysis and client_analysis) in the export.

Example:

true

​
call_type
enum<string>

Filter by call type.

Available options:
inbound,
outbound,
webcall
Example:

"outbound"

​
bulk_list_id
string

Filter by bulk list ID.

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
voicemail
boolean

Filter by voicemail status.

Example:

false

​
from_number
string

Filter by caller phone number.

Example:

"+1234567890"

​
to_number
string

Filter by callee phone number.

Example:

"+0987654321"

​
call_id
string

Filter by specific call ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
limit
integer
default:1000

Maximum number of call records to download.

Example:

5000

​
offset
integer
default:0

Number of call records to skip for pagination.

Example:

100

Response

Call history download successful

​
message
string

Success message when email format is used

Example:

"Call history export has been queued. You will receive an email shortly."