Triggers a new outbound call to the specified phone number. The call will be queued and processed by the outbound calling system.
Request
Authentication token provided by your PolyAI representative
Body
Phone number to call in E.164 format (e.g., +14155552671)
Response
Unique identifier for the triggered call. Use this to check call status.
Example
curl -X POST https://api.us-1.platform.polyai.app/v1/outbound-calling/trigger \
-H "X-PolyAi-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"to_number": "+14155552671"
}'
Response example
{
"callSid": "550e8400-e29b-41d4-a716-446655440000"
}
Error responses
Invalid request parameters. Check phone number format.
Invalid or missing authentication token.
500 Internal Server Error
Failed to queue the outbound call. Retry with exponential backoff.
Notes
- Phone numbers must be in E.164 format (international format with + prefix)
- Use the Get call status endpoint to monitor call progress
- Call status data is retained for approximately 2 hours after the call ends