Skip to main content
GET
/
calling
/
history
Get Call History
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/calling/history \
  --header 'X-API-KEY: <x-api-key>'
{
  "calls": [
    {
      "id": "<string>",
      "to_number": "<string>",
      "name": "<string>",
      "status": "<string>",
      "transcript": "<string>",
      "audio_recording": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "agent": {
        "id": "<string>",
        "agent_name": "<string>"
      },
      "call_duration": 123,
      "call_attempt_time": "2023-11-07T05:31:56Z",
      "call_cost": 123,
      "call_type": "<string>",
      "inbound_from": "<string>"
    }
  ],
  "limit": 123,
  "offset": 123,
  "count": 123,
  "total": 123
}

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Query Parameters

​
start_date
string<date-time>

Filter calls starting from this date (ISO 8601 format).

​
end_date
string<date-time>

Filter calls up to this date (ISO 8601 format).

​
limit
integer
default:10

Maximum number of calls to return (default: 10).

​
offset
integer
default:0

Number of calls to skip (default: 0).

​
agent_id
string

Filter calls by assistant ID.

​
status
string

Filter calls by status (e.g., "completed", "failed").

​
download
boolean

Whether to download the results as a CSV file.

​
bulk_list_id
string

Filter calls by bulk list ID.

Response

Successful Response: Call history.

​
calls
object[]
​
limit
integer
​
offset
integer
​
count
integer
​
total
integer
⌘I