Skip to main content

​
Request

​
organization_id
integer
required
Your organization ID
​
use_agent_id
integer
required
The ID of the agent to use for the call
​
called_to
string
required
Destination phone number in E.164 format (e.g., +917359043943)
​
call_from
string
required
Source phone number in E.164 format. Must be registered in your agents_phone_numbers
​
custom_first_line
string
required
The initial message the agent will say when the call connects
​
custom_instruction
string
Dynamic user-specific context to be combined with the base prompt. Use this to provide personalized information for the call.
​
called_by_account
string
default:"API"
Identifier for who/what triggered the call. Default value should be “API”
​
api_key
string
required
Your organization API key
​
custom_identifiers
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

curl -X POST 'https://www.tabbly.io/dashboard/agents/endpoints/trigger-call' \
-H 'Content-Type: application/json' \
-d '{
    "organization_id": 244,
    "use_agent_id": 33,
    "called_to": "+917359056097",
    "call_from": "+14156801215",
    "custom_first_line": "Hello, I am calling from Company XYZ",
    "custom_instruction": "Vijay'\''s Order ID is 343454X. Order placed on 2nd Jan, 2025.",
    "called_by_account": "test_user",
    "api_key": "your_organization_api_key_here",
    "custom_identifiers": "user_12345"
}'

​
Response

​
success
boolean
Indicates if the call was successfully triggered
​
sip_trunk_id
string
SIP trunk identifier for the call
​
sip_call_to
string
SIP destination for the call
​
room_name
string
Room name for the call session
​
participant_identity
string
Participant identity in the call
​
participant_name
string
Participant name in the call

​
Success Response (200 OK)

{
    "success": true,
    "sip_trunk_id": "string",
    "sip_call_to": "string",
    "room_name": "string",
    "participant_identity": "string",
    "participant_name": "string"
}

​
Error Responses

​
400
object
Missing required fields
​
402
object
Insufficient wallet balance. Minimum balance of 0.2 required to initiate calls.
​
404
object
Organization/Agent not found or invalid call_from number
​
500
object
Server error

​
Important Notes

All phone numbers must be in E.164 format (+[country code][number])
The call_from number must be registered in your agents phone numbers database in your Tabbly account
Minimum wallet balance of 0.2 required to initiate calls
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.