A room's history
curl --request GET \
--url https://{host}/api/v1/conference-rooms/{id}/sessions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conference-rooms/{id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conference-rooms/{id}/sessions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"has_recording": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invites": [
{
"attempts": 123,
"last_reason": "<string>",
"name": "<string>",
"number": "<string>",
"role": "participant",
"round": 123,
"state": "pending"
}
],
"participants": [
{
"caller": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"left_at": "2023-11-07T05:31:56Z",
"role": "participant"
}
],
"peak_members": 123,
"recording_bytes": 123,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"total": 123
}Provisioning
A room's history
Every occupancy of the room, newest first: when it ran, how many were in it at most, who was in it with their roles and times, and whether a recording exists (has_recording, recording_bytes). Paged.
A room's history
curl --request GET \
--url https://{host}/api/v1/conference-rooms/{id}/sessions \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/v1/conference-rooms/{id}/sessions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/api/v1/conference-rooms/{id}/sessions"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"has_recording": true,
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"invites": [
{
"attempts": 123,
"last_reason": "<string>",
"name": "<string>",
"number": "<string>",
"role": "participant",
"round": 123,
"state": "pending"
}
],
"participants": [
{
"caller": "<string>",
"joined_at": "2023-11-07T05:31:56Z",
"left_at": "2023-11-07T05:31:56Z",
"role": "participant"
}
],
"peak_members": 123,
"recording_bytes": 123,
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z"
}
],
"limit": 123,
"offset": 123,
"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.