Get call status or initiate outbound call
API Endpoints
Get Call Status
Retrieve the status of an existing call by call_id, or initiate a new outbound call using query parameters.
GET
Get call status or initiate outbound call
Overview
Retrieve the status of an existing call by providing thecall_id, or initiate a new outbound call using query parameters.
Parameters
string
Existing call ID to retrieve status for. If provided, other parameters are ignored.
string
required
Phone number to call in E.164 format (e.g., +1234567890). Required if
call_id is not provided.string
required
ID of the AI agent to use for the call. Required if
call_id is not provided.string
Optional webhook URL to receive call completion notifications. Must be a valid HTTP/HTTPS URL.
string
Optional external call ID for tracking purposes.
Example Request
Response
boolean
Whether the request was successful
string
Unique identifier for the call
string
Current status of the call. Possible values:
IDLE, RINGING, IN_PROGRESS, COMPLETED, FAILEDstring
Response message
Example Response
Error Responses
boolean
Always
false for errorsstring
Human-readable error message
string
Error code. Possible values:
MISSING_PARAMS, AGENT_NOT_FOUND, CALL_NOT_FOUND, INSUFFICIENT_BALANCE, INTERNAL_ERRORAuthorizations
API key authentication. Include your API key in the Authorization header as: Bearer YOUR_API_KEY
Query Parameters
Existing call ID to retrieve status for
Phone number to call (E.164 format, e.g., +1234567890). Required if call_id is not provided.
Pattern:
^\+[1-9]\d{1,14}$ID of the AI agent to use for the call. Required if call_id is not provided.
Optional webhook URL to receive call completion notifications
Optional external call ID for tracking
Response
Call initiated successfully or call status retrieved

