Get Session Detail

This API will return all session detail.

Will need to pass id as a path parameter. Only authorized users can use this API and require the event admin, event staff, and super admin access.

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

AttributesDescription
accelEventsStudio Returns true if stream provider is Accelevents, otherwise returns false
allowedMinutesToJoinLate Returns the number of minutes which allows attendee to join the session late
assetList List of asset for setting default playback after live stream ends
capacity Returns the capacity number for session which is the maximum number of users allowed to join
chimeConfig Returns chime configuration details related to session. Contains if settings Mute Attendees on Entry and Disable Attendees Camera on Entry are enabled
closedCaptionHeight The height of closed caption for the session. The default value is 150
closedCaptionUrl Returns the captioning URL. This is used in session for transcription of speaker dialogue and appears on the bottom of the video.

Example: https://www.streamtext.net/player?event=IHaveADream
currentUserRegisteredEventTicketId Contains the current User Event Ticketing ID that a ticketing holder user registered for a session. Event Ticketing ID generates when we create Ticketing Type
description Contains the detail description of session.
Only 65,024 characters are allowed for session description
directVideoAutoStart Returns true if session video will start automatically at start of session
displayDonation Returns boolean for display donation button for session
documentKeyValue Returns a JSON list of session document key value. Key generate automatically while uploading document and value represent document name.
duration Contains the session time span.
chatEnabledIf session chat is enabled it will return true, or if disabled will return false.
pollEnabledIf session poll is enabled it will return true, or if disabled will return false.
quesAndAnsEnabledIf session Q&A is enabled it will return true, or if disabled will return false.
endTime Contains the session's end time in the yyyy/MM/dd HH:mm format.
format Returns the session format. There are seven type of session can create that contains MAIN_STAGE, BREAKOUT_SESSION, MEET_UP, WORKSHOP, EXPO, BREAK, OTHER.
hideSessionFromAttendees It will hide session from attendee if flag returns true from display page and portal page.
hideVideoControls Returns true if the session hide video controls setting is enabled, or if disabled will return false.
linkKeyValue Returns a JSON list of session link key value.
Key generate automatically while uploading document and value represent key name.
location Contains the location for session.
meetingPassword Returns session password if password is set for session.
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.
purchaserUserRegisteredEventTicketId Event Ticketing ID that a ticketing holder user purchaser for a session. Event Ticketing ID generates when we create Ticketing Type.
qnAPrivate Returns boolean value, either private Q&A or visible to all attendees. Value returns true or false.
recordSession Return true if record session enable, or if disabled will return false.
registerdHolderUsers It's contains details of registered user details who register for session. It's contain details like event ticketing ID, user ID, first name, last name, email, phone number and other.
rtmpUrl It's contain rtmp URL. It will use to put in OBS studio with stream key.
sessionId The sessionId represents the unique ID of each session. It will be generated automatically when a new session is created.
sessionStats Returns session related count details which associated with session like registered users count, interested users count, attendee count and session speaker count.

For getting this details with sessions list, need to pass sessionSpeakerCount with API to expand query parameter value.
sessionVisibilityType Contains session visibility type PUBLIC, PRIVATE.

PUBLIC session will show to all at portal and display side.
PRIVATE session will not visible at portal and display side.
speakerList Returns the list of speakers that associated with session. Contains speaker details like speakerId, firatName, lastName, photoUrl and other.
sponsorList Contains session sponsor details.
startTime Contains the session's starting time in the yyyy/MM/dd HH:mm format.
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.
streamKey Contains unique stream key.
streamProvider Contains the Sub Stream Provider: VOXEET,CHIME,OPENTOK,AGORA as the sub stream provider options.
streamUrl Contains streaming URL. For WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD

If set streaming URL is Accelevents it will generate unique streaming URL.
subStreamProvider Contains the Sub Stream Provider Name of session. Options are VOXEET,CHIME,OPENTOK,AGORA.
subTitleFileUrl
tags Filter Tag Ids in comma separated for filtering session records according to tags
ticketTypesThatCanBeRegistered Contains ticketing type IDs with comma separated value. Returns the name(s) of the ticket type which can register for the session.
title Contains the title of the session.
tracks Contains the tracks details like ID, name, colour, description and position. It will filter session from all session.
enableAttendeeList Returns boolean to show attendee list.
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 CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
4030201Not Event Host
404800Session not found!
Language
Authentication
Header
Click Try It! to start a request and see the response here!