Ringg AI APIs for Developers

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: <x-api-key>'

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

Headers

X-API-KEY

string

required

(Required) Your Ringg AI API key.

Example:

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

Query Parameters

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

Call details retrieved successfully.

status

string

Example:

"success"

data

object

Show child attributes

data.id

string

The unique identifier of the call

Example:

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

data.call_direction

enum<string>

The direction of the call

Available options:

inbound,

outbound,

webcall

Example:

"outbound"

data.call_status

string

The current status of the call

Example:

"completed"

data.call_sub_status

string

The sub-status of the call

Example:

"ACCEPTED"

data.from_number

string

The phone number the call was made from

Example:

"+1234567890"

data.to_number

string

The phone number the call was made to

Example:

"+0987654321"

data.callee_name

string

The name of the person called

Example:

"John Doe"

data.agent_id

string

The ID of the agent that handled the call

Example:

"agent-123-456"

data.initiation_time

string<date-time>

When the call was initiated

Example:

"2024-01-15T14:30:00Z"

data.recording_url

string

URL to the call recording

Example:

"https://example.com/recordings/call-123.mp3"

data.transcription_url

object[]

Array of conversation turns between bot and user

Show child attributes

data.transcription_url.bot

string

Bot's message

data.transcription_url.user

string

User's message

Example:

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

data.platform_analysis

object

Platform-generated analysis of the call (only included when send_analysis=true)

Example:

{
  "sentiment": "positive",
  "call_outcome": "successful",
  "duration_score": 8.5
}

data.client_analysis

object

Client-specific analysis of the call (only included when send_analysis=true)

Example:

{
  "lead_score": 85,
  "follow_up_required": true,
  "customer_satisfaction": "high"
}

Terminate All Calls by Agent IDTerminates all active (registered/retry) calls associated with a specific agent across all campaigns.

⌘I

Get Call Details

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

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

Get Started

Webhooks Setup

API Reference

Get Call Details

Headers

Query Parameters

Response