Meetings API Overview

The Meetings API allows you to integrate real-time, high-quality interactive video meetings into your web apps.

Contents

• 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.

Requirements

Vonage Developer Account: If you don’t have a Vonage account yet, you can get one here: Vonage Developers Account.

Meetings API Activation: To activate the Meetings API, you need to register with us. Please send an email request, with your API key from the Vonage API Dashboard, to the Meetings API Team.

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.

JSON Web Token (JWT): Use the JWT Generator to create a JWT using the Application ID and Private Token mentioned above. For further details about JWTs, please see Vonage Authentication.

Terminology

• Room: the virtual space in which the video meeting takes place. See Room Types below.
• Participants:
  • 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 ID is 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.
  • Theme: the set of colors, logos and styles to apply to given rooms in the account.
• Features:
  • Whitelabel: ability to create rooms with specific branding or color schemes.
  • 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.

Room Types

There are two room types:

• Instant Room:
  • 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.

Code Snippets

• Create an Instant Room
• Create a Long Term Room
• Theme Management
• Meeting Room Management
• Callbacks

Reference

• Meetings API Reference