Trigger Call

POST

campaign

trigger-call

curl --request POST \
  --url https://subverseai.com/api/campaign/trigger-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "phone_number": "+912298765432",
  "metadata": {
    "email": "[email protected]",
    "name": "John Doe",
    "id": "JD75816540"
  },
  "botNumber": "+912298765432",
  "useCase": "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."
  }
}'

{
  "responseCode": 200,
  "message": "Call triggered successfully",
  "data": null
}

Authorizations

x-api-key

string

header

required

Authentication header containing API key from SubVerse dashboard.

Body

application/json

phone_number

string

required

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

useCase

string

required

Use case to be used for the call, find it in Voice Agents sections in dashboard.

metadata

object

Customer's details to be used in the call, use them in voice agent initial and system prompt as ${variable_name} format. These will be replaced by actual value of the variables.

botNumber

string

Voice agent phone number used to place call. Default value: bot number mentioned in Voice Agents sections in dashboard. Must be a valid phone number with country code, with or without '+' prefix.

options

object

Default values as defined in the Voice 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.

options.transcriptLanguage

enum<string>

The language used to capture and understand what the user says.

Available options:

en-IN,

hi

options.ttsLanguage

enum<string>

Default language of the voice agent used to speak with the user.

Available options:

en,

hi

Example:

"en"

options.voiceId

enum<string>

The specific voice if that the voice agent will use. You can also provide custom voice id other than the ones mentioned here. Recommended list of Indian voices below: M LEO ENG - 'TNHbwIMY5QmLqZdvjhNn' F MONIKA ENG - '2zRM7PkgwBPiau2jvVXc' F RIYA ENG - 'vYENaCJHl4vFKNDYPr8y' M LEO BOTH - 'IvLWq57RKibBrqZGpQrC' F MONIKA BOTH - '1qEiC6qsybMkmnNdVMbK' F RIYA BOTH - 'mActWQg9kibLro6Z2ouY'

Available options:

TNHbwIMY5QmLqZdvjhNn,

2zRM7PkgwBPiau2jvVXc,

vYENaCJHl4vFKNDYPr8y,

IvLWq57RKibBrqZGpQrC,

1qEiC6qsybMkmnNdVMbK,

mActWQg9kibLro6Z2ouY,

mention any other custom voice id

options.initialMessage

string

The initial greetings message. The dynamic variables (e.g. ${name}) will be replaced by actual value provided in customer_details or metadata.

options.additionalContext

string

Extra context provided to the voice agent (e.g. details that are unique to the target customer category, which is not mentioned in the system prompt). The dynamic variables (e.g. ${name}) will be replaced by actual value provided in customer_details or metadata.

options.allowedOverallInterruptions

enum<string>

Whether the voice agent should stop speaking upon user interruption during the entire conversation.

Available options:

True,

False

options.allowedInterruptionsInitially

enum<string>

Whether the voice agent should stop speaking upon user interruption while initial greetings message is playing.

Available options:

True,

False

options.speed

enum<string>

How fast or slow the voice agent should talk.

Available options:

0,

1,

2,

3

options.transferNumber

string

Human agent's phone number to transfer the call in case of escalations. Must be a valid phone number with country code, with or without '+' prefix.

options.communicationMethod

enum<string>

Whether the communication is two-way (inetractive conversation) or one-way (speak only the initial prompt and hang up).

Available options:

two_way,

one_way

options.dtmfEnabled

enum<string>

Whether the user can press buttons on their phone (like 'Press 1 for support') to interact with the agent.

Available options:

True,

False

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.

Trigger Call

curl --request POST \
  --url https://subverseai.com/api/campaign/trigger-call \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "phone_number": "+912298765432",
  "metadata": {
    "email": "[email protected]",
    "name": "John Doe",
    "id": "JD75816540"
  },
  "botNumber": "+912298765432",
  "useCase": "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."
  }
}'

{
  "responseCode": 200,
  "message": "Call triggered successfully",
  "data": null
}

Direct Call

Workflow

Authorizations

Body

Response