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=00000000-0000-4000-8000-0000000000a1&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' \
--header 'X-API-KEY: <x-api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/calling/history/download"
headers = {"X-API-KEY": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/calling/history/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "Call history export has been queued. You will receive an email shortly."
}{
"message": "Invalid date format"
}{
"message": "Invalid credentials"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "An unexpected error occurred"
}Download Call History
Export call history to CSV by email, filtered by date range, agent, status, call type, campaign, number or call ID, with optional post-call analysis columns.
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=00000000-0000-4000-8000-0000000000a1&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' \
--header 'X-API-KEY: <x-api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/calling/history/download"
headers = {"X-API-KEY": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/calling/history/download', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"message": "Call history export has been queued. You will receive an email shortly."
}{
"message": "Invalid date format"
}{
"message": "Invalid credentials"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "An unexpected error occurred"
}{"message": "Call history export has been queued. You will receive an email shortly."}. The download link arrives by email; large exports take several minutes.
Notes
call_typeisinbound,outboundorwebcall. The export covers every call that matches the filters.include_analysis=trueadds the platform and Advanced Analysis results.- The CSV holds call details, status and timestamps, agent and campaign, transcript and recording links, and custom variables.
- The emailed link is valid for 7 days and downloads a ZIP with one CSV.
- Recording links in the export may expire; fetch a fresh link from Get call details.
409means the same export is already running;429means too many exports are running, so try again later.
Authorizations
Headers
(Required) Your Ringg AI API key.
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
Filter calls starting from this date (ISO 8601 format with timezone)
"2025-09-25T00:00:00+05:30"
Filter calls up to this date (ISO 8601 format with timezone)
"2025-09-25T23:59:59+05:30"
Filter by agent ID(s) - can be repeated for multiple agents.
["00000000-0000-4000-8000-0000000000a1"]
Filter by call status.
registered, ongoing, retry, error, completed, failed, cancelled, forwarded "completed"
Include call analysis data (platform_analysis and client_analysis) in the export.
true
Filter by call type.
inbound, outbound, webcall "outbound"
Filter by bulk list ID.
"123e4567-e89b-12d3-a456-426614174000"
Filter by voicemail status.
false
Filter by caller phone number.
"+1234567890"
Filter by callee phone number.
"+14155550123"
Filter by specific call ID.
"550e8400-e29b-41d4-a716-446655440000"
Response
The export was queued. The download link arrives by email.
Confirmation that the export was queued.
"Call history export has been queued. You will receive an email shortly."
Was this page helpful?