curl --request GET \
--url https://{host}/api/v1/calls/active \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/calls/active', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/calls/active"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"call_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "<string>",
"state": "ACTIVE",
"agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caller_number": "<string>",
"codec": "<string>",
"context": "<string>",
"created_at": "<string>",
"destination_number": "<string>",
"muted_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"started_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"total": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Live channels
Read from FreeSWITCH on every request, never cached: the switch is the only thing that knows, and a cached copy is wrong the moment a call ends. WHOLE BY DEFAULT: with no limit every call visible to the caller is returned, as it always was, because dashboards count and scan the whole list. Sending limit pages it like any list (up to 500). Sort keys: started_at, state, caller, destination, direction; with no sort the switch’s own order. q searches the caller, destination and call uuid. Filters: state, direction, organisation_id.
curl --request GET \
--url https://{host}/api/v1/calls/active \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/calls/active', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/calls/active"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"call_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"direction": "<string>",
"state": "ACTIVE",
"agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"caller_number": "<string>",
"codec": "<string>",
"context": "<string>",
"created_at": "<string>",
"destination_number": "<string>",
"muted_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"started_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"total": 123
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Authorizations
Every request sends Authorization: Bearer <token>. The token is either a panel session (a JWT from /auth/login, 12 hours) or an API key ft_<id>_<secret>. An API key is accepted only from an address on its IP allowlist (403 ip_not_allowed otherwise; 403 ip_allowlist_required for an old key that has none), is limited to its rate per minute (429 rate_limited with Retry-After; X-RateLimit-Limit/Remaining/Reset on every response), and at most 60 call placements a minute.
Query Parameters
Omit for every call; send it for a page.
x <= 500Sort key. Each list accepts its own allow-list of keys, given in that endpoint's description; anything else is a 400. ORDER BY cannot be parameterised, so the key is looked up rather than interpolated. Every sort carries a tiebreak on the primary key, so paging stays disjoint when the sort column has duplicates.
Sort direction. Defaults to ascending, except the call log, which reads newest first.
asc, desc Free-text search across the list's searchable columns (case-insensitive substring). % and _ in the term match themselves.
Channel state, e.g. RINGING or ACTIVE; case-insensitive.
inbound, outbound Narrows within what the caller sees; never widens.