Get Call Details

Retrieves detailed information about a specific call using its unique identifier. Use the send_analysis parameter to include analysis data in the response.

GET /calling/call-details

Get Call Details

cURL

curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/calling/call-details \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/calling/call-details"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<x-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));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.ringg.ai/ca/api/v0/calling/call-details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/calling/call-details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://prod-api.ringg.ai/ca/api/v0/calling/call-details")
  .header("X-API-KEY", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/calling/call-details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

200

basic_response

{
  "status": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "call_direction": "outbound",
    "call_status": "completed",
    "call_sub_status": "ACCEPTED",
    "from_number": "[phone]",
    "to_number": "+0987654321",
    "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": "Hello, how can I help you today?"
      },
      {
        "user": "I need information about my order"
      },
      {
        "bot": "I'd be happy to help you with that. Can you provide your order number?"
      },
      {
        "user": "Sure, it's ORDER-12345"
      }
    ]
  }
}

Fetch a detailed record for one call. Use this when a user opens a call detail view or when support needs the full context for a specific call_id.

When to use

• Show transcript, recording, status, and metadata for one call.
• Debug a failed or unexpected call.
• Fetch analysis for a call after receiving a webhook event.

Integration notes

• Pass the unique call ID as the id query parameter.
• Use send_analysis=true only when the caller needs analysis data; this keeps lightweight detail views faster.
• Store the call_id returned by call initiation and webhook payloads.
• The returned recording URL is valid for 24 hours after the call. Download and store the recording within that window if you need to retain it.

Headers

X-API-KEY · string · required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

id · string · required

(Required) The unique identifier (UUID) of the call.

Example:

"550e8400-e29b-41d4-a716-446655440000"

send_analysis · boolean · default: false

(Optional) Whether to include analysis data (platform_analysis and client_analysis) in the response.

Example:

true

Response

200

application/json

Call details retrieved successfully.

status · string

Example:

"success"

data · object

Show child attributes