curl --request GET \
--url https://{host}/api/v1/conferences/{room} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conferences/{room}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conferences/{room}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"can_control": true,
"locked": true,
"members": [
{
"call_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"muted": true,
"role": "participant",
"talking": true,
"joined_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>"
}
],
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recording": true,
"room": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"all_muted": true,
"room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room_name": "<string>",
"run_seconds": 123
}Who is in a room now
curl --request GET \
--url https://{host}/api/v1/conferences/{room} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conferences/{room}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conferences/{room}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"can_control": true,
"locked": true,
"members": [
{
"call_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": 123,
"muted": true,
"role": "participant",
"talking": true,
"joined_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"number": "<string>"
}
],
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"recording": true,
"room": "<string>",
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"started_at": "2023-11-07T05:31:56Z",
"all_muted": true,
"room_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"room_name": "<string>",
"run_seconds": 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.
Path Parameters
Response
The room as it is now.
A room while it is up. room is the switch's name for it, which every control is addressed to; room_id is the dial-in room behind it, and is absent for a room made by merging two calls.
Whether THIS caller may run the room: answered once here, so a client draws the controls it has rather than discovering a 404 per button.
Show child attributes
Show child attributes