v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
calling

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

Query parameters

idstring required
Example:550e8400-e29b-41d4-a716-446655440000

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

send_analysisboolean
Example:true

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

Headers

X-API-KEYstring required
Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Call details retrieved successfully.

statusstring

Example response

{
  "status": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "call_direction": "outbound",
    "call_status": "completed",
    "call_sub_status": "ACCEPTED",
    "from_number": "+1234567890",
    "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"
      }
    ],
    "platform_analysis": {
      "sentiment": "positive",
      "call_outcome": "successful",
      "duration_score": 8.5
    },
    "client_analysis": {
      "lead_score": 85,
      "follow_up_required": true,
      "customer_satisfaction": "high"
    }
  }
}