Meetings API Callbacks
The Meetings API callbacks allow you to receive information about session events, participant activity, recording details, and room expiration.
Configuring Callbacks
To use callbacks, enable the Meetings API capability in your application via the Vonage API Dashboard. There are three URLs that you can configure:
- Rooms URL - Get information about the meeting rooms you manage.
- Sessions URL - Get information about sessions, such as start time, participants joined, and more.
- Recording URL - Receive recording information and download links once available.
Types of Callback
The following table describe each type of callback notification:
| Name | Description |
|---|---|
room:expired | The room is inactive. Sessions cannot be created for inactive rooms. |
session:started | A session has started. |
session:ended | A session has finished. |
recording:started | A recording is beginning within a session. |
recording:ended | A recording has been stopped within a session. |
recording:uploaded | A recording is ready to be downloaded. |
participant:joined | Someone has joined a session. |
session:participant:left | Someone has left a session. |
Example Payloads
Room Expired
A notification that a room has expired. Sessions cannot be created for inactive rooms.
Session Started
A notification that a session has started.
Session Ended
A notification that a session has ended.
Recording Started
A notification that recording has started for a session.
Recording Ended
A notification that recording has ended for a session.
Recording Uploaded
A notification that a recording of a session has been uploaded, and can be accessed via the url.
Participant Joined
A notification about someone entering a session.
Participant Left
A notification about someone leaving a session.