Get Sessions List

This API will return a list of sessions for a particular event.

eventId is the required query parameter. Apart from that, you can pass searchString, page, size, isFromBillingPage, and expand as query parameters.

Only authorized users can use this API and require event admin, event staff, and super admin access.

Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

sessionId

The unique ID of each session. It will be generated automatically when a new session is created.

title

Contains the title of the session.

startTime

Contains the session's starting time in the YYY/MM/DD HH:MM format.

endTime

Contains the session's end time in the YYY/MM/DD HH:MM format.

description

Contains the description of the session.
Only 65,024 characters are allowed within description.

capacity

Returns the capacity number for session which is the maximum number of users allowed to join.

status

Contains the session status type: VISIBLE, HIDDEN.
Visible status will show in session list and hidden status will do not show in session list.

format

Returns the session format. Can set when create session. There are seven type of session can create that contains MAIN_STAGE, BREAKOUT_SESSION, MEET_UP, WORKSHOP, EXPO, BREAK, OTHER.

sessionStats

Contains details of attendee count, interested user count, registered user count.

For getting this, details need to pass in API endpoint as expand.

registerdHolderUsers

Contains details of registered user details who register for session. Details include event ticketing ID, user ID, first name, last name, email, phone number and other.

currentUserRegisteredEventTicketId

Contains the Event Ticketing ID that a ticketing holder user registered for a session. Event Ticketing ID generates when we create Ticketing Type.

purchaserUserRegisteredEventTicketId

Contains the Event Ticketing ID that a ticketing holder user purchaser for a session. Event Ticketing ID generates when we create Ticketing Type.

duration

Contains the session time span.

disableChat

If disable chat is false, then session chat will not show in portal page. If true, then it will show.

disablePoll

If disable poll is false, then session poll will not show in portal page. If true, then it will show.

disableQuesAndAns

If disable Q&A is false, then session Q&A will not show in portal page. If true, then it will show.

hideSessionFromAttendees

Will hide session from attendee if flag returns true from display page and portal page.

ticketTypesThatCanBeRegistered

Contains ticketing type IDs with comma separated value. That only ticketing type can register for session.

streamProvider

Contains the Stream Provider Name Of session. Session contains ACCELEVENTS, WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD stream provider.

subStreamProvider

Contains the Sub Stream Provider, Name Of session. Session contains VOXEET, CHIME, OPENTOK, AGORA sub stream provider.

streamUrl

Contains streaming URL. For WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD need to set streaming URL for ACCELEVENTS it will generate unique streaming UR.

streamKey

Contains unique stream key.

rtmpUrl

Contains rtmp URL. It will use to put in OBS studio with stream key.

accelEventsStudio

Returns true if stream provider is ACCELEVENTS, or not will return false.

directVideoAutoStart

Returns true if session video will start automatically it or will return false if video will need to manually start.

meetingPassword

Returns session password if host set for session.

documentKeyValue

Return a JSON list of session document key value.
Key generate automatically while uploading document and value represent document name.

linkKeyValue

Returns a JSON list of session link key value.
Key generate automatically while uploading document and value represent key name.

sessionVisibilityType

Contains session visibility type PUBLIC/PRIVATE.
PUBLIC that will show to all at the portal and display side.

PRIVATE session will not visible at portal and display side.

subTitleFileUrl

hideVideoControls

Returns true or false based on if Hide Video Controls is enabled.

recordSession

Returns true if session setting to record is enabled or else false.

position

Session position value, which is default 1000 which assigned according to concurrent sessions and next concurrent sessions value will be 2000. Session position will decide session order, how they display at portal and display page.

allowedMinutesToJoinLate

Return minutes to allow attendee to join the session late. Attendee once “registered” as (bookmark) the session before the elapsed session time. They can “join a session late” as(viewing a recording).

playBackRestrictionToken

Contains playback restriction token, which is allows you to set additional rules for playing videos. For instance, viewers can play videos embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any Video requests from other websites are denied.

thumbnailRestrictionToken

Contains playback restriction token, which is allows you to set additional rules for thumbnails. For instance, viewers can view thumbnails embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any thumbnails request from other websites are denied.

postSessionCallToActionJson

Returns details for postSessionCallToActionJson which is when the session ends it should see a message suggesting what I should go see next during the event.

chimeConfig

Returns chime configuration details related to session, which is contains Mute Attendees on Entry and Disable Attendees Camera on Entry.

qnAPrivate

Returns boolean either need private Q&A or need to visible for attendee, which returns true or false values.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

400

The request could not be understood by the server due to malformed syntax.

401

You are not authorized to view the resource

403

Accessing the resource you were trying to reach is forbidden.

404

The resource you were trying to reach is not found.

4040200

Event Not Found

Language
Authentication
Header
Click Try It! to start a request and see the response here!