Skip to main content
GET
/
outbound_call
Get call status or initiate outbound call
curl --request GET \
  --url https://api.call24x7.ai/outbound_call \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "call_id": "<string>",
  "message": "<string>"
}

​
Overview

Retrieve the status of an existing call by providing the call_id, or initiate a new outbound call using query parameters.

​
Parameters

​
query
string
Existing call ID to retrieve status for. If provided, other parameters are ignored.
​
query
string
required
Phone number to call in E.164 format (e.g., +1234567890). Required if call_id is not provided.
​
query
string
required
ID of the AI agent to use for the call. Required if call_id is not provided.
​
query
string
Optional webhook URL to receive call completion notifications. Must be a valid HTTP/HTTPS URL.
​
query
string
Optional external call ID for tracking purposes.

​
Example Request

curl -X GET "https://api.call24x7.ai/outbound_call?to_phone_number=%2B1234567890&agent_id=agent-123" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

​
success
boolean
Whether the request was successful
​
call_id
string
Unique identifier for the call
​
status
string
Current status of the call. Possible values: IDLE, RINGING, IN_PROGRESS, COMPLETED, FAILED
​
message
string
Response message

​
Example Response

{
  "success": true,
  "call_id": "12345",
  "status": "RINGING",
  "message": "Call initiated successfully"
}

​
Error Responses

​
success
boolean
Always false for errors
​
message
string
Human-readable error message
​
error_code
string
Error code. Possible values: MISSING_PARAMS, AGENT_NOT_FOUND, CALL_NOT_FOUND, INSUFFICIENT_BALANCE, INTERNAL_ERROR

Authorizations

​
Authorization
string
header
required

API key authentication. Include your API key in the Authorization header as: Bearer YOUR_API_KEY

Query Parameters

​
call_id
string

Existing call ID to retrieve status for

​
to_phone_number
string

Phone number to call (E.164 format, e.g., +1234567890). Required if call_id is not provided.

Pattern: ^\+[1-9]\d{1,14}$
​
agent_id
string

ID of the AI agent to use for the call. Required if call_id is not provided.

​
webhook_url
string<uri>

Optional webhook URL to receive call completion notifications

​
external_call_id
string

Optional external call ID for tracking

Response

Call initiated successfully or call status retrieved

​
success
boolean
required

Whether the request was successful

​
call_id
string
required

Unique identifier for the call

​
status
enum<string>
required

Current status of the call

Available options:
IDLE,
RINGING,
IN_PROGRESS,
COMPLETED,
FAILED
​
message
string

Response message