Skip to main content
POST
/
call
/
trigger
cURL
curl --request POST \
  --url https://api.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",
  "options": {
    "transcriptLanguage": "hi",
    "allowedOverallInterruptions": "True",
    "allowedInterruptionsInitially": "False",
    "ttsLanguage": "hi",
    "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"
}
'
{
  "responseCode": 200,
  "message": "Call triggered successfully",
  "data": {
    "callId": "1234"
  }
}

Authorizations

​
x-api-key
string
header
required

Authentication header containing API key from SubVerse dashboard.

Body

application/json
​
phoneNumber
string
required

User's phone number. Must be a valid phone number with country code, with or without '+' prefix.

​
agentName
string
required

Agent to be used for the call, find it in Agents sections in dashboard.

​
metadata
object

Customer'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.

​
agentNumber
string

Agent phone number used to place call. Default value will be any number set in telephony section (outbound number). Must be a valid phone number with country code, with or without '+' prefix.

​
options
object

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.

​
noOfRetries
number

Number of retries if call failed if provided

​
retryAfterHours
number

Retry at interval (in hrs) if provided

​
startWorkingHour
string

24 hour format (HH:MM). If provided call made before start hours will rescheduled at start hour of the day.

​
endWorkingHour
string

24 hour format (HH:MM). If provided call made after end hours will rescheduled at start hour of next day.

​
timezone
string

Call between start working hour and end working hour in timezone if provided [Default: Asia/Kolkata]

​
callPriority
number

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.

​
callOnDate
string

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”.

​
scheduleTime
string

Schedule customer's call at a specific future time. Follow ISO date format (YYYY-MM-DDTHH:MM:SSZ).

Response

200 - application/json

Returns error or success response

​
responseCode
integer
required

Always returns 200 value, with error or success response details in message.

​
message
string
required

Success or error message with description.

​
data
any | null

Additional details if available.