Retrieves the current status for an outbound call. Use this endpoint to monitor call progress after triggering a call.
Call status data is retained for approximately 2 hours after the call ends. After this period, the endpoint will return a 404 Not Found error.
Request
Path parameters
The unique call identifier returned from the trigger endpoint
Authentication token provided by your PolyAI representative
Response
Current status of the call. Possible values:
queued - Call has been queued for processing
calling - Call is being placed to the destination
success - Call completed successfully
failure - Call failed to connect or was not answered
ISO 8601 timestamp when the call was created
ISO 8601 timestamp when the status was last updated
Example
curl -X GET "https://api.us-1.platform.polyai.app/v1/outbound-calling/550e8400-e29b-41d4-a716-446655440000/status" \
-H "X-PolyAi-Auth-Token: YOUR_AUTH_TOKEN"
Response example
{
"callSid": "550e8400-e29b-41d4-a716-446655440000",
"status": "success",
"created_at": "2024-03-15T10:00:00Z",
"last_updated": "2024-03-15T10:05:30Z"
}
Error responses
Invalid or missing authentication token.
Call SID not found. This may occur if:
- The call does not exist
- More than 2 hours have passed since the call ended (status data expired)
500 Internal Server Error
Failed to retrieve call status. Retry with exponential backoff.
Polling recommendations
When monitoring call status:
- Poll every 2-5 seconds during the
queued and calling phases
- Stop polling once status reaches a terminal state (
success or failure)
- Implement exponential backoff if you receive errors
- Store the final status before the 2-hour retention window expires if you need long-term records
Notes
- Call status is updated in real-time as the call progresses
- Terminal statuses (
success, failure) are final and will not change
- Status data is retained for approximately 2 hours after the call ends - poll and store data if you need longer retention