Here is the description of response attributes, which returns to the form of JSON.
|assetList||It's returns session assets details of streaming.|
It's contains asset ID, default playback, duration, file name and other.
|currentUserRegisteredEventTicketId||It's contains the Event Ticketing ID that a ticketing holder user can only register for a particular session. Event Ticketing ID generates when we create Ticketing Type.|
|startTime||It's contains session start time. When the particular session start and it will return in yyyy/MM/dd HH:mm format.|
|endTime||It's contains session end time. When the particular session end, and it will return in yyyy/MM/dd HH:mm format.|
|format||It's 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|
|registerdHolderUsers||It's returns the list of registered holder users details for session. Detail contains first name, last name, email, phone number, user ID.|
|sessionId||This session ID represent unique ID of each session. It will generate automatically when it's create new session for event.|
|sessionStats||It's contains details of attendee count, interested user count, registered user count.|
For getting this details need to pass in API endpoint as expand.
|status||It's contains the session status type, there are two type of session visibility : VISIBLE, HIDDEN.|
Visible status will show in session list and hidden status will do not show in session list.
|ticketTypesThatCanBeRegistered||It's contains the Ticketing Type ID that only register for a particular session. Ticketing Type ID generates when we create Ticketing Type.|
|title||It's contains title of session.|
|playBackRestrictionToken||It's 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||It's 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.|
|accelEventsStudio||If session stream provider is accelevents studio, then it's true. If session stream provider is accelevents RTMP, it's false.|
|closedCaptionUrl||It's returns caption URL which is used in session for transcription of speaker dialogue that appears on the bottom of the video. EX : https://www.streamtext.net/player?event=IHaveADream|
|closedCaptionHeight||The height of closed caption for the session, which is the default value, will be 150.|
|description||It's contains the detail description of session.|
It's only 65024 Characters are allowed to add description.
|directVideoAutoStart||If returns true, session video start automatically when enter into session.|
|pollEnabled||If session poll enable it will return true or else false.|
|quesAndAnsEnabled||If session QuesAndAns enable it will return true or else false.|
|displayDonation||It's returns boolean for display donation button for session.|
|documentKeyValue||It will return a JSON list of session document key value. Key generate automatically while uploading document and value represent document name.|
|linkKeyValue||It will return a JSON list of session link key value.|
Key generate automatically while uploading document and value represent key name.
|location||location for session.|
|meetingPassword||It will return session password if host set for session.|
|rtmpUrl||Mux's standard RTMP entry point. Compatible with the majority of streaming applications and services.|
|speakerList||It's returns the list of speakers that associated with session. It's contains speaker details like speakerId, firatName, lastName, photoUrl and other.|
|streamProvider||It's identify session stream provider, it can be ACCELEVENTS, WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD.|
|subStreamProvider||It's identify session sub stream provider, it can be VOXEET, CHIME, OPENTOK, AGORA.|
|streamUrl||It's a session stream endpoint.|
|streamKey||Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.|
|tracks||It contains the tracks details like ID, name, colour, description and position. It will filter session from all session.|
|hideVideoControls||If session Hide Video Controls, it will return true or else false.|
|recordSession||It will return true if record session enable or else false.|
|enableAttendeeList||It's returns boolean to show attendee list.|
|postSessionCallToActionJson||It's 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.|
|qnAPrivate||It's 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|
|4042003||Session not found!|