Rooms live right now
curl --request GET \
--url https://{host}/api/v1/conferences \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conferences"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"members": 123,
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"locked": true,
"recording": true,
"room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room_name": "<string>"
}
],
"total": 123
}Calls
Rooms live right now
Every open conference session in the caller's scope, dial-in and merged alike, with the member count. Live rooms are keyed by the SWITCH'S room name (ft-room-<id> for a dial-in room, ft-conf-<call> for a merged call), so a merged call gets the same list and controls. Reading a dial-in room needs conferences:read; acting on it conferences:control -- or being in it. A merged room follows the call-control rule: an agent may act on a room made from a call one of whose legs is theirs.
Rooms live right now
curl --request GET \
--url https://{host}/api/v1/conferences \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conferences', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conferences"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"members": 123,
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"locked": true,
"recording": true,
"room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room_name": "<string>"
}
],
"total": 123
}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.