The Meetings API allows you to integrate real-time, high-quality interactive video meetings into your web apps.
You can try out the Meetings API in the Vonage API Dashboard.
- Requirements: What you will need to get started.
- Terminology: Key terms and definitions for the Meetings API.
- Room Types: Defines the types of rooms available.
- Code Snippets: Code and instructions for using the Meetings API.
- Reference: Further information about the Meetings API.
Vonage Developer Account: If you don’t have a Vonage account yet, you can get one here: Vonage Developers Account.
Application ID and Private Key: Once you’re logged in to the Vonage API Dashboard, click on Applications and create a new Application. Generate a public and private key and record the private key.
- Room: the virtual space in which the video meeting takes place. See Room Types below.
- Owner: usually the creator of the room, this person has special administration capabilities.
- Guest: people attending meeting. Guests have access to standard meeting features.
Set up and Configuration:
- Request: the code snippet you submit to set up a room.
- Response: the data that is returned from your request.
Meeting Room ID: the
IDis a session identifier which is returned in the response to a meeting request.
- Session: defined as all events that occur during this time, from when the first participant joins, until the last to leave.
- Guest URL: meeting room URL used by guests.
- Host URL: meeting room URL with meeting administration capabilities used by the host.
- Chat: space for sending written messages that are visible to all attendees in the room.
- Recording: you can start a recording manually during a meeting, or set the meeting to record automatically when sending a request.
- Room Management: you can delete, update or retrieve information about rooms.
- Callbacks: allow you to receive information about a session.
There are two room types:
- Created for a meeting happening now.
- Active for ten (10) minutes until the first participant joins the room. If no one joins the room within the ten minutes, the room is deleted.
- Active for ten minutes after the last participant leaves, then it is deleted.
Long Term Room:
- Remains alive until the expiration date you specify (maximum one year).
- Typically linked to a recurring meeting, person, or resource.
- Will require you to specify an expiration date (in ISO format).
- Enables you to request that a room is automatically deleted ten minutes after the last participant leaves the room.