Prerequisites
- An active PolyAI project with outbound calling enabled
- An authentication token provided by your PolyAI representative
- Your base URL (provided per project by PolyAI)
Contact your PolyAI representative to enable outbound calling for your project and obtain the necessary credentials.
Base URL
Your base URL is provided by PolyAI when outbound calling is configured for your project. Regional endpoints include:Endpoint paths
Outbound calling endpoints use the following path structure:Authentication
All outbound calling endpoints require authentication using theX-PolyAi-Auth-Token header:
Call flow
- Trigger call - POST to
/v1/outbound-callingwith the destination phone number (and optionalmetadataandencryption) - Receive call SID - API returns a unique call identifier (
call_sid, prefixed withOUT-) - Check status - GET
/v1/outbound-calling/{call_sid}/statusto monitor call progress - Handle completion - Call status updates to
successorfailure
Call statuses
Status data retention
Rate limits
Outbound calling is subject to rate limits based on your account configuration. Contact your PolyAI representative to adjust limits for your use case.Best practices
- Validate phone numbers - Ensure numbers are in E.164 format before triggering calls
- Handle failures gracefully - Implement retry logic with exponential backoff
- Monitor status promptly - Poll the status endpoint within 2 hours of call completion
- Store status data - If you need call status beyond 2 hours, store it in your own system
- Respect time zones - Schedule calls during appropriate hours for the destination region

