Skip to main content
GET
/
v1
/
calls
/
{call_id}
curl https://api.ringyo.ai/v1/calls/call_xyz789?include=transcript,recording \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "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"
}

​
Request

Retrieve detailed information about a specific call, including its status, duration, transcript, and recording URL.

​
Headers

​
Authorization
string
required
Bearer token for authentication. Format: Bearer YOUR_API_KEY

​
Path Parameters

​
call_id
string
required
The unique identifier of the call (e.g., call_xyz789)

​
Query Parameters

​
include
string
Comma-separated list of additional data to include: transcript, recording, analysis

​
Response

​
id
string
Unique identifier for the call
​
status
string
Current status: queued, ringing, in_progress, completed, failed, no_answer, busy
​
phone_number
string
The destination phone number
​
from_number
string
The phone number the call was made from
​
agent_id
string
The agent ID used for the call
​
duration
integer
Call duration in seconds (only present when completed)
​
transcript
array
Array of transcript segments (when include=transcript)
​
recording_url
string
URL to the call recording (when include=recording and recording is available)
​
analysis
object
AI-generated analysis of the call (when include=analysis)
​
metadata
object
Custom metadata attached to the call
​
created_at
string
ISO 8601 timestamp of when the call was created
​
ended_at
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"

{
  "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 Codes

CodeDescription
call_not_foundThe specified call_id does not exist
unauthorizedYou don’t have access to this call