curl https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const call = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/calls/call_xyz789',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'include': 'transcript,recording'}
)
call = response.json()
{
"id": "call_xyz789",
"status": "completed",
"phone_number": "+14155551234",
"from_number": "+18005551234",
"agent_id": "agent_abc123",
"duration": 245,
"transcript": [
{
"role": "agent",
"content": "Hello! This is Sarah from Acme Corp. How are you today?",
"timestamp": 0.0
},
{
"role": "user",
"content": "Hi Sarah, I'm doing well. What's this call about?",
"timestamp": 3.2
}
],
"recording_url": "https://storage.ringyo.ai/recordings/call_xyz789.mp3",
"metadata": {
"customer_id": "cust_456",
"campaign": "follow_up"
},
"created_at": "2024-01-15T10:30:00Z",
"ended_at": "2024-01-15T10:34:05Z"
}
{
"error": {
"code": "call_not_found",
"message": "The specified call does not exist"
}
}
Calls
Get Call
Retrieve details of a specific call
GET
/
v1
/
calls
/
{call_id}
curl https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const call = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/calls/call_xyz789',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'include': 'transcript,recording'}
)
call = response.json()
{
"id": "call_xyz789",
"status": "completed",
"phone_number": "+14155551234",
"from_number": "+18005551234",
"agent_id": "agent_abc123",
"duration": 245,
"transcript": [
{
"role": "agent",
"content": "Hello! This is Sarah from Acme Corp. How are you today?",
"timestamp": 0.0
},
{
"role": "user",
"content": "Hi Sarah, I'm doing well. What's this call about?",
"timestamp": 3.2
}
],
"recording_url": "https://storage.ringyo.ai/recordings/call_xyz789.mp3",
"metadata": {
"customer_id": "cust_456",
"campaign": "follow_up"
},
"created_at": "2024-01-15T10:30:00Z",
"ended_at": "2024-01-15T10:34:05Z"
}
{
"error": {
"code": "call_not_found",
"message": "The specified call does not exist"
}
}
Request
Retrieve detailed information about a specific call, including its status, duration, transcript, and recording URL.Headers
string
required
Bearer token for authentication. Format:
Bearer YOUR_API_KEYPath Parameters
string
required
The unique identifier of the call (e.g.,
call_xyz789)Query Parameters
string
Comma-separated list of additional data to include:
transcript, recording, analysisResponse
string
Unique identifier for the call
string
Current status:
queued, ringing, in_progress, completed, failed, no_answer, busystring
The destination phone number
string
The phone number the call was made from
string
The agent ID used for the call
integer
Call duration in seconds (only present when completed)
array
Array of transcript segments (when
include=transcript)string
URL to the call recording (when
include=recording and recording is available)object
AI-generated analysis of the call (when
include=analysis)object
Custom metadata attached to the call
string
ISO 8601 timestamp of when the call was created
string
ISO 8601 timestamp of when the call ended
curl https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording \
-H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch(
'https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording',
{
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
},
}
);
const call = await response.json();
import requests
response = requests.get(
'https://api.ringyo.ai/v1/calls/call_xyz789',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
params={'include': 'transcript,recording'}
)
call = response.json()
{
"id": "call_xyz789",
"status": "completed",
"phone_number": "+14155551234",
"from_number": "+18005551234",
"agent_id": "agent_abc123",
"duration": 245,
"transcript": [
{
"role": "agent",
"content": "Hello! This is Sarah from Acme Corp. How are you today?",
"timestamp": 0.0
},
{
"role": "user",
"content": "Hi Sarah, I'm doing well. What's this call about?",
"timestamp": 3.2
}
],
"recording_url": "https://storage.ringyo.ai/recordings/call_xyz789.mp3",
"metadata": {
"customer_id": "cust_456",
"campaign": "follow_up"
},
"created_at": "2024-01-15T10:30:00Z",
"ended_at": "2024-01-15T10:34:05Z"
}
{
"error": {
"code": "call_not_found",
"message": "The specified call does not exist"
}
}
Error Codes
| Code | Description |
|---|---|
call_not_found | The specified call_id does not exist |
unauthorized | You don’t have access to this call |