Initiate Individual Call

POST

calling

outbound

individual

Initiate Individual Call

curl --request POST \
  --url https://prod-api.revenueable.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",
      "scheduled_at": "2025-11-24T01:55:00"
    }
  }
}
'

import requests

url = "https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual"

payload = {
    "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",
            "scheduled_at": "2025-11-24T01:55:00"
        }
    }
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
        scheduled_at: '2025-11-24T01:55:00'
      }
    }
  })
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual', 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.revenueable.ai/ca/api/v0/calling/outbound/individual",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
                'scheduled_at' => '2025-11-24T01:55:00'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}"

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

{
  "status": "success",
  "data": {
    "call_id": "31106b7c-9d02-4723-8b07-5bb8d90240cb",
    "call_direction": "outbound",
    "call_status": "ongoing",
    "initiated_at": "2025-11-24T07:33:49.629642",
    "agent_id": "a31f36c4-c8ea-4c4b-9ad6-743dabacafbd",
    "custom_args_values": {
      "callee_name": "abhishek",
      "mobile_number": "+912332423423",
      "transfer_to": "+917404243687"
    }
  },
  "message": "Call initiated successfully"
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Missing required field"
  }
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Start a new outbound call to a specific recipient using your configured AI agent. This endpoint supports both immediate calls and scheduled calls for future execution.

Phone Number Format:

All phone numbers must include country code (e.g., +91 for India, +1 for US)
Invalid formats will result in call failure

Scheduled Calls

Use scheduled_at to schedule calls for a specific date and time:

"call_time": {
  "call_start_time": "09:00",
  "call_end_time": "18:00", 
  "timezone": "Asia/Kolkata",
  "scheduled_at": "2025-11-24T01:55:00"
}

Scheduled Calls: When scheduled_at is provided, the call will be queued and executed at that specific date and time. The time window (call_start_time and call_end_time) still applies as additional validation. Use this for precise scheduling of important calls.

Custom Variables

Use the custom_args_values field to pass dynamic data to your agent:

Reference variables in your agent prompt using @{{variable_name}} syntax
Common variables: callee_name, company_name, appointment_date, etc.
Variables are replaced with actual values during the call

Important Notes

Agent Configuration: Ensure your agent is properly configured with prompts and variables
From Numbers: Use phone numbers that are provisioned in your workspace
Credits: Each call consumes credits based on duration and destination
Retry Logic: Configure retry attempts for busy/failed calls in call_config

Headers

X-API-KEY

string

required

(Required) Your Revenueable AI API key.

Example:

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

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 (must include country code, e.g., +91 for India)

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

Show child attributes

Example:

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

call_config

object

(Optional) Override default call configuration

Show child attributes

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",
    "scheduled_at": "2025-11-24T01:55:00"
  }
}

Response

Successful Response: Details about the initiated call.

status

string

Example:

"success"

data

object

Show child attributes

message

string

Example:

"Call initiated successfully"

Upload Campaign Contact ListUploads a contact list for a campaign. Accepts a CSV file and campaign configuration as form data.

Initiate Individual Call

curl --request POST \
  --url https://prod-api.revenueable.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",
      "scheduled_at": "2025-11-24T01:55:00"
    }
  }
}
'

import requests

url = "https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual"

payload = {
    "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",
            "scheduled_at": "2025-11-24T01:55:00"
        }
    }
}
headers = {
    "X-API-KEY": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
        scheduled_at: '2025-11-24T01:55:00'
      }
    }
  })
};

fetch('https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual', 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.revenueable.ai/ca/api/v0/calling/outbound/individual",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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',
                'scheduled_at' => '2025-11-24T01:55:00'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual"

	payload := strings.NewReader("{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual")
  .header("X-API-KEY", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.revenueable.ai/ca/api/v0/calling/outbound/individual")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Doe\",\n  \"mobile_number\": \"+1234567890\",\n  \"agent_id\": \"830f767a-397e-4b39-82ff-235cd344e2f9\",\n  \"from_number\": \"+1987654321\",\n  \"custom_args_values\": {\n    \"company_name\": \"XYZ Corp\",\n    \"appointment_date\": \"2025-01-20\",\n    \"product_name\": \"Premium Service\"\n  },\n  \"call_config\": {\n    \"idle_timeout_warning\": 10,\n    \"idle_timeout_end\": 15,\n    \"max_call_length\": 300,\n    \"call_retry_config\": {\n      \"retry_count\": 3,\n      \"retry_busy\": 30,\n      \"retry_not_picked\": 30,\n      \"retry_failed\": 30\n    },\n    \"call_time\": {\n      \"call_start_time\": \"08:00\",\n      \"call_end_time\": \"20:00\",\n      \"timezone\": \"Asia/Kolkata\",\n      \"scheduled_at\": \"2025-11-24T01:55:00\"\n    }\n  }\n}"

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

{
  "status": "success",
  "data": {
    "call_id": "31106b7c-9d02-4723-8b07-5bb8d90240cb",
    "call_direction": "outbound",
    "call_status": "ongoing",
    "initiated_at": "2025-11-24T07:33:49.629642",
    "agent_id": "a31f36c4-c8ea-4c4b-9ad6-743dabacafbd",
    "custom_args_values": {
      "callee_name": "abhishek",
      "mobile_number": "+912332423423",
      "transfer_to": "+917404243687"
    }
  },
  "message": "Call initiated successfully"
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Missing required field"
  }
}

{
  "error": {
    "code": "401 Unauthorized",
    "message": "Invalid credentials"
  }
}

{
  "error": {
    "code": "500 Internal Server Error",
    "message": "An unexpected error occurred on the server."
  }
}

Get Started

Webhooks Setup

API Reference

Initiate Individual Call