Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Initiate phone calls programmatically — connect two parties via the API.
POST /api/v1/calls/click-to-call
calls.click_to_call permission.
X-API-Key: ak_your_api_key
{
"from": "1001",
"to": "9944421125",
"to_type": "external",
"caller_id": "+918065978015",
"timeout": 30,
"variables": {
"custom_key": "custom_value"
}
}
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | Extension number or phone number to call first |
to | string | Yes | Destination to connect after “from” answers |
to_type | string | No | Type of destination: extension, queue, ivr, ai_agent, or external |
caller_id | string | No | Phone number shown as caller ID to the “to” party |
timeout | number | No | Seconds to wait for “from” to answer (default: 30) |
variables | object | No | Custom variables passed to the call |
curl -X POST https://your-server:8000/api/v1/calls/click-to-call \
-H "X-API-Key: ak_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"from": "1001",
"to": "9944421125",
"to_type": "external",
"caller_id": "+918065978015"
}'
curl -X POST https://your-server:8000/api/v1/calls/click-to-call \
-H "X-API-Key: ak_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"from": "1001",
"to": "1002",
"to_type": "extension"
}'
from number/extensionto number/extension{
"status": "success",
"message": "Call initiated"
}
{
"status": "error",
"message": "Failed to originate call: extension not registered"
}