Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Bridge Management API

The Bridge Management API from RingCentral — 5 operation(s) for bridge management.

RingCentral Bridge Management API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bridge Management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 7 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

7 operations 5 paths 19 schemas 1 DELETE4 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Bridge Management API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Bridge Management 7
POST
/rcvideo/v2/account/{accountId}/extension/{extensionId}/bridges
Create Bridge
createBridge 2 params body → 201406409500
GET
/rcvideo/v2/account/{accountId}/extension/{extensionId}/bridges/default
Get User's Default Bridge
getDefaultBridge 2 params → 200404500
GET
/rcvideo/v2/bridges/pin/pstn/{pin}
Search Bridge by PSTN PIN
getBridgeByPstnPin 3 params → 200404500
GET
/rcvideo/v2/bridges/pin/web/{pin}
Search Bridge by Web PIN
getBridgeByWebPin 2 params → 200404500
GET
/rcvideo/v2/bridges/{bridgeId}
Get Bridge
getBridge 2 params → 200404500
PATCH
/rcvideo/v2/bridges/{bridgeId}
Update Bridge
updateBridge 1 param body → 200403404406409500
DELETE
/rcvideo/v2/bridges/{bridgeId}
Delete Bridge
deleteBridge 1 param → 204403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BridgePreferences (9 properties), BridgeResponse (8 properties), BridgeResponseSecurity (5 properties), BridgeRequestSecurity (5 properties). Each schema is shown below with its type and property counts.

BridgePinsWithAliases
object
3 properties
AutoShared
object
Controls whether recording can be auto shared
2 properties
BridgePreferences
object
9 properties
RecordingsPreferences
object
Recordings preferences
2 properties
BridgeDiscovery
object
1 property
BridgeResponseSecurity
object
5 properties
BridgeJoinPstnPreferences
object
2 properties
BridgePinsWithoutPstn
object
1 property
BridgeRequestSecurity
object
5 properties
BridgeResponseSecurityPassword
object
3 properties
WebPin
string
Bridge short identifier (Web PIN). The digital unique code which is used to join to a meeting. If it is not specified while creation, then a code will be gener…
EveryoneCanControl
object
Controls whether participants can start and pause recording
2 properties
CreateBridgeRequest
object
5 properties
BridgeJoinPreferences
object
4 properties
User
object
2 properties 2 required
BridgePstnPins
object
2 properties
UpdateBridgeRequest
object
4 properties
BridgePins
object
2 properties
BridgeResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-bridge-management-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API