cURL
curl --request POST \
--url https://api-v2.subverseai.com/api/call/trigger \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phoneNumber": "+912298765432",
"metadata": {
"email": "[email protected]",
"name": "John Doe",
"id": "JD75816540"
},
"agentNumber": "+912298765432",
"agentName": "test_case",
"agentVersion": "default",
"options": {
"transcriptLanguage": "hi",
"allowedOverallInterruptions": "True",
"allowedInterruptionsInitially": "False",
"ttsLanguage": "hi",
"ttsGender": "male",
"voiceId": "IvLWq57RKibBrqZGpQrC",
"speed": "2",
"transferNumber": "+912298765432",
"communicationMethod": "two_way",
"dtmfEnabled": "False",
"initialMessage": "Hi, ${name} how can I assist you today?",
"additionalContext": "The caller is asking about a refund request submitted yesterday."
},
"noOfRetries": 1,
"retryAfterHours": 1,
"startWorkingHour": "09:00",
"endWorkingHour": "20:00",
"timezone": "Asia/Kolkata",
"callPriority": 3,
"callOnDate": "2025-08-08",
"scheduleTime": "2025-08-08T08:14:57Z"
}
'import requests
url = "https://api-v2.subverseai.com/api/call/trigger"
payload = {
"phoneNumber": "+912298765432",
"metadata": {
"email": "[email protected]",
"name": "John Doe",
"id": "JD75816540"
},
"agentNumber": "+912298765432",
"agentName": "test_case",
"agentVersion": "default",
"options": {
"transcriptLanguage": "hi",
"allowedOverallInterruptions": "True",
"allowedInterruptionsInitially": "False",
"ttsLanguage": "hi",
"ttsGender": "male",
"voiceId": "IvLWq57RKibBrqZGpQrC",
"speed": "2",
"transferNumber": "+912298765432",
"communicationMethod": "two_way",
"dtmfEnabled": "False",
"initialMessage": "Hi, ${name} how can I assist you today?",
"additionalContext": "The caller is asking about a refund request submitted yesterday."
},
"noOfRetries": 1,
"retryAfterHours": 1,
"startWorkingHour": "09:00",
"endWorkingHour": "20:00",
"timezone": "Asia/Kolkata",
"callPriority": 3,
"callOnDate": "2025-08-08",
"scheduleTime": "2025-08-08T08:14:57Z"
}
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phoneNumber: '+912298765432',
metadata: {email: '[email protected]', name: 'John Doe', id: 'JD75816540'},
agentNumber: '+912298765432',
agentName: 'test_case',
agentVersion: 'default',
options: {
transcriptLanguage: 'hi',
allowedOverallInterruptions: 'True',
allowedInterruptionsInitially: 'False',
ttsLanguage: 'hi',
ttsGender: 'male',
voiceId: 'IvLWq57RKibBrqZGpQrC',
speed: '2',
transferNumber: '+912298765432',
communicationMethod: 'two_way',
dtmfEnabled: 'False',
initialMessage: 'Hi, ${name} how can I assist you today?',
additionalContext: 'The caller is asking about a refund request submitted yesterday.'
},
noOfRetries: 1,
retryAfterHours: 1,
startWorkingHour: '09:00',
endWorkingHour: '20:00',
timezone: 'Asia/Kolkata',
callPriority: 3,
callOnDate: '2025-08-08',
scheduleTime: '2025-08-08T08:14:57Z'
})
};
fetch('https://api-v2.subverseai.com/api/call/trigger', 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://api-v2.subverseai.com/api/call/trigger",
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([
'phoneNumber' => '+912298765432',
'metadata' => [
'email' => '[email protected]',
'name' => 'John Doe',
'id' => 'JD75816540'
],
'agentNumber' => '+912298765432',
'agentName' => 'test_case',
'agentVersion' => 'default',
'options' => [
'transcriptLanguage' => 'hi',
'allowedOverallInterruptions' => 'True',
'allowedInterruptionsInitially' => 'False',
'ttsLanguage' => 'hi',
'ttsGender' => 'male',
'voiceId' => 'IvLWq57RKibBrqZGpQrC',
'speed' => '2',
'transferNumber' => '+912298765432',
'communicationMethod' => 'two_way',
'dtmfEnabled' => 'False',
'initialMessage' => 'Hi, ${name} how can I assist you today?',
'additionalContext' => 'The caller is asking about a refund request submitted yesterday.'
],
'noOfRetries' => 1,
'retryAfterHours' => 1,
'startWorkingHour' => '09:00',
'endWorkingHour' => '20:00',
'timezone' => 'Asia/Kolkata',
'callPriority' => 3,
'callOnDate' => '2025-08-08',
'scheduleTime' => '2025-08-08T08:14:57Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api-v2.subverseai.com/api/call/trigger"
payload := strings.NewReader("{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api-v2.subverseai.com/api/call/trigger")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.subverseai.com/api/call/trigger")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}"
response = http.request(request)
puts response.read_body{
"responseCode": 200,
"message": "Call triggered successfully",
"data": {
"callId": "1234"
}
}Call
Trigger Call
Place a call to a customer using your chosen agent and settings.
POST
/
call
/
trigger
cURL
curl --request POST \
--url https://api-v2.subverseai.com/api/call/trigger \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phoneNumber": "+912298765432",
"metadata": {
"email": "[email protected]",
"name": "John Doe",
"id": "JD75816540"
},
"agentNumber": "+912298765432",
"agentName": "test_case",
"agentVersion": "default",
"options": {
"transcriptLanguage": "hi",
"allowedOverallInterruptions": "True",
"allowedInterruptionsInitially": "False",
"ttsLanguage": "hi",
"ttsGender": "male",
"voiceId": "IvLWq57RKibBrqZGpQrC",
"speed": "2",
"transferNumber": "+912298765432",
"communicationMethod": "two_way",
"dtmfEnabled": "False",
"initialMessage": "Hi, ${name} how can I assist you today?",
"additionalContext": "The caller is asking about a refund request submitted yesterday."
},
"noOfRetries": 1,
"retryAfterHours": 1,
"startWorkingHour": "09:00",
"endWorkingHour": "20:00",
"timezone": "Asia/Kolkata",
"callPriority": 3,
"callOnDate": "2025-08-08",
"scheduleTime": "2025-08-08T08:14:57Z"
}
'import requests
url = "https://api-v2.subverseai.com/api/call/trigger"
payload = {
"phoneNumber": "+912298765432",
"metadata": {
"email": "[email protected]",
"name": "John Doe",
"id": "JD75816540"
},
"agentNumber": "+912298765432",
"agentName": "test_case",
"agentVersion": "default",
"options": {
"transcriptLanguage": "hi",
"allowedOverallInterruptions": "True",
"allowedInterruptionsInitially": "False",
"ttsLanguage": "hi",
"ttsGender": "male",
"voiceId": "IvLWq57RKibBrqZGpQrC",
"speed": "2",
"transferNumber": "+912298765432",
"communicationMethod": "two_way",
"dtmfEnabled": "False",
"initialMessage": "Hi, ${name} how can I assist you today?",
"additionalContext": "The caller is asking about a refund request submitted yesterday."
},
"noOfRetries": 1,
"retryAfterHours": 1,
"startWorkingHour": "09:00",
"endWorkingHour": "20:00",
"timezone": "Asia/Kolkata",
"callPriority": 3,
"callOnDate": "2025-08-08",
"scheduleTime": "2025-08-08T08:14:57Z"
}
headers = {
"x-api-key": "<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': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phoneNumber: '+912298765432',
metadata: {email: '[email protected]', name: 'John Doe', id: 'JD75816540'},
agentNumber: '+912298765432',
agentName: 'test_case',
agentVersion: 'default',
options: {
transcriptLanguage: 'hi',
allowedOverallInterruptions: 'True',
allowedInterruptionsInitially: 'False',
ttsLanguage: 'hi',
ttsGender: 'male',
voiceId: 'IvLWq57RKibBrqZGpQrC',
speed: '2',
transferNumber: '+912298765432',
communicationMethod: 'two_way',
dtmfEnabled: 'False',
initialMessage: 'Hi, ${name} how can I assist you today?',
additionalContext: 'The caller is asking about a refund request submitted yesterday.'
},
noOfRetries: 1,
retryAfterHours: 1,
startWorkingHour: '09:00',
endWorkingHour: '20:00',
timezone: 'Asia/Kolkata',
callPriority: 3,
callOnDate: '2025-08-08',
scheduleTime: '2025-08-08T08:14:57Z'
})
};
fetch('https://api-v2.subverseai.com/api/call/trigger', 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://api-v2.subverseai.com/api/call/trigger",
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([
'phoneNumber' => '+912298765432',
'metadata' => [
'email' => '[email protected]',
'name' => 'John Doe',
'id' => 'JD75816540'
],
'agentNumber' => '+912298765432',
'agentName' => 'test_case',
'agentVersion' => 'default',
'options' => [
'transcriptLanguage' => 'hi',
'allowedOverallInterruptions' => 'True',
'allowedInterruptionsInitially' => 'False',
'ttsLanguage' => 'hi',
'ttsGender' => 'male',
'voiceId' => 'IvLWq57RKibBrqZGpQrC',
'speed' => '2',
'transferNumber' => '+912298765432',
'communicationMethod' => 'two_way',
'dtmfEnabled' => 'False',
'initialMessage' => 'Hi, ${name} how can I assist you today?',
'additionalContext' => 'The caller is asking about a refund request submitted yesterday.'
],
'noOfRetries' => 1,
'retryAfterHours' => 1,
'startWorkingHour' => '09:00',
'endWorkingHour' => '20:00',
'timezone' => 'Asia/Kolkata',
'callPriority' => 3,
'callOnDate' => '2025-08-08',
'scheduleTime' => '2025-08-08T08:14:57Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://api-v2.subverseai.com/api/call/trigger"
payload := strings.NewReader("{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api-v2.subverseai.com/api/call/trigger")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.subverseai.com/api/call/trigger")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phoneNumber\": \"+912298765432\",\n \"metadata\": {\n \"email\": \"[email protected]\",\n \"name\": \"John Doe\",\n \"id\": \"JD75816540\"\n },\n \"agentNumber\": \"+912298765432\",\n \"agentName\": \"test_case\",\n \"agentVersion\": \"default\",\n \"options\": {\n \"transcriptLanguage\": \"hi\",\n \"allowedOverallInterruptions\": \"True\",\n \"allowedInterruptionsInitially\": \"False\",\n \"ttsLanguage\": \"hi\",\n \"ttsGender\": \"male\",\n \"voiceId\": \"IvLWq57RKibBrqZGpQrC\",\n \"speed\": \"2\",\n \"transferNumber\": \"+912298765432\",\n \"communicationMethod\": \"two_way\",\n \"dtmfEnabled\": \"False\",\n \"initialMessage\": \"Hi, ${name} how can I assist you today?\",\n \"additionalContext\": \"The caller is asking about a refund request submitted yesterday.\"\n },\n \"noOfRetries\": 1,\n \"retryAfterHours\": 1,\n \"startWorkingHour\": \"09:00\",\n \"endWorkingHour\": \"20:00\",\n \"timezone\": \"Asia/Kolkata\",\n \"callPriority\": 3,\n \"callOnDate\": \"2025-08-08\",\n \"scheduleTime\": \"2025-08-08T08:14:57Z\"\n}"
response = http.request(request)
puts response.read_body{
"responseCode": 200,
"message": "Call triggered successfully",
"data": {
"callId": "1234"
}
}Authorizations
Authentication header containing API key from SubVerse dashboard.
Body
application/json
User's phone number. Must be a valid phone number with country code, with or without '+' prefix.
Agent to be used for the call, find it in Agents sections in dashboard.
Determines which version of the agent to use for the call. Defaults to "default".
Required range:
x >= 0Customer's details to be used in the call, use them in agent initial and system prompt as ${variable_name} format. These will be replaced by actual value of the variables.
Channel to be used for the call (SIP Outbound). If provided, number will be randomly picked from the configured channel.
Agent phone number used to place call. Default value will be any number set in communication channel section (SIP Outbound). Must be a valid phone number with country code, with or without '+' prefix.
Default values as defined in the Agents section in dashboard. Use this if you want to override those options. E.g. if you want to change the language, voice, initial prompt, etc.
Show child attributes
Show child attributes
Number of retries if call failed if provided
Retry at interval (in hrs) if provided
24 hour format (HH:MM). If provided call made before start hours will rescheduled at start hour of the day.
24 hour format (HH:MM). If provided call made after end hours will rescheduled at start hour of next day.
Call between start working hour and end working hour in timezone if provided [Default: Asia/Kolkata]
Defines the urgency of the call on a scale of 1 to 100, where 1 is the highest priority and 100 is the lowest. Default is 10.
The date by which the call must be placed. If the call is not made on same day, it is marked as expired and will not trigger. Any valid date format is Any valid date format is “YYYY-MM-DD”.
Schedule customer's call at a specific future time. Follow ISO date format (YYYY-MM-DDTHH:MM:SSZ).