Using this API, you can get sessions details for an event.
You need to send eventurl as a path parameter. You can pass page, size, expand, tagIds, trackIds, sessionFormat, past, showPastAndUpcoming, filterDate and calledFrom as query parameter for pagination and filter support.
This API can be used by any registered attendee within the event.
Here is the description of response attributes, which returns to the form of JSON.
Attributes | Description |
|---|---|
sessionId | This session ID represent unique ID of each session. It will generate automatically when it's create new session for event. |
title | It's contains title of session. |
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. |
location | Location for session. |
description | It's contains the detail description of session. |
capacity | It's returns the capacity in number for session to allow maximum number of user can join. |
status | It's contains the session status type, there are two type of session visibility : VISIBLE, HIDDEN. |
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. |
speakerList | It's returns the list of speakers that associated with session. It's contains speaker details like speakerId, firatName, lastName, photoUrl and other. |
sessionStats | It's contains details of attendee count, interested user count, registered user count. |
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. |
currentUserRegisteredEventTicketId | It's contains the Event Ticketing ID that a ticketing holder user registered for a session. Event Ticketing ID generates when we create Ticketing Type. |
purchaserUserRegisteredEventTicketId | It's contains the Event Ticketing ID that a ticketing holder user purchaser for a session. Event Ticketing ID generates when we create Ticketing Type. |
duration | It's contains the session time span. |
chatEnabled | If enabled chat is true, then session chat will show in portal page. If false, then it will not show. |
pollEnabled | If enabled poll is true, then session poll will show in portal page. If false, then it will not show. |
quesAndAnsEnabled | If enabled QuesAndAns is true, then session QuesAndAns will show in portal page. If false, then it will not show. |
hideSessionFromAttendees | It will hide session from attendee if flag returns true from display page and portal page. |
tags | Llist of tags associated with a session. User can add tags for session while creating or updating session. |
tracks | It contains the tracks details like ID, name, colour, description and position. It will filter session from all session. |
ticketTypesThatCanBeRegistered | It will contain ticketing type IDs with comma separated value. That only ticketing type can register for session. |
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. |
rtmpUrl | Mux's standard RTMP entry point. Compatible with the majority of streaming applications and services. |
meetingPassword | Session meeting password if host set for session. |
accelEventsStudio | It returns true if stream provider is ACCELEVENTS else false. |
directVideoAutoStart | If returns true, session video start automatically when enter into session. |
sessionVisibilityType | Session visibility type PUBLIC, PRIVATE |
sponsorList | List of sponsor with their details associated with the session. |
recordSession | It's returns boolean for either wants to record session. |
hideVideoControls | It's returns boolean for either wants to hide or show video controls from attendee. |
exihiborList | List of exhibitors with their details which associated with session. |
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. |
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. |
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 |