Sign in

v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
calling

Download Call History

Downloads call history data in CSV format. Supports bulk download of call records with optional filtering. Use 'include_analysis=true' to include call analysis data (platform_analysis and client_analysis) in the export.

post/calling/history/download

Query parameters

start_datestring date-time
Example:2025-09-25T00:00:00+05:30

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

end_datestring date-time
Example:2025-09-25T23:59:59+05:30

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

agent_idstring[]

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

[
  "830f767a-397e-4b39-82ff-235cd344e2f9"
]
status'registered' | 'ongoing' | 'retry' | 'error' | 'completed' | 'failed' | 'cancelled' | 'forwarded'
Example:completed

Filter by call status.

include_analysisboolean
Example:true

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

call_type'inbound' | 'outbound' | 'webcall'
Example:outbound

Filter by call type.

bulk_list_idstring
Example:123e4567-e89b-12d3-a456-426614174000

Filter by bulk list ID.

voicemailboolean

Filter by voicemail status.

from_numberstring
Example:+1234567890

Filter by caller phone number.

to_numberstring
Example:+0987654321

Filter by callee phone number.

call_idstring
Example:550e8400-e29b-41d4-a716-446655440000

Filter by specific call ID.

limitinteger
Example:5000

Maximum number of call records to download.

offsetinteger
Example:100

Number of call records to skip for pagination.

Headers

X-API-KEYstring required
Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Call history download successful

messagestring

Success message when email format is used

Example response

{
  "message": "Call history export has been queued. You will receive an email shortly."
}