Skip to main content
POST
/
api
/
v1
/
{account_id}
/
{project_id}
/
outbound-call
/
trigger
Trigger an outbound call
curl --request POST \
  --url https://api.example.com/api/v1/{account_id}/{project_id}/outbound-call/trigger \
  --header 'Content-Type: <content-type>' \
  --header 'X-CONNECTOR-ID: <x-connector-id>' \
  --data '
{
  "phone_number": "<string>"
}
'
{
  "conversation_id": "<string>"
}
Triggers a new outbound call to the specified phone number. The call will be queued and processed by the outbound calling system.

​
Request

​
Path parameters

​
account_id
string
required
Your PolyAI account ID
​
project_id
string
required
Your PolyAI project ID

​
Headers

​
X-CONNECTOR-ID
string
required
Connector ID for outbound calls
​
Content-Type
string
required
Must be application/json

​
Body

​
phone_number
string
required
Phone number to call in E.164 format (e.g., +14155552671)

​
Response

​
conversation_id
string
Unique identifier for the triggered call (starts with OUT-). Use this to check call status.

​
Example

curl -X POST https://api.us-1.platform.polyai.app/api/v1/your-account-id/your-project-id/outbound-call/trigger \
  -H "X-CONNECTOR-ID: YOUR_CONNECTOR_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+14155552671"
  }'

​
Response example

{
  "conversation_id": "OUT-550e8400-e29b-41d4-a716-446655440000"
}

​
Error responses

​
400 Bad Request
Invalid request parameters. Check phone number format.
​
401 Unauthorized
Invalid or missing connector ID.
​
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)
  • The returned conversation_id starts with OUT- to distinguish outbound calls
  • Use the Get call status endpoint to monitor call progress
  • Call status data is retained for approximately 2 hours after the call ends