Scheduling and creating a meeting bridge

What is difference between a meeting and a bridge?

Some may notice that the name of the endpoint to create a meeting makes reference to a "bridge." A meeting bridge is, for all intents and purposes, a virtual meeting room. These virtual meeting rooms, just like a meeting rooms in real-life, can be re-used for different meetings and different groups of people. Unlike a physical meetings room, however, a bridge can also be used once and then thrown away for maximum security and privacy.

A "meeting" on the other hand is created the moment a person connects to a bridge. That same meeting ends when the last person disconnects from the bridge, and the virtual meeting room is once again empty.

This means that when you "create a meeting," what you are really creating is a bridge in which that meeting will take place.

How do you create a meeting bridge via the API?

The following Javascript code can be used to create a RingCentral Video meeting bridge. Our Video Quick Start guide include a more complete code sample (with authentication for example) than the one shown below. The code sample below also showcases a wide array of configuration options, not all of which are required.

      var resp = await platform.post('/rcvideo/v2/account/~/extension/~/bridges', {
          "name": "Weekly Meeting with General Organa",
          "type": "Scheduled",
          "security": {
              "passwordProtected": true,
              "password": "Wq123ygs15",
              "noGuests": false,
              "sameAccount": false,
              "e2ee": false
          },
          "preferences": {
              "join": {
                  "audioMuted": false,
                  "videoMuted": false,
                  "waitingRoomRequired": "Nobody",
                  "pstn": {
                      "promptAnnouncement": true,
                      "promptParticipants": true
                  }
              },
              "playTones": "Off",
              "musicOnHold": true,
              "joinBeforeHost": true,
              "screenSharing": true,
              "recordingsMode": "User",
              "transcriptionsMode": "User",
              "recordings": {
                  "everyoneCanControl": {

Setting the bridge's type

The type parameter can take one of three values and impacts the longevity and behavior of the bridge after it is created.

Setting the bridge's security parameters

The security parameter takes a number of key/value pairs to govern the bridge's security.

Setting the bridge's preferences

The preferences parameter takes a number of key/value pairs to govern the bridge's general behavior.

How do you schedule a meeting on behalf of someone else?

See scheduling on behalf of another.

Setting and retrieving the join URL

The URL used by participants to join a meeting is found in the response, using the discovery element returned.

How do you set the time and date for a meeting?

RingCentral Video approaches meetings differently than other platforms. We do not store time, date and location information for a meeting. We instead defer to the user's calendaring system as the source of record for when and where meetings are going to occur. This approach eliminates the need for data synchronization, and makes compliance easier to maintain.

What is the difference between host pin and the participant pin?

When a meeting is created, RingCentral will return a meeting object within which you will observe a pstn pin for participants and hosts. These codes are only used within the context of PTSN (accessing a meeting over the phone) and are used to allow hosts and participants to "login" via their keypad.

When used to login to a meeting over the phone, the hostCode is intended to be used by the host only, and gives that individual additional controls over the meeting.

How to fetch the details relating to a bridge

The details relating to a bridge can be retrieved via the following methods and endpoints:

• GET /rcvideo/v2/bridges/{bridgeId}
• GET /rcvideo/v2/bridges/pin/web/{pin}
• GET /rcvideo/v2/bridges/pin/pstn/{pin}

How to update and delete a bridge

A bridge can be updated via the following method and endpoint, and by using the schema documented above.

PATCH /rcvideo/v2/bridges/{bridgeId}

A bridge can be deleted via the following method and endpoint:

DELETE /rcvideo/v2/bridges/{bridgeId}