sessions_participants

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

Overview

Name	sessions_participants
Type	Resource
Id	cloudflare.realtime_kit.sessions_participants

Fields

The following fields are returned by SELECT queries:

get_by_account

Returns details of a participant along with callstats data.

Name	Datatype	Description
data	object
success	boolean

list

Get participants list of a particular session

Name	Datatype	Description
data	object
success	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_by_account	select	account_id, app_id, participant_id, session_id	filters, include_peer_events	Returns details of the given participant ID along with call statistics for the given session ID.
list	select	account_id, app_id, session_id	search, page_no, per_page, sort_order, sort_by, include_peer_events, view	Returns a list of participants for the given session 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.
participant_id	string	ID of the participant
session_id	string	The session ID.
filters	string	Comma separated list of filters to apply. Note that there must be no spaces between the filters.
include_peer_events	boolean	if true, response includes all the peer events of participants.
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.
sort_by	string
sort_order	string
view	string	In breakout room sessions, the view parameter can be set to raw for session specific duration for participants or consolidated to accumulate breakout room durations.

SELECT examples

get_by_account

Returns details of the given participant ID along with call statistics for the given session ID.

SELECT
data,
success
FROM cloudflare.realtime_kit.sessions_participants
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND participant_id = '{{ participant_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND filters = '{{ filters }}'
AND include_peer_events = '{{ include_peer_events }}'
;

list

Returns a list of participants for the given session ID.

SELECT
data,
success
FROM cloudflare.realtime_kit.sessions_participants
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND session_id = '{{ session_id }}' -- required
AND search = '{{ search }}'
AND page_no = '{{ page_no }}'
AND per_page = '{{ per_page }}'
AND sort_order = '{{ sort_order }}'
AND sort_by = '{{ sort_by }}'
AND include_peer_events = '{{ include_peer_events }}'
AND view = '{{ view }}'
;