kit_meetings

Creates, updates, deletes, gets or lists a kit_meetings resource.

Overview

Name	kit_meetings
Type	Resource
Id	cloudflare.realtime_kit.kit_meetings

Fields

The following fields are returned by SELECT queries:

get_by_account

Success Response

Name	Datatype	Description
data	object	Data returned by the operation
success	boolean	Success status of the operation

list_by_account

Success response

Name	Datatype	Description
id	string (uuid)	ID of the meeting.
created_at	string (date-time)	Timestamp the object was created at. The time is returned in ISO format.
live_stream_on_start	boolean	Specifies if the meeting should start getting livestreamed on start.
persist_chat	boolean	Specifies if Chat within a meeting should persist for a week.
record_on_start	boolean	Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
session_keep_alive_time_in_secs	number	Time in seconds, for which a session remains active, after the last participant has left the meeting.
status	string	Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting. (ACTIVE, INACTIVE)
summarize_on_end	boolean	Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
title	string	Title of the meeting.
updated_at	string (date-time)	Timestamp the object was updated at. The time is returned in ISO format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	meeting_id, account_id, app_id	name	Returns a meeting details in an App for the given meeting ID.
list_by_account	select	account_id, app_id	page_no, per_page, start_time, end_time, search	Returns all meetings for the given App ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
app_id	string	The Access application ID.
meeting_id	string	The Realtime Kit meeting ID.
end_time	string (date-time)	The end time range for which you want to retrieve the meetings. The time must be specified in ISO format.
name	string
page_no	number	The page number from which you want your page search results to be displayed.
per_page	number	Number of results per page
search	string	The search query string. You can search using the meeting ID or title.
start_time	string (date-time)	The start time range for which you want to retrieve the meetings. The time must be specified in ISO format.

SELECT examples

get_by_account

Returns a meeting details in an App for the given meeting ID.

SELECT
data,
success
FROM cloudflare.realtime_kit.kit_meetings
WHERE meeting_id = '{{ meeting_id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND name = '{{ name }}'
;

list_by_account

Returns all meetings for the given App ID.

SELECT
id,
created_at,
live_stream_on_start,
persist_chat,
record_on_start,
session_keep_alive_time_in_secs,
status,
summarize_on_end,
title,
updated_at
FROM cloudflare.realtime_kit.kit_meetings
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND page_no = '{{ page_no }}'
AND per_page = '{{ per_page }}'
AND start_time = '{{ start_time }}'
AND end_time = '{{ end_time }}'
AND search = '{{ search }}'
;