Skip to main content
POST
/
calling
/
outbound
/
individual
Initiate Individual Call
curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/calling/outbound/individual \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "name": "John Doe",
  "mobile_number": "+1234567890",
  "agent_id": "830f767a-397e-4b39-82ff-235cd344e2f9",
  "from_number": "+1987654321",
  "custom_args_values": {
    "company_name": "XYZ Corp",
    "appointment_date": "2025-01-20",
    "product_name": "Premium Service"
  },
  "call_config": {
    "idle_timeout_warning": 10,
    "idle_timeout_end": 15,
    "max_call_length": 300,
    "call_retry_config": {
      "retry_count": 3,
      "retry_busy": 30,
      "retry_not_picked": 30,
      "retry_failed": 30
    },
    "call_time": {
      "call_start_time": "08:00",
      "call_end_time": "20:00",
      "timezone": "Asia/Kolkata"
    }
  }
}'
{
  "Call Status": "Call initiated successfully",
  "data": {
    "Unique Call ID": "550e8400-e29b-41d4-a716-446655440000",
    "Call Direction": "outbound",
    "Call Status": "ongoing",
    "From Number": "+1987654321",
    "To Number": "+1234567890",
    "Initiated at": "2025-01-15T10:30:00Z",
    "Agent ID": "830f767a-397e-4b39-82ff-235cd344e2f9",
    "message": "Call initiated successfully"
  }
}

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Body

application/json
​
name
string
required

The name of the person to call

Example:

"John Doe"

​
mobile_number
string
required

The phone number to call

Example:

"+1234567890"

​
agent_id
string
required

UUID of the agent that will handle the call

Example:

"830f767a-397e-4b39-82ff-235cd344e2f9"

​
from_number
string
required

The phone number to call from (with country code)

Example:

"+1987654321"

​
custom_args_values
object

Custom variables that will be replaced in the agent's prompt using @{{variable_name}} syntax

Example:
{
  "company_name": "XYZ Corp",
  "appointment_date": "2025-01-20",
  "product_name": "Premium Service"
}
​
call_config
object

Override default call configuration

Example:
{
  "idle_timeout_warning": 10,
  "idle_timeout_end": 15,
  "max_call_length": 300,
  "call_retry_config": {
    "retry_count": 3,
    "retry_busy": 30,
    "retry_not_picked": 30,
    "retry_failed": 30
  },
  "call_time": {
    "call_start_time": "08:00",
    "call_end_time": "20:00",
    "timezone": "Asia/Kolkata"
  }
}

Response

Successful Response: Details about the initiated call.

​
Call Status
string
Example:

"Call initiated successfully"

​
data
object
⌘I