sessions

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

Overview

Name	sessions
Type	Resource
Id	cloudflare.realtime_kit.sessions

Fields

The following fields are returned by SELECT queries:

list

Get all sessions success response

Name	Datatype	Description
data	object
success	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id, app_id	page_no, per_page, sort_by, sort_order, start_time, end_time, participants, status, search, associated_id	Returns details of all sessions of an App.
generate_summary_of_transcripts	insert	account_id, app_id, session_id		Trigger Summary generation of Transcripts for the 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.
session_id	string	The session ID.
associated_id	string	ID of the meeting that sessions should be associated with
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.
page_no	number	The page number from which you want your page search results to be displayed.
participants	string
per_page	number	Number of results per page
search	string	Search string that matches sessions based on meeting title, meeting ID, and session ID
sort_by	string
sort_order	string
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.
status	string

SELECT examples

list

Returns details of all sessions of an App.

SELECT
data,
success
FROM cloudflare.realtime_kit.sessions
WHERE account_id = '{{ account_id }}' -- required
AND app_id = '{{ app_id }}' -- required
AND page_no = '{{ page_no }}'
AND per_page = '{{ per_page }}'
AND sort_by = '{{ sort_by }}'
AND sort_order = '{{ sort_order }}'
AND start_time = '{{ start_time }}'
AND end_time = '{{ end_time }}'
AND participants = '{{ participants }}'
AND status = '{{ status }}'
AND search = '{{ search }}'
AND associated_id = '{{ associated_id }}'
;

INSERT examples

generate_summary_of_transcripts

Trigger Summary generation of Transcripts for the session ID.

INSERT INTO cloudflare.realtime_kit.sessions (
account_id,
app_id,
session_id
)
SELECT 
'{{ account_id }}',
'{{ app_id }}',
'{{ session_id }}'
RETURNING
data,
success
;

Manifest

# Description fields are for documentation purposes
- name: sessions
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the sessions resource.
  - name: app_id
    value: "{{ app_id }}"
    description: Required parameter for the sessions resource.
  - name: session_id
    value: "{{ session_id }}"
    description: Required parameter for the sessions resource.