Get Call Details
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/calling/call-details \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/calling/call-details"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/calling/call-details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"call_direction": "outbound",
"call_status": "completed",
"call_sub_status": "ACCEPTED",
"from_number": "+1234567890",
"to_number": "+14155550123",
"callee_name": "John Doe",
"agent_id": "agent-123-456",
"initiation_time": "2024-01-15T14:30:00Z",
"recording_url": "https://example.com/recordings/call-123.mp3",
"transcription_url": "[{\"bot\": \"Hi Priya, this is Asha from Acme Lending. Is this a good time to talk about your EMI?\"}, {\"user\": \"Yes, go ahead.\"}]"
}
}Get Call Details
Get one call by its call_id: status, numbers, agent, recording link and transcript, plus platform and advanced analysis when you set send_analysis=true.
GET
/
calling
/
call-details
Get Call Details
curl --request GET \
--url https://prod-api.ringg.ai/ca/api/v0/calling/call-details \
--header 'X-API-KEY: <api-key>'import requests
url = "https://prod-api.ringg.ai/ca/api/v0/calling/call-details"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://prod-api.ringg.ai/ca/api/v0/calling/call-details', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"call_direction": "outbound",
"call_status": "completed",
"call_sub_status": "ACCEPTED",
"from_number": "+1234567890",
"to_number": "+14155550123",
"callee_name": "John Doe",
"agent_id": "agent-123-456",
"initiation_time": "2024-01-15T14:30:00Z",
"recording_url": "https://example.com/recordings/call-123.mp3",
"transcription_url": "[{\"bot\": \"Hi Priya, this is Asha from Acme Lending. Is this a good time to talk about your EMI?\"}, {\"user\": \"Yes, go ahead.\"}]"
}
}Pass the call’s ID as
id, the call_id you got when placing the call or from a webhook.
Notes
transcription_urlis the transcript as a JSON-encoded string, not an array: parse it to get one object per turn (botoruser). It isnullwhen there is no transcript and"[]"for a call that never connected.platform_analysisis Ringg’s summary and classification;client_analysisis the result of your Advanced Analysis. Analysis runs after the call ends, and each key is left out of the response until it is ready. Leavesend_analysisoff when you only need status or the recording.call_metrics=trueadds the call’s eval results indata.metrics, one entry per metric withmetric_name,scoreandexplanation.recording_urlmay expire. Call this endpoint again for a fresh link, and download the recording if you need to keep it.- A
404means no call with that ID exists in the workspace that owns the API key.
Authorizations
Headers
(Required) Your Ringg AI API key.
Example:
"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Query Parameters
(Required) The unique identifier (UUID) of the call.
Example:
"550e8400-e29b-41d4-a716-446655440000"
(Optional) Include platform_analysis and client_analysis. Each key is left out of the response until its analysis is ready.
Example:
true
(Optional) Include eval results for the call in data.metrics.
Example:
true
Was this page helpful?