meetings_participants

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

Overview

Name	meetings_participants
Type	Resource
Id	cloudflare.realtime_kit.meetings_participants

Fields

The following fields are returned by SELECT queries:

get_by_account

Success response

Name	Datatype	Description
data	object	Data returned by the operation (title: Participant)
success	boolean	Success status of the operation

list_by_account

Success response

Name	Datatype	Description
id	string (uuid)	ID of the participant.
name	string	Name of the participant.
custom_participant_id	string	A unique participant ID generated by the client.
preset_name	string	Preset applied to the participant.
created_at	string (date-time)	When this object was created. The time is returned in ISO format.
picture	string (uri)	URL to a picture of the participant.
updated_at	string (date-time)	When this object was updated. 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, participant_id, account_id, app_id		Returns a participant details for the given meeting and participant ID.
list_by_account	select	account_id, app_id, meeting_id	page_no, per_page	Returns all participants detail for the given meeting 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.
participant_id	string	ID of the participant. You can fetch the participant ID using the add a participant API.
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

SELECT examples

get_by_account

Returns a participant details for the given meeting and participant ID.

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

list_by_account

Returns all participants detail for the given meeting ID.

SELECT
id,
name,
custom_participant_id,
preset_name,
created_at,
picture,
updated_at
FROM cloudflare.realtime_kit.meetings_participants
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND meeting_id = '{{ meeting_id }}' -- required
AND page_no = '{{ page_no }}'
AND per_page = '{{ per_page }}'
;