API Reference

Get all attendee's registered sessions

Get all registered sessions for the specified event.

This API can be used by authenticated users only, and it will require super admin/event admin/event staff/attendee level access.

Attributes

Description

recordsTotal

It will return a count of total session for event.

recordsFiltered

It will return a count of filtered records of session.

sessionId

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

title

It contains the title of the session.

startTime

It contains the session's starting time in the yyyy/MM/dd HH:mm format.

endTime

It contains the session's end time in the yyyy/MM/dd HH:mm format.

location

It's contains location of session.

description

It contains the description of the session.
It's only 65024 Characters are allowed to add description.

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.
Visible status will show in session list and hidden status will do not show in session list.

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.
For getting this, details need to pass in API endpoint as expand.

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.

enableChat

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

enablePoll

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

enableQuesAndAns

If enable QuesAndAns is false, then session QuesAndAns will not show in portal page. If true, then it will show.

hideSessionFromAttendees

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

tags

It's contains tags for 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 contains the Stream Provider Name Of session. Session contains ACCELEVENTS, WISTIA, YOUTUBE, VIMEO, FACEBOOK, ZOOM, DIRECT_UPLOAD stream provider.

subStreamProvider

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

streamUrl

It 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

It's contain unique stream key.

rtmpUrl

It's contain rtmp URL. It will use to put in OBS studio with stream key.

accelEventsStudio

It returns true if stream provider is ACCELEVENTS else false.

directVideoAutoStart

If returns true, session video start automatically when enter into session.

Here are 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.

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