Server-side REST API for JioEvents, Jio's webinar and virtual event platform, documented alongside JioMeet at dev.jiomeet.com. Covers creating, fetching, updating and deleting scheduled webinars, creating, listing and deleting sessions, creating, listing and deleting meeting invites, and downloading attendance and registration reports.
openapi: 3.0.3
info:
title: JioEvents Platform APIs
description: This section covers the JioEvents Platform APIs which can be used to quickly setup JioEvents
APIs in your backend for event management and virtual event hosting.
version: 1.0.0
servers:
- url: https://jioevents.com
tags:
- name: JioEventsCpaasPlatform
paths:
/api/platform/v1/meetingInvite:
post:
summary: Meeting Invite - Create a meeting invite
description: This API creates a meeting invite for a participant to join a scheduled webinar or
meeting
tags:
- JioEventsCpaasPlatform
parameters:
- name: Content-Type
in: header
description: The content type should be application/json
schema:
type: string
example: application/json
- name: Authorization
in: header
required: true
description: You need an app created on the JioEvents Platform and using the app credentials you
can create a JWT to access this API. The JWT should have an issuer and the key "app" with the
app id generated from the Platform.
schema:
type: string
example: <Authentication_token_signed_using_secret_or_private_key>
- name: Accept
in: header
description: The accept type should be application/json
schema:
type: string
example: application/json
requestBody:
content:
application/json:
schema:
type: object
properties:
role:
type: string
description: The role of the invitee (e.g., "Co-Host", "Host", "Participant")
example: Co-Host
firstName:
type: string
description: First name of the invitee
example: Test
lastName:
type: string
description: Last name of the invitee
example: user
identity:
type: string
description: Email address or identity of the invitee
example: m48519891@gmail.com
sendInvite:
type: boolean
description: Whether to send an email invite to the participant
example: true
meetingId:
type: string
description: The meeting ID for which the invite is being created
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
title: MeetingInviteRequestBody
example:
role: Co-Host
firstName: Test
lastName: user
identity: m48519891@gmail.com
sendInvite: true
meetingId: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
_id:
type: string
description: Unique identifier for the meeting invite
example: mi-984037ef-b959-4210-998a-2be29c14e72b
joinUrl:
type: string
description: The URL that the invitee can use to join the meeting
example: https://jioevents.com/meetingInvite/join/_tD6SZHCMQ50885cdde5341755725215006
joinHash:
type: string
description: Unique hash for joining the meeting
example: _tD6SZHCMQ50885cdde5341755725215006
firstName:
type: string
description: First name of the invitee
example: Test
lastName:
type: string
description: Last name of the invitee
example: user
emailId:
type: string
description: Email address of the invitee
example: m48519891@gmail.com
role:
type: string
description: The role assigned to the invitee
example: Co-Host
meetingId:
type: string
description: The meeting ID for which the invite was created
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
userId:
type: string
description: Unique identifier for the user
example: u-17dbc620-b434-4ef4-bc77-412e41f71911
isDeleted:
type: boolean
description: Whether the invite has been deleted
example: false
socialMediaLinks:
type: array
description: Array of social media links associated with the invitee
items:
type: string
example: []
registered:
type: boolean
description: Whether the invitee has registered
example: true
isInviteSent:
type: boolean
description: Whether the invite has been sent
example: false
sendInvite:
type: boolean
description: Whether to send an email invite
example: true
enableSpeakerTile:
type: boolean
description: Whether to enable speaker tile for this participant
example: true
orderId:
type: integer
description: Order ID for the invite
example: 1
cOn:
type: string
format: date-time
description: Creation timestamp
example: '2025-08-20T21:26:55.007Z'
mOn:
type: string
format: date-time
description: Last modification timestamp
example: '2025-08-20T21:26:55.007Z'
__v:
type: integer
description: Version number
example: 0
title: MeetingInviteResponseBody
examples:
Example1:
summary: Example meeting invite response
value:
_id: mi-984037ef-b959-4210-998a-2be29c14e72b
joinUrl: https://jioevents.com/meetingInvite/join/_tD6SZHCMQ50885cdde5341755725215006
joinHash: _tD6SZHCMQ50885cdde5341755725215006
firstName: Test
lastName: user
emailId: m48519891@gmail.com
role: Co-Host
meetingId: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
userId: u-17dbc620-b434-4ef4-bc77-412e41f71911
isDeleted: false
socialMediaLinks: []
registered: true
isInviteSent: false
sendInvite: true
cOn: '2025-08-20T21:26:55.007Z'
mOn: '2025-08-20T21:26:55.007Z'
__v: 0
'400':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'401':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'412':
content:
application/json:
summary: Validation Errors usually arise when the request body is incorrect
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errorsArray:
type: array
description: The errors array which includes objects with a "property" and "message"
properties describing the error
title: ValidationError
/api/platform/v1/sessions/{meetingId}/{sessionId}:
delete:
summary: Sessions - Delete a session
description: This API deletes a specific session for a meeting
tags:
- JioEventsCpaasPlatform
parameters:
- name: Authorization
in: header
required: true
description: You need an app created on the JioEvents Platform and using the app credentials you
can create a JWT to access this API. The JWT should have an issuer and the key "app" with the
app id generated from the Platform.
schema:
type: string
example: <Authentication_token_signed_using_secret_or_private_key>
- name: Content-Type
in: header
description: The content type should be application/json
schema:
type: string
example: application/json
- name: meetingId
in: path
required: true
description: The meeting ID for which to delete the session
schema:
type: string
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
- name: sessionId
in: path
required: true
description: The ID of the session to delete
schema:
type: string
example: se-77a4ef5e-0e86-4217-9f5b-08d766a48aef
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
description: Whether the delete operation was successful
example: true
title: DeleteSessionResponseBody
examples:
Example1:
summary: Example delete session response
value:
success: true
'400':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'401':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'412':
content:
application/json:
summary: Validation Errors usually arise when the request parameters are incorrect
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errorsArray:
type: array
description: The errors array which includes objects with a "property" and "message"
properties describing the error
title: ValidationError
/api/platform/v1/sessions/{meetingId}:
post:
summary: Sessions - Create a session
description: This API creates a session within a webinar/meeting
tags:
- JioEventsCpaasPlatform
parameters:
- name: Authorization
in: header
required: true
description: You need an app created on the JioEvents Platform and using the app credentials you
can create a JWT to access this API. The JWT should have an issuer and the key "app" with the
app id generated from the Platform.
schema:
type: string
example: <Authentication_token_signed_using_secret_or_private_key>
- name: Content-Type
in: header
description: The content type should be application/json
schema:
type: string
example: application/json
- name: meetingId
in: path
required: true
description: The meeting ID for which to create a session
schema:
type: string
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
requestBody:
content:
application/json:
schema:
type: object
properties:
description:
type: string
description: Description of the session
example: ''
descriptionMarkdown:
type: object
description: Markdown description configuration
properties:
text:
type: string
description: Markdown text content
example: ''
messageType:
type: string
description: Type of message
example: web
invites:
type: array
description: Array of session invites
items:
type: object
example: []
topic:
type: string
description: Topic/title of the session
example: Session2
startTime:
type: string
format: date-time
description: Start time of the session in ISO format
example: '2025-08-21T14:30:00.000Z'
endTime:
type: string
format: date-time
description: End time of the session in ISO format
example: '2025-08-21T15:00:00.000Z'
title: CreateSessionRequestBody
example:
description: ''
descriptionMarkdown:
text: ''
messageType: web
invites: []
topic: Session2
startTime: '2025-08-21T14:30:00.000Z'
endTime: '2025-08-21T15:00:00.000Z'
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Status message indicating the result of session creation
example: Session created successfully.
sessionDetails:
type: object
description: Detailed information about the created session
properties:
_id:
type: string
description: Unique identifier for the session
example: se-eff13292-c342-4394-85a1-e64b42fadd2b
topic:
type: string
description: Topic/title of the session
example: Session2
description:
type: string
description: Description of the session
example: ''
descriptionMarkdown:
type: object
description: Markdown description configuration
properties:
text:
type: string
description: Markdown text content
example: ''
messageType:
type: string
description: Type of message
example: web
meetingId:
type: string
description: Unique meeting ID for the session
example: sm-0666ba1c-c585-4193-a329-2fc23bd29e72
parentMeetingId:
type: string
description: ID of the parent webinar/meeting
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
type:
type: string
description: Type of session
example: normal
startTime:
type: string
format: date-time
description: Start time of the session in ISO format
example: '2025-08-21T14:30:00.000Z'
endTime:
type: string
format: date-time
description: End time of the session in ISO format
example: '2025-08-21T15:00:00.000Z'
invites:
type: array
description: Array of session invites
items:
type: object
example: []
status:
type: string
description: Current status of the session
example: active
isDeleted:
type: boolean
description: Whether the session has been deleted
example: false
cOn:
type: string
format: date-time
description: Creation timestamp
example: '2025-08-20T21:38:13.546Z'
mOn:
type: string
format: date-time
description: Last modification timestamp
example: '2025-08-20T21:38:13.546Z'
__v:
type: integer
description: Version number
example: 0
scheduledDuration:
type: integer
description: Duration of the session in milliseconds
example: 1800000
meetingUrl:
type: string
description: URL for joining the session
example: https://jioevents.com/shortener?meetingId=0161894358&pwd=dJy2y
userId:
type: string
description: ID of the user who created the session
example: u-5075a9a0-cfd0-4dd9-bca9-e441b0df9237
jiomeetId:
type: string
description: 10-digit unique ID for the session
example: 0161894358
pin:
type: string
description: PIN for joining the session
example: dJy2y
advancedOptions:
type: object
description: Advanced configuration options for the session
properties:
hostAudio:
type: boolean
description: Whether host audio is enabled
example: false
participantAudio:
type: boolean
description: Whether participant audio is enabled
example: true
hostVideo:
type: boolean
description: Whether host video is enabled
example: false
participantVideo:
type: boolean
description: Whether participant video is enabled
example: true
joinBeforeHost:
type: boolean
description: Whether participants can join before the host
example: true
waitingRoom:
type: boolean
description: Whether waiting room is enabled
example: false
loggedInOnly:
type: boolean
description: Whether only logged-in users can join
example: false
colleagueOnly:
type: boolean
description: Whether only colleagues can join
example: false
participantHardAudioMute:
type: boolean
description: Whether participants are hard muted for audio
example: false
participantHardVideoMute:
type: boolean
description: Whether participants are hard muted for video
example: false
isRestrictedMeeting:
type: boolean
description: Whether the meeting is restricted
example: false
isClassroomMode:
type: boolean
description: Whether classroom mode is enabled
example: false
restrictChat:
type: string
description: Chat restriction level
example: NONE
title: CreateSessionResponseBody
examples:
Example1:
summary: Example create session response
value:
status: Session created successfully.
sessionDetails:
_id: se-eff13292-c342-4394-85a1-e64b42fadd2b
topic: Session2
description: ''
descriptionMarkdown:
text: ''
messageType: web
meetingId: sm-0666ba1c-c585-4193-a329-2fc23bd29e72
parentMeetingId: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
type: normal
startTime: '2025-08-21T14:30:00.000Z'
endTime: '2025-08-21T15:00:00.000Z'
invites: []
status: active
isDeleted: false
cOn: '2025-08-20T21:38:13.546Z'
mOn: '2025-08-20T21:38:13.546Z'
__v: 0
scheduledDuration: 1800000
meetingUrl: https://jioevents.com/shortener?meetingId=0161894358&pwd=dJy2y
userId: u-5075a9a0-cfd0-4dd9-bca9-e441b0df9237
jiomeetId: 0161894358
pin: dJy2y
advancedOptions:
hostAudio: false
participantAudio: true
hostVideo: false
participantVideo: true
joinBeforeHost: true
waitingRoom: false
loggedInOnly: false
colleagueOnly: false
participantHardAudioMute: false
participantHardVideoMute: false
isRestrictedMeeting: false
isClassroomMode: false
restrictChat: NONE
'400':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'401':
content:
application/json:
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errors:
type: string
description: The error message of the API
title: CustomError
'412':
content:
application/json:
summary: Validation Errors usually arise when the request body is incorrect
schema:
type: object
properties:
customCode:
type: number
description: Status Code of the API
message:
type: string
description: The error code of the API
errorsArray:
type: array
description: The errors array which includes objects with a "property" and "message"
properties describing the error
title: ValidationError
get:
summary: Sessions - Get sessions
description: This API retrieves all sessions for a specific meeting including meeting details and
speakers
tags:
- JioEventsCpaasPlatform
parameters:
- name: Authorization
in: header
required: true
description: You need an app created on the JioEvents Platform and using the app credentials you
can create a JWT to access this API. The JWT should have an issuer and the key "app" with the
app id generated from the Platform.
schema:
type: string
example: <Authentication_token_signed_using_secret_or_private_key>
- name: meetingId
in: path
required: true
description: The meeting ID for which to retrieve sessions
schema:
type: string
example: sm-ead69d8e-8c30-42f1-9798-8acfa5dd1277
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
meetingDetails:
type: object
description: Details of the parent meeting
properties:
topic:
type: string
description: Topic/title of the meeting
example: Test1 user's JioEvent
startTime:
type: string
format: date-time
description: Start time of the meeting in ISO format
example: '2025-08-21T14:00:00.000Z'
topicMarkdown:
type: object
description: Markdown topic configuration
properties:
text:
type: string
description: Markdown text content
example: Test1 user's JioEvent
messageType:
type: string
description: Type of message
example: default
hash:
type: string
description: Hash value
example: ''
speakers:
type: array
description: List of speakers for the meeting
items:
type: object
properties:
_id:
type: string
description: Unique identifier for the speaker invite
example: mi-89577cd6-b306-4219-a28e-8e42c69c6891
firstName:
type: string
description: First name of the speaker
example: tp-088573cb-34d3-405d-a954-119ee6aaff92
lastName:
type: string
description: Last name of the speaker
example: ''
role:
type: string
description: Role of the speaker
example: Host
userId:
type: string
description: Unique identifier for the user
example: u-5075a9a0-cfd0-4dd9-bca9-e441b0df9237
socialMediaLinks:
type: array
description: Array of social media links
items:
type: string
example: []
sessions:
type: array
description: List of sessions for the meeting
items:
type: object
properties:
_id:
type: string
description: Unique identifier for the session
example: se-77a4ef5e-0e86-4217-9f5b-08d766a48aef
topic:
type: string
description: Topic/title of the session
example: Welcome Session
description:
type: string
description: Description of the session
example: ''
descriptionMarkdown:
type: object
description: Markdown description configuration
properties:
text:
type: string
description: Markdown text content
example: ''
m
# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/reliance-jio/refs/heads/main/openapi/reliance-jio-jioevents-platform-openapi.yml