Join Community
DocsDeveloper GuideChangelog
Chatbot

Make Outbound Call

Initiate an AI-powered outbound phone call using your Voice Agent. This endpoint triggers your configured Phone AI Agent to call a specified phone number, enabling use cases like appointment reminders, lead qualification, customer outreach, and automated sales calls.

Initiate an AI-powered outbound phone call using your Voice Agent. This endpoint triggers your configured Phone AI Agent to call a specified phone number, enabling use cases like appointment reminders, lead qualification, customer outreach, and automated sales calls.

POST
/makeOutboundCall

Authorization

apiKey

api-key<token>

API key for authentication. Generate your API key from the Integration settings in your YourGPT dashboard.

In: header

Request Body

application/json

agent_id*string

Your Voice Agent ID. You can find this in your YourGPT dashboard under Phone AI settings.

call_to*string

The phone number to call in E.164 format (must start with +). Example: +1234567890

Match^\+[1-9]\d{1,14}$
extra_data?

Additional data to pass to the Voice Agent during the call

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/makeOutboundCall" \  -H "Content-Type: application/json" \  -d '{    "agent_id": "agent_67890",    "call_to": "+1234567890"  }'
{
  "type": "RXSUCCESS",
  "message": "Call initiated successfully",
  "data": {
    "call_id": "call_12345",
    "status": "initiated",
    "agent_id": "agent_67890",
    "call_to": "+1234567890"
  }
}
{
  "type": "RXERROR",
  "message": "Phone number must start with +"
}
{
  "type": "RXERROR",
  "message": "Invalid API key"
}
{
  "type": "RXERROR",
  "message": "Agent not found"
}