Regular Session
Here are the steps and API endpoints to join regular session in the Accelevents platform.
Regular Session
Calling these following API sequences will help you to join a regular session in the Accelevents platform
| Steps | Description | API Reference |
|---|---|---|
| Get regular sessions | Get all the regular session list. | Click Here |
| Join session | Check if all the requirement is full-filled like if attendee has required ticket for that session / session is live / session capacity has exceeded or not. If all requirement are full filled then user is registered for that session. | Click Here |
1. Get regular sessions
First, you need to get all regular sessions that are currently live as if session time is in the future or already ended you won't be able to join that session.
To get the live regular sessions, you can use below API endpoint. To only get live regular sessions you need to pass sessionFormat as BREAKOUT_SESSION.
developer.accelevents.comYou can also pass other query parameters such as page , size, past, sessionFormat, expand, currentUserRegisteredEventTicketId, status for further filter sessions and get response data accordingly.
Here is a sample response, which will be returned by API.
{
"recordsTotal": 3,
"recordsFiltered": 3,
"data": [
{
"sessionId": 11592,
"title": "Reguter First Session",
"startTime": "2021/12/17 00:36",
"endTime": "2021/12/17 18:36",
"location": null,
"description": null,
"capacity": 0,
"status": "VISIBLE",
"format": "BREAKOUT_SESSION",
"speakerList": null,
"sponsorList": [
],
"sessionStats": {
"id": 11592,
"registeredUserCount": 0,
"interestedUserCount": 0,
"attendeeCount": 0,
"sessionSpeakerCount": 0
},
"registerdHolderUsers": null,
"currentUserRegisteredEventTicketId": [
57940
],
"purchaserUserRegisteredEventTicketId": null,
"duration": null,
"enableChat": true,
"enablePoll": true,
"enableQuesAndAns": true,
"hideSessionFromAttendees": false,
"enableVirtualization": false,
"tags": [
],
"tracks": [
],
"ticketTypesThatCanBeRegistered": [
10797
],
"streamProvider": "YOUTUBE",
"subStreamProvider": "OPENTOK",
"streamUrl": "guL_-lvkY5o&list=RDMMguL_-lvkY5o&start_radio=1",
"streamKey": null,
"rtmpUrl": null,
"accelEventsStudio": false,
"directVideoAutoStart": false,
"assetList": null,
"displayDonation": false,
"closedCaptionUrl": null,
"closedCaptionHeight": 150,
"meetingPassword": null,
"documentKeyValue": [
],
"linkKeyValue": [
],
"sessionVisibilityType": "PUBLIC",
"subTitleFileUrl": null,
"hideVideoControls": true,
"recordSession": true,
"position": 1000.0,
"allowedMinutesToJoinLate": 0,
"enableAttendeeList": true,
"playBackRestrictionToken": "eyJraWQiOiJNSEJvMXhaR09PUGlHUTJ4Y3AwMjFOOXNVVnkzcTVURFBnNUN3Sk1McTAyQlUiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkV1l5ZlJRd1Q5c1dScXhuMmtsakhjRXFKYmFXWFhzVmxIb3cwMkZSWmt4MDAiLCJhdWQiOiJ2IiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiI2a090U2NZcU8wMmFMbmNmS3JJejViWnVVMDF3c3hCWDlEM2Z2ZTZ6cFhJR2MiLCJleHAiOjE4NjA0NzY1Nzh9.uv6jWbmuK0t6r5rW3uJ_xtUmpRn37F-wqHuXkNIoCvMvHAy_QttKafYD5kM_dQMb8KjIWAHeuOWcLyYsuXjx5TXhgd9Ntpw5BfNt_1-5xvovoKnmCpNAC2GKsfae_Uh41kDmPa5IA_NgWgIxrJv02oxHrTG3IT-JH-A8TX9iDRzi17OKhsadV-r932_N6nfTsSdkTbbnkmm5WLGkpa9SpeYW0Goc6hCjqTe1HrAQ1bB0XSspBHun45NHspXyVV-DWFYLycGht7Zmffl_JYiyBR-oTuHs5eX_F_3hBVhhbMjhRCSrRNzZ6j_JYYDFaG1fvO0ivdv7hco7komSY-9juA",
"thumbnailRestrictionToken": "eyJraWQiOiJNSEJvMXhaR09PUGlHUTJ4Y3AwMjFOOXNVVnkzcTVURFBnNUN3Sk1McTAyQlUiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkV1l5ZlJRd1Q5c1dScXhuMmtsakhjRXFKYmFXWFhzVmxIb3cwMkZSWmt4MDAiLCJhdWQiOiJ0IiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiI2a090U2NZcU8wMmFMbmNmS3JJejViWnVVMDF3c3hCWDlEM2Z2ZTZ6cFhJR2MiLCJleHAiOjE4NjA0NzY1Nzh9.AkVL_IsPs1_zhxjY7rtupC01ygF-wTdqhT5V9KpRVhDSD4Gd2OMw72DMTFhkziSzH337WJwxD3TN48m_wlR30gQkED0fbxX4u4_kEn_1s9gw5CnFCT2jQpoS3l0_yNCSoYFpTM3ivC1HfK9yeyhffWw2Oplu5RaB2mDbc0l1oWYT9RNeqFnSBJToqv03w__Zy88N9mwUlRG9irybGlmogcSooaU-hfDPXNErIFmUcF_EHrVI96wvojFnTkz2CfUVmkPtvbv0o3QBgyYfLFKb7GsxhyyFQXtXR5fxXVsEoepDTUOpYddqwH-2_FHAr1FuZSa5op0_Do1Kf3xjjbQigA",
"postSessionCallToActionJson": {
"enablePostSessionCallToAction": false,
"destinationType": null,
"description": null,
"buttonLabelText": null,
"destination": null
},
"chimeConfig": null,
"qnAPrivate": true
},
{
"sessionId": 11593,
"title": "Reguter First SessionCOPY1",
"startTime": "2021/12/17 17:36",
"endTime": "2021/12/17 18:36",
"location": null,
"description": null,
"capacity": 0,
"status": "VISIBLE",
"format": "BREAKOUT_SESSION",
"speakerList": null,
"sponsorList": [
],
"sessionStats": {
"id": 11593,
"registeredUserCount": 0,
"interestedUserCount": 0,
"attendeeCount": 0,
"sessionSpeakerCount": 0
},
"registerdHolderUsers": null,
"currentUserRegisteredEventTicketId": [
57940
],
"purchaserUserRegisteredEventTicketId": null,
"duration": null,
"enableChat": true,
"enablePoll": true,
"enableQuesAndAns": true,
"hideSessionFromAttendees": false,
"enableVirtualization": false,
"tags": [
],
"tracks": [
],
"ticketTypesThatCanBeRegistered": [
10797
],
"streamProvider": "YOUTUBE",
"subStreamProvider": "OPENTOK",
"streamUrl": "guL_-lvkY5o&list=RDMMguL_-lvkY5o&start_radio=1",
"streamKey": null,
"rtmpUrl": null,
"accelEventsStudio": false,
"directVideoAutoStart": false,
"assetList": null,
"displayDonation": false,
"closedCaptionUrl": null,
"closedCaptionHeight": 150,
"meetingPassword": null,
"documentKeyValue": [
],
"linkKeyValue": [
],
"sessionVisibilityType": "PUBLIC",
"subTitleFileUrl": null,
"hideVideoControls": true,
"recordSession": true,
"position": 1000.0,
"allowedMinutesToJoinLate": 0,
"enableAttendeeList": true,
"playBackRestrictionToken": null,
"thumbnailRestrictionToken": "eyJraWQiOiJNSEJvMXhaR09PUGlHUTJ4Y3AwMjFOOXNVVnkzcTVURFBnNUN3Sk1McTAyQlUiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkV1l5ZlJRd1Q5c1dScXhuMmtsakhjRXFKYmFXWFhzVmxIb3cwMkZSWmt4MDAiLCJhdWQiOiJ0IiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiI2a090U2NZcU8wMmFMbmNmS3JJejViWnVVMDF3c3hCWDlEM2Z2ZTZ6cFhJR2MiLCJleHAiOjE4NjA0NzY1Nzh9.AkVL_IsPs1_zhxjY7rtupC01ygF-wTdqhT5V9KpRVhDSD4Gd2OMw72DMTFhkziSzH337WJwxD3TN48m_wlR30gQkED0fbxX4u4_kEn_1s9gw5CnFCT2jQpoS3l0_yNCSoYFpTM3ivC1HfK9yeyhffWw2Oplu5RaB2mDbc0l1oWYT9RNeqFnSBJToqv03w__Zy88N9mwUlRG9irybGlmogcSooaU-hfDPXNErIFmUcF_EHrVI96wvojFnTkz2CfUVmkPtvbv0o3QBgyYfLFKb7GsxhyyFQXtXR5fxXVsEoepDTUOpYddqwH-2_FHAr1FuZSa5op0_Do1Kf3xjjbQigA",
"postSessionCallToActionJson": {
"enablePostSessionCallToAction": false,
"destinationType": null,
"description": null,
"buttonLabelText": null,
"destination": null
},
"chimeConfig": null,
"qnAPrivate": true
},
{
"sessionId": 11594,
"title": "Reguter First SessionCOPY2",
"startTime": "2021/12/17 00:36",
"endTime": "2021/12/17 18:36",
"location": null,
"description": null,
"capacity": 0,
"status": "VISIBLE",
"format": "BREAKOUT_SESSION",
"speakerList": [
{
"speakerId": 5758,
"title": null,
"pronouns": null,
"firstName": "Jay",
"lastName": "Dobariya",
"email": "[email protected]",
"sessionDTO": null,
"userId": 8528,
"imageUrl": null,
"company": null,
"bio": null,
"linkedIn": null,
"twitter": null,
"instagram": null,
"position": 2000.0,
"moderator": true,
"ticketTypesForSpeaker": null,
"loggedInAtVEH": false,
"showModerator": true,
"deviceChecked": false,
"allowOverrideDetails": false,
"allowAttendeeAccess": false
}
],
"sponsorList": [
],
"sessionStats": {
"id": 11594,
"registeredUserCount": 0,
"interestedUserCount": 0,
"attendeeCount": 0,
"sessionSpeakerCount": 0
},
"registerdHolderUsers": null,
"currentUserRegisteredEventTicketId": [
57940
],
"purchaserUserRegisteredEventTicketId": null,
"duration": null,
"enableChat": true,
"enablePoll": true,
"enableQuesAndAns": true,
"hideSessionFromAttendees": false,
"enableVirtualization": false,
"tags": [
],
"tracks": [
],
"ticketTypesThatCanBeRegistered": [
10797
],
"streamProvider": "YOUTUBE",
"subStreamProvider": "OPENTOK",
"streamUrl": "guL_-lvkY5o&list=RDMMguL_-lvkY5o&start_radio=1",
"streamKey": null,
"rtmpUrl": null,
"accelEventsStudio": false,
"directVideoAutoStart": false,
"assetList": null,
"displayDonation": false,
"closedCaptionUrl": null,
"closedCaptionHeight": 150,
"meetingPassword": null,
"documentKeyValue": [
],
"linkKeyValue": [
],
"sessionVisibilityType": "PUBLIC",
"subTitleFileUrl": null,
"hideVideoControls": true,
"recordSession": true,
"position": 2000.0,
"allowedMinutesToJoinLate": 0,
"enableAttendeeList": true,
"playBackRestrictionToken": null,
"thumbnailRestrictionToken": "eyJraWQiOiJNSEJvMXhaR09PUGlHUTJ4Y3AwMjFOOXNVVnkzcTVURFBnNUN3Sk1McTAyQlUiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkV1l5ZlJRd1Q5c1dScXhuMmtsakhjRXFKYmFXWFhzVmxIb3cwMkZSWmt4MDAiLCJhdWQiOiJ0IiwicGxheWJhY2tfcmVzdHJpY3Rpb25faWQiOiI2a090U2NZcU8wMmFMbmNmS3JJejViWnVVMDF3c3hCWDlEM2Z2ZTZ6cFhJR2MiLCJleHAiOjE4NjA0NzY1Nzh9.AkVL_IsPs1_zhxjY7rtupC01ygF-wTdqhT5V9KpRVhDSD4Gd2OMw72DMTFhkziSzH337WJwxD3TN48m_wlR30gQkED0fbxX4u4_kEn_1s9gw5CnFCT2jQpoS3l0_yNCSoYFpTM3ivC1HfK9yeyhffWw2Oplu5RaB2mDbc0l1oWYT9RNeqFnSBJToqv03w__Zy88N9mwUlRG9irybGlmogcSooaU-hfDPXNErIFmUcF_EHrVI96wvojFnTkz2CfUVmkPtvbv0o3QBgyYfLFKb7GsxhyyFQXtXR5fxXVsEoepDTUOpYddqwH-2_FHAr1FuZSa5op0_Do1Kf3xjjbQigA",
"postSessionCallToActionJson": {
"enablePostSessionCallToAction": false,
"destinationType": null,
"description": null,
"buttonLabelText": null,
"destination": null
},
"chimeConfig": null,
"qnAPrivate": true
}
],
"error": null
}
2. Join session
Note
If you have not purchased a ticket for the session then, you can't join sessions.
In this step, you will register the attendee for a particular regular stage session. From step 1, you need to identify sessionId for which you need to register an attendee.
Above API will check all requirements to join a session and get a response 200 status code then attendee has registered for the session. If any criteria are not full-filled then it will return an error with the proper error message.
| Criteria | Error code | Error message |
|---|---|---|
| Session not exist | 404 | Session not found! |
| Session reach its max capacity | 406 | Max user registration capacity reached |
| Ticket type not match | 406 | Your ticket does not permit access to this session |
| If the purchased ticket type restricts the number of sessions you can join and you have reached that limit | 406 | Your registration type only permits registering for {number_of_sessions_permitted} sessions. If you would like to register for this session please un-register from a different session first. |
| The session should be live | 407 | The time limit for accessing this session is expired. |
If the attendee has successfully registered for the session then you can below API to get session detail where you will get streamKey / rtmpUrl / streamUrl that you can use for streaming the session.
Updated about 2 years ago