Request
integer
required
Your organization ID
integer
required
The ID of the agent to use for the call
string
required
Destination phone number in E.164 format (e.g., +917359043943)
string
required
Source phone number in E.164 format. Must be registered in your agents_phone_numbers
string
required
The initial message the agent will say when the call connects
string
Dynamic user-specific context to be combined with the base prompt. Use this to provide personalized information for the call.
string
default:"API"
Identifier for who/what triggered the call. Default value should be “API”
string
required
Your organization API key
string
required
Any user_id, uuid, or unique identifier that you want to pass for mapping the record back to your system. Pass empty string "" if no identifier available.
Examples
Response
boolean
Indicates if the call was successfully triggered
string
SIP trunk identifier for the call
string
SIP destination for the call
string
Room name for the call session
string
Participant identity in the call
string
Participant name in the call
Success Response (200 OK)
Error Responses
object
Missing required fields
object
Insufficient wallet balance. Minimum balance of 0.2 required to initiate calls.
object
Organization/Agent not found or invalid call_from number
object
Server error
Important Notes
Custom first line should be a clear, concise message the agent will start with. Keep it under 50 words for best results.
Use custom_instruction to provide context-specific information that will be combined with the agent’s base prompt. This allows for personalized conversations.