Meetings Quick Start

Last updated: 2024-07-22

Contributors

The RingCentral Meetings API has been deprecated

The RingCentral Meetings API is being phased out in favor of our newer RingCentral Video API. Existing applications that have access to the Meetings API will continue to be supported, but new applications that require access to the RingCentral Meetings API will need to request the "Meetings" app scope be added to their application by a RingCentral support representative.

Paid RingCentral account and Meetings app scope required

In order to use this API, developers must have a paid RingCentral account. This API is not available to free developer accounts. In addition, applications that call this API require the "Meetings" application scope. To have this scope added to your application, please contact developer support.

Welcome to the RingCentral Platform. RingCentral is the leading unified communications platform. From one system developers can integrate with, or build products around all the ways people communicate today: SMS, voice, fax, chat and meetings.

In this Quick Start, we are going to help you creating a meeting on the platform in just a few minutes. Let's get started.

Create an app and obtain credentials

The first thing we need to do is create an app in the RingCentral Developer Console. This can be done quickly by clicking the "Create Meetings App" button below. Just click the button, enter a name and description if you choose, and click the "Create" button. If you do not yet have a RingCentral account, you will be prompted to create one.

Create Meetings App Show detailed instructions

Login or create an account if you have not done so already.
Go to Console/Apps and click 'Create App' button.
Select "REST API App" under "What type of app are you creating?" Click "Next."
Under "Auth" select "JWT auth flow."
Under "Security" select "This app is private and will only be callable using credentials from the same RingCentral account."

When you are done, you will be taken to the app's dashboard. Make note of the Client ID and Client Secret. We will be using those momentarily.

Request help from support

Access to the RingCentral Meetings API currently requires help from support in order to grant the "Meetings" application scope to your application.

Contact support to request the Meetings scope

Download and edit a `.env` file

Follow the instructions found in our guide to running Developer Guide code samples. Or:

Download our env-template and save it as a file named .env.
Edit your newly downloaded .env file, setting its variables with the proper values for the app you created above.
- RC_APP_CLIENT_ID - set to the Client ID of the app you created above
- RC_APP_CLIENT_SECRET - set to the Client Secret of the app you created above
- RC_USER_JWT - set to the JWT credential you created for yourself

Create a meeting

Select your preferred language below.

Javascript

Install RingCentral JavaScript SDK

$ npm install @ringcentral/sdk dotenv --save

Create and edit meetings.js

Create a file called meetings.js using the content below.

const RC = require('@ringcentral/sdk').SDK
require('dotenv').config();

var rcsdk = new RC({
    'server':       process.env.RC_SERVER_URL,
    'clientId':     process.env.RC_APP_CLIENT_ID,
    'clientSecret': process.env.RC_APP_CLIENT_SECRET
});
var platform = rcsdk.platform();
platform.login({
    'jwt': process.env.RC_USER_JWT
})

platform.on(platform.events.loginSuccess, () => {
      start_meeting()
});

async function start_meeting(){
  try{
    var endpoint = "/restapi/v1.0/account/~/extension/~/meeting"
    var resp = await platform.post(endpoint, {
              topic: 'Test Meeting',
              meetingType: 'Instant',
              allowJoinBeforeHost: true,
              startHostVideo: true,
              startParticipantsVideo: false

        })
    var jsonObj = await resp.json()
    console.log( 'Start Your Meeting: ' + jsonObj.links.startUri )
    console.log( 'Meeting id: ' + jsonObj.id )
  }catch(e){
    console.log(e.message)
  }
}

Run your code

You are almost done. Now run your script.

$ node meetings.js

Python

Install RingCentral Python SDK

$ pip install ringcentral python-dotenv

Create and edit meetings.py

Create a file called meetings.py using the contents below.

#!/usr/bin/env python
from ringcentral import SDK
import os,sys
from dotenv import load_dotenv
load_dotenv()

rcsdk = SDK( os.environ.get('RC_APP_CLIENT_ID'),
             os.environ.get('RC_APP_CLIENT_SECRET'),
             os.environ.get('RC_SERVER_URL') )
platform = rcsdk.platform()

try:
  platform.login( jwt=os.environ.get('RC_USER_JWT') )
except:
  sys.exit("Unable to authenticate to platform. Check credentials.")

params = {
    'topic': 'Test Meeting 1',
    'meetingType': 'Instant',
    'allowJoinBeforeHost': True,
    'startHostVideo': True,
    'startParticipantsVideo' : False
}

try:
    resp = platform.post('/restapi/v1.0/account/~/extension/~/meeting', params)
    print(f'Start Your Meeting: {resp.json().links.startUri}')
    print(f'Join the Meeting: {resp.json().links.joinUri}')
except Exception as err:
    sys.exit( f'An error occurred trying to post: {err}')
else:
    # Successful exit
    sys.exit(0)

Run your code

You are almost done. Now run your script.

$ python meetings.py

PHP

Install RingCentral PHP SDK

$ curl -sS https://getcomposer.org/installer | php
$ php composer.phar require ringcentral/ringcentral-php vlucas/phpdotenv

Create and Edit meetings.php

Create a file called meetings.php using the contents below.

<?php
r// Remember to modify the path ./../ pointing to the location where the RingCentral SDK was installed and the .env file was saved!
require('./../vendor/autoload.php');
$dotenv = Dotenv\Dotenv::createImmutable(__DIR__ . './../');
$dotenv->load();

$rcsdk = new RingCentral\SDK\SDK( $_ENV['RC_APP_CLIENT_ID'],
                                  $_ENV['RC_APP_CLIENT_SECRET'],
                                  $_ENV['RC_SERVER_URL'] );
$platform = $rcsdk->platform();
$platform->login( [ "jwt" => $_ENV['RC_USER_JWT'] ] );

$params = array(
    'topic' => 'Test Meeting',
    'meetingType' => 'Instant',
    'allowJoinBeforeHost' => true,
    'startHostVideo' => true,
    'startParticipantsVideo' => false
    );
try {
  $resp = $platform->post('/account/~/extension/~/meeting', $params);
  print_r ('Start Your Meeting: ' . $resp->json()->links->startUri . "\n");
  print_r ('Join the Meeting: ' . $resp->json()->links->joinUri . "\n");
} catch (Exception $e) {
  print_r ("An error occurred: " . $e->getMessage() . "\n");
}

Run your code

You are almost done. Now run your script.

$ php meetings.php

Create a Visual Studio project

Choose Console Application .Net Core -> App
Select Target Framework .NET Core 2.1
Enter project name "Create_Meeting"
Add NuGet package RingCentral.Net (4.1.0) SDK

Edit the file Program.cs

Be sure to edit the variables in ALL CAPS with your app and user credentials.

using System;
using System.Threading.Tasks;
using RingCentral;

namespace Create_Meeting
{
  class Program
  {
    static RestClient restClient;
    static async Task Main(string[] args)
    {
      restClient = new RestClient(
      Environment.GetEnvironmentVariable("RC_APP_CLIENT_ID"),
      Environment.GetEnvironmentVariable("RC_APP_CLIENT_SECRET"),
      Environment.GetEnvironmentVariable("RC_SERVER_URL"));
      await restClient.Authorize(Environment.GetEnvironmentVariable("RC_USER_JWT"));
      await create_meeting();
    }
    static private async Task create_meeting()
    {
      var parameters = new MeetingRequestResource();
      parameters.topic = "Test Meeting";
      parameters.meetingType = "Instant";
      parameters.allowJoinBeforeHost = true;
      parameters.startHostVideo = true;
      parameters.startParticipantsVideo = false;

      var resp = await restClient.Restapi().Account().Extension().Meeting().Post(parameters);
      Console.WriteLine("Start Your Meeting: " + resp.links.startUri);
      Console.WriteLine("join the Meeting: " + resp.links.joinUri);
    }
  }
}

Run Your Code

You are almost done. Now run your app from Visual Studio.

Java

Create a Java project (using Eclipse IDE)

Create a new Java project
Select the Gradle Project wizard
Enter project name "Create_Meeting"
Open the build.gradle file and add the RingCentral Java SDK to the project as shown below:

dependencies {
    // ...
    compile 'com.ringcentral:ringcentral:1.4.0'
}

Right-click the project in the Package Explorer and choose "Refresh Gradle Project" under the "Gradle" sub-menu

Create a new Java Class

Select "File -> New -> Class" to create a new Java class named "MeetingsQuickStart"

package com.ringcentral;

public class MeetingsQuickStart {

  public static void main(String[] args) {
    // TODO Auto-generated method stub

  }
}

Edit the file "MeetingsQuickStart.java".

Be sure to edit the variables in ALL CAPS with your app and user credentials.

package com.ringcentral;

import java.io.IOException;
import com.ringcentral.*;
import com.ringcentral.definitions.*;

public class MeetingsQuickStart {
    static RestClient rc;

    public static void main(String[] args) {
        var obj = new MeetingsQuickStart();
          rc = new RestClient(System.getenv("RC_APP_CLIENT_ID"),
                  System.getenv("RC_APP_CLIENT_SECRET"),
                  System.getenv("RC_SERVER_URL"));
        try {
            rc.authorize( System.getenv("RC_USER_JWT") );
            obj.createMeeting();
        }
        catch (RestException | IOException e) {
            e.printStackTrace();
        }
    }

    public void createMeeting() throws RestException, IOException {
        MeetingRequestResource parameters = new MeetingRequestResource();
        parameters.topic = "Instant Meeting";
        parameters.meetingType = "Instant";
        parameters.allowJoinBeforeHost = true;
        parameters.startHostVideo = true;
        parameters.startParticipantsVideo = false;

        var response = rc.restapi().account().extension().meeting().post(parameters);
        System.out.println("Start Your Meeting: " + response.links.startUri);
        System.out.println("Join the Meeting: " + response.links.joinUri);
    }
}

Run your app

You are almost done. Now run your app from Eclipse.

Ruby

Install RingCentral Ruby SDK

$ gem install ringcentral-sdk dotenv

Create and edit meetings.rb

Create a file called meetings.rb. Be sure to edit the variables in ALL CAPS with your app and user credentials.

require 'ringcentral'
require 'dotenv/load'

$rc = RingCentral.new( ENV['RC_APP_CLIENT_ID'],
                       ENV['RC_APP_CLIENT_SECRETCLIENRT_SECRET'],
                       ENV['RC_SERVER_URL'] )

$rc.authorize(jwt: ENV['RC_USER_JWT'])

resp = $rc.post('/restapi/v1.0/account/~/extension/~/meeting', payload: {
    topic: 'Ruby Meeting 1',
    meetingType: 'Instant',
    allowJoinBeforeHost: true,
    startHostVideo: true,
    startParticipantsVideo: false
})

puts "Start Your Meeting: " + resp.body['links']['startUri']
puts "Join the Meeting: " + resp.body['links']['joinUri']

Run your code

You are almost done. Now run your script.

$ ruby meetings.rb

Need help?

Having difficulty? Feeling frustrated? Receiving an error you don't understand? Our community is here to help and may already have found an answer. Search our community forums, and if you don't find an answer please ask!

Search the forums »

What's next?

When you have successfully made your first API call, it is time to take your next step towards building a more robust RingCentral application.

Take your next step »

Meetings Quick Start

Create an app and obtain credentials

Request help from support

Download and edit a .env file

Create a meeting

Install RingCentral JavaScript SDK

Create and edit meetings.js

Run your code

Install RingCentral Python SDK

Create and edit meetings.py

Run your code

Install RingCentral PHP SDK

Create and Edit meetings.php

Run your code

Create a Visual Studio project

Edit the file Program.cs

Run Your Code

Create a Java project (using Eclipse IDE)

Create a new Java Class

Edit the file "MeetingsQuickStart.java".

Run your app

Install RingCentral Ruby SDK

Create and edit meetings.rb

Run your code

Need help?

What's next?

Download and edit a `.env` file