RingCentral website screenshot

RingCentral

RingCentral provides unified cloud communications for businesses including voice, video, messaging, contact center, and events. The RingCentral API exposes call control, SMS, faxing, voicemail, presence, team messaging, video, and analytics.

15 APIs 0 Features
CommunicationsUCaaSVoiceVideoContact CenterSMSMessagingFax

APIs

RingCentral Voice API

The RingCentral Voice API enables developers to incorporate voice and phone functionality into applications. It supports placing calls (RingOut, WebRTC, URI scheme), call contro...

RingCentral SMS API

The RingCentral SMS API supports targeted and bulk SMS and MMS with deep insights and regulatory compliance built in. It supports sending and receiving messages, A2P 10DLC regis...

RingCentral Team Messaging API

The RingCentral Team Messaging API enables developers to build chatbots, send notifications, and create add-ins within RingCentral Team Messaging (formerly Glip). It supports po...

RingCentral Video API

The RingCentral Video API powers high-quality, secure video meetings in the browser without requiring a downloaded app. It exposes endpoints for scheduling meetings, joining/emb...

RingCentral Fax API

The RingCentral Fax API enables developers to add programmable and customizable fax sending and receiving capabilities to applications, including multi-attachment support, sched...

RingCentral Data API

The RingCentral Data API helps customers manage and ensure regulatory compliance with call data, message data, and video recordings, supporting bulk export, archival, and superv...

RingCentral Audio and Video AI API

The RingCentral Audio and Video AI API exposes speech-to-text, summarization, and conversational analytics on call and meeting media, enabling developers to extract transcripts,...

RingCentral Call Log API

The RingCentral Call Log API provides historical call data, recordings, and synchronization endpoints used to power analytics, billing, and compliance retention systems.

RingCentral Call Analytics API

The RingCentral Call Analytics API exposes aggregated metrics, KPIs, and reporting endpoints for inbound and outbound calling activity at the user, queue, department, and accoun...

RingCentral Presence API

The RingCentral Presence API exposes real-time and historical presence/availability state for users and call queues, including DND, telephony state, and meeting status, with sub...

RingCentral Voicemail API

The RingCentral Voicemail API enables retrieval, playback, and management of voicemail messages, including transcripts, attachments, and read/unread state.

RingCentral Provisioning API

The RingCentral Provisioning API supports account, extension, user, phone-number, device, and role lifecycle operations needed to programmatically onboard, configure, and manage...

RingCentral Webhooks and Subscriptions API

The RingCentral Webhooks and Subscriptions API delivers event notifications (telephony, messaging, presence, account, etc.) to subscriber endpoints via webhooks or PubNub channels.

RingCentral Contact Center API

The RingCentral Contact Center (RingCX) API provides programmatic access to omnichannel contact-center capabilities including agent state, queues, routing, real-time and histori...

RingCentral Events API

The RingCentral Events API supports the lifecycle of large-scale virtual and hybrid events including event creation, registration, sessions, sponsors, attendees, and reporting.

Collections

Pricing Plans

Rate Limits

Ringcentral Rate Limits

4 limits

RATE LIMITS

FinOps

Event Specifications

RingCentral Subscriptions and Event Notifications

AsyncAPI 2.6 description of the asynchronous event surface exposed by the RingCentral Subscription API. RingCentral delivers events from the RingCentral platform to subscribers ...

ASYNCAPI

Resources

🔗
LinkedIn
LinkedIn
🔗
Website
Website
🌐
DeveloperPortal
DeveloperPortal
🔗
Documentation
Documentation
🔗
APIReference
APIReference
🚀
GettingStarted
GettingStarted
🔑
Authentication
Authentication
🔗
RateLimits
RateLimits
💻
ErrorCodes
ErrorCodes
📦
SDKs
SDKs
🟢
StatusPage
StatusPage
💰
Pricing
Pricing
📝
Signup
Signup
🔗
Login
Login
👥
GitHubOrganization
GitHubOrganization
📰
Blog
Blog
📄
ChangeLog
ChangeLog
🔗
Webhooks
Webhooks
🔗
PostmanWorkspace
PostmanWorkspace
🔗
X (Twitter)
X (Twitter)
👥
YouTube
YouTube
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: RingCentral API
  version: 1.0.58-20240529-47eda8bd
request:
  auth:
    type: oauth2
    flow: authorization_code
    authorizationUrl: https://platform.ringcentral.com/restapi/oauth/authorize
    accessTokenUrl: https://platform.ringcentral.com/restapi/oauth/token
    credentials:
      clientId: '{{clientId}}'
      clientSecret: '{{clientSecret}}'
items:
- info:
    name: Webinar Subscriptions
    type: folder
  items:
  - info:
      name: List Webinar Subscriptions
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions
    docs: Returns a list of webinar subscriptions created by the user for the current authorized client application.
  - info:
      name: Create Webinar Subscription
      type: http
    http:
      method: POST
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions
      body:
        type: json
        data: '{}'
    docs: Creates a new webinar subscription for the current authorized user / client application.
  - info:
      name: Get Webinar Subscription
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId
      params:
      - name: subscriptionId
        value: '12345678'
        type: path
        description: Internal identifier of a subscription
    docs: Returns the webinar subscription by ID
  - info:
      name: Update Webinar Subscription
      type: http
    http:
      method: PUT
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId
      params:
      - name: subscriptionId
        value: '12345678'
        type: path
        description: Internal identifier of a subscription
      body:
        type: json
        data: '{}'
    docs: 'Updates the existing subscription. The client application can extend/narrow

      the list of events for which it receives notifications within this subscription.

      If event filters are specified, calling this method modifies them for the

      existing subscription. The method also allows setting the subscription expiration time.

      If other than `events` and `expiresIn` parameters are passed in the request they will be ignored.

      If the request body is empty then the specified subscription will be just renewed w'
  - info:
      name: Cancel Webinar Subscription
      type: http
    http:
      method: DELETE
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId
      params:
      - name: subscriptionId
        value: '12345678'
        type: path
        description: Internal identifier of a subscription
    docs: Cancels the existing webinar subscription.
  - info:
      name: Renew Webinar Subscription
      type: http
    http:
      method: POST
      url: https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId/renew
      params:
      - name: subscriptionId
        value: '12345678'
        type: path
        description: Internal identifier of a subscription
    docs: Renews the existing webinar subscription.
- info:
    name: Historical Webinars
    type: folder
  items:
  - info:
      name: Get Historical Webinar
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
    docs: Returns a historical webinar information by ID (host interface)
  - info:
      name: Get Historical Webinar Session
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
    docs: Returns a historical webinar Session by ID. Access allowed to participants with original role as Host or CoHost.
  - info:
      name: List Session Participants
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/participants
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: role
        value: ''
        type: query
        description: The role of the invitee/participant.
      - name: originalRole
        value: ''
        type: query
        description: The original role of the invitee/participant.
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of participants of a given Webinar Session (host interface).

      '
  - info:
      name: Get Participant Information
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/participants/self
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
    docs: 'Returns the participant information specific to a webinar session. Accessible by any authenticated participant.

      For a non-authenticated participant, API returns error.

      '
  - info:
      name: List Session Invitees
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/invitees
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: role
        value: ''
        type: query
        description: The role of the invitee/participant.
      - name: originalRole
        value: ''
        type: query
        description: The original role of the invitee/participant.
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of Invitees (co-hosts and panelists) of a given Webinar Session (host interface).

      An implicit record created for a Webinar ''Host'' is always returned.

      '
  - info:
      name: Get Session Invitee
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/invitees/:inviteeId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: inviteeId
        value: '77777777'
        type: path
        description: Identifier of the Session Invitee.
    docs: Returns a historical session invitee information by ID (host interface).
  - info:
      name: List Historical Webinar Sessions across Multiple Webinars / Hosts
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/company/sessions
      params:
      - name: hostUserId
        value: '77777777'
        type: query
        description: Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be
          returned)
      - name: status
        value: Active,Finished
        type: query
        description: Filter to return only webinar sessions in certain status. Multiple values are supported.
      - name: endTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'endTime' .
      - name: endTimeTo
        value: ''
        type: query
        description: The end of the time window by 'endTime' .
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of historical Webinar Sessions hosted by particular user(s) or all company users

      sorted by ''endTime'' in the descending order. Depending on a session status ''endTime'' can

      represent actual end time or scheduled end time.

      The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

      '
  - info:
      name: List Historical Webinar Sessions across Multiple Webinars
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/sessions
      params:
      - name: nameFragment
        value: All-hands
        type: query
        description: Filter to return only webinar sessions containing particular substring within their names
      - name: status
        value: Active,Finished
        type: query
        description: Filter to return only webinar sessions in certain status. Multiple values are supported.
      - name: endTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'endTime' .
      - name: endTimeTo
        value: ''
        type: query
        description: The end of the time window by 'endTime' .
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of historical Webinar Sessions hosted by a current authorized user

      sorted by ''endTime'' in the descending order. Depending on a session status ''endTime'' can

      represent actual end time or scheduled end time.

      '
- info:
    name: Historical Recordings
    type: folder
  items:
  - info:
      name: List Webinar Recordings (Admin)
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/company/recordings
      params:
      - name: nameFragment
        value: All-hands
        type: query
        description: Filter to return only webinar recordings containing particular substring within their names
      - name: creationTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'creationTime' .
      - name: creationTimeTo
        value: ''
        type: query
        description: The end of the time window by 'creationTime' .
      - name: status
        value: ''
        type: query
        description: The status of the recording.
      - name: hostUserId
        value: '77777777'
        type: query
        description: Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be
          returned)
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of webinar recordings (Administrator''s interface).

      The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

      '
  - info:
      name: Get Webinar Recording (Admin)
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/company/recordings/:recordingId
      params:
      - name: recordingId
        value: '7637637682'
        type: path
        description: Identifier of the Webinar recording.
    docs: 'Returns the webinar recording by ID (Administrator''s interface).


      The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

      '
  - info:
      name: List Webinar Recordings
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/recordings
      params:
      - name: creationTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'creationTime' .
      - name: creationTimeTo
        value: ''
        type: query
        description: The end of the time window by 'creationTime' .
      - name: status
        value: ''
        type: query
        description: The status of the recording.
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of webinar recordings for a given webinar host user

      '
  - info:
      name: Get Webinar Recording
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/recordings/:recordingId
      params:
      - name: recordingId
        value: '7637637682'
        type: path
        description: Identifier of the Webinar recording.
    docs: 'Returns the webinar recording by ID (Webinar host''s interface).

      This API also returns sharing link if sharing is enabled.

      '
  - info:
      name: Get Webinar Recording Download Resource
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/history/v1/recordings/:recordingId/download
      params:
      - name: recordingMediaType
        value: ''
        type: query
        description: 'Download file media type.

          - Type ''Video'' refers to a multiplexed audio and video file.

          - Type ''Audio'' refers to an audio only file.

          - Unless specified by this query parameter, a video file is returned by default when a recording is downloaded.

          '
      - name: recordingId
        value: '7637637682'
        type: path
        description: Identifier of the Webinar recording.
    docs: 'Returns the webinar recording download link (both Webinar host''s and admin interface).


      If called by a webinar host, the API returns error (403) if recording downloading is prohibited by company settings.

      The admin user who has "WebinarSettings" permission should be able to download recording regardless of current company
      settings.

      '
- info:
    name: Registration Management
    type: folder
  items:
  - info:
      name: Get Registration Session Info
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
    docs: 'Returns a registration Session information by ID.


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.

      '
  - info:
      name: Update Registration Session
      type: http
    http:
      method: PATCH
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      body:
        type: json
        data: '{}'
    docs: 'Updates a Session by ID.


      This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.


      If a session record with given ID doesn''t exist on Registration Service side the API should return HTTP 404.

      '
- info:
    name: Registrants
    type: folder
  items:
  - info:
      name: List Session Registrants
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
      - name: includeQuestionnaire
        value: ''
        type: query
        description: Indicates if registrant's "questionnaire" should be returned
    docs: 'Returns the list of Registrants ordered by "id" ascending.


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.

      '
  - info:
      name: Create Registrant
      type: http
    http:
      method: POST
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      body:
        type: json
        data: '{}'
    docs: 'Creates a new Registrant for a given session.


      Registration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.

      '
  - info:
      name: Get Registrant
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants/:registrantId
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: registrantId
        value: '77777777'
        type: path
        description: Identifier of the Session Registrant
      - name: includeQuestionnaire
        value: ''
        type: query
        description: Indicates if registrant's "questionnaire" should be returned
    docs: 'Returns a Registrant by ID.


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.

      '
  - info:
      name: Delete Registrant
      type: http
    http:
      method: DELETE
      url: https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants/:registrantId
      params:
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: registrantId
        value: '77777777'
        type: path
        description: Identifier of the Session Registrant
    docs: 'Deletes a Registrant by ID.


      Session must not be in finished state (otherwise it should return HTTP 403).


      A caller must be an authorized user: either a host of the webinar or an IT Admin:

      a user from host''s account with "WebinarSettings" permission.

      '
- info:
    name: Webinars and Sessions
    type: folder
  items:
  - info:
      name: List User's Webinars
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars
      params:
      - name: creationTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'creationTime' .
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of Webinars hosted by a current authorized user sorted by ''scheduledStartTime'' or ''creationTime''
      in the ascending order.

      '
  - info:
      name: Create Webinar
      type: http
    http:
      method: POST
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars
      body:
        type: json
        data: '{}'
    docs: 'Creates a new webinar.


      If "host" parameter is NOT passed then the current authorized user will become a Host.

      If "host" parameter is passed then the caller must be a company administrator and have "WebinarSettings" permission.

      "host.linkedUser.accountId" must be the same as authorized user''s account ID.


      The webinar settings which are not mandated at account level or are unlocked can be

      specified. All other settings are defaulted according to account policy.

      '
  - info:
      name: Get Webinar
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
    docs: 'Returns a Webinar information by ID.

      Some webinar settings are returned basing on webinar-level overrides, other - from default settings defined at account
      level.

      '
  - info:
      name: Update Webinar
      type: http
    http:
      method: PATCH
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      body:
        type: json
        data: '{}'
    docs: 'Updates a Webinar. The payload may contain just changed fields of a Webinar resource (it is a partial update):

      - host cannot be changed, and host user information cannot be updated;

      - only the settings which are not mandated at account level or are unlocked can be

      changed;

      - in order to reset a webinar password it should be passed as an empty string;

      - "registrationStatus" cannot be changed.

      '
  - info:
      name: Delete Webinar
      type: http
    http:
      method: DELETE
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
    docs: 'Deletes a Webinar by ID. All child objects (Sessions, Invitees) will be also deleted.

      It is disallowed to delete a Webinar which has at least one Session in ''Active'' or ''Finished'' state.

      '
  - info:
      name: Create Webinar Session
      type: http
    http:
      method: POST
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      body:
        type: json
        data: '{}'
    docs: Creates a new Session for a given Webinar
  - info:
      name: Get Webinar Session
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
    docs: Returns a Webinar Session by ID.
  - info:
      name: Update Webinar Session
      type: http
    http:
      method: PATCH
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      body:
        type: json
        data: '{}'
    docs: 'Updates a Webinar Session. The payload may contain certain attributes from the Session resource

      (it is a partial update). Changing the ''status'' field usually invokes certain workflow actions.

      Updating a Session in ''Active'' or ''Finished'' status is prohibited.

      Some status transitions (for example, to ''Active" or ''Finished'') may be prohibited.

      '
  - info:
      name: Delete Webinar Session
      type: http
    http:
      method: DELETE
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
    docs: 'Deletes a Webinar Session. All child objects (Invitees) will be also deleted.

      It is disallowed to delete a Session which is in ''Active'' or ''Finished'' state

      '
  - info:
      name: List Sessions across Multiple Webinars/Hosts
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/company/sessions
      params:
      - name: status
        value: Scheduled
        type: query
        description: Filter to return only webinar sessions in certain status. Multiple values are supported.
      - name: endTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'endTime' (it is calculated as scheduledStartTime+scheduledDuration)
      - name: hostUserId
        value: '77777777'
        type: query
        description: Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be
          returned)
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of Webinar Sessions hosted by all company users or particular user(s) sorted by

      ''scheduledStartTime'' or ''creationTime'' (if ''scheduledStartTime'' is not set) in the ascending ordered.

      The user must have "WebinarSettings" permission granted otherwise the API returns HTTP 403.

      '
  - info:
      name: List Sessions across Multiple Webinars
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/sessions
      params:
      - name: nameFragment
        value: All-hands
        type: query
        description: Filter to return only webinar sessions containing particular substring within their names
      - name: status
        value: Scheduled
        type: query
        description: Filter to return only webinar sessions in certain status. Multiple values are supported.
      - name: endTimeFrom
        value: ''
        type: query
        description: The beginning of the time window by 'endTime' (it is calculated as scheduledStartTime+scheduledDuration)
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of Webinar Sessions hosted by a current authorized user sorted by

      ''scheduledStartTime'' or ''creationTime'' (if ''scheduledStartTime'' is not set) in the ascending order

      '
- info:
    name: Invitees
    type: folder
  items:
  - info:
      name: List Session Invitees
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      - name: perPage
        value: '100'
        type: query
        description: 'The number of items per page. If provided value in the request

          is greater than a maximum, the maximum value is applied

          '
      - name: pageToken
        value: ''
        type: query
        description: 'The token indicating the particular page of the result set to be retrieved.

          If omitted the first page will be returned.

          '
    docs: 'Returns the list of Invitees (co-hosts and panelists in phase 1

      and also invited attendees in subsequent phases) of a given Webinar Session.

      An implicit record created for a Webinar ''Host'' is always returned.

      '
  - info:
      name: Bulk Add/Delete Session Invitees
      type: http
    http:
      method: PATCH
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees
      params:
      - name: webinarId
        value: '98989898'
        type: path
        description: Identifier of the Webinar.
      - name: sessionId
        value: '353535353'
        type: path
        description: Identifier of the Session.
      body:
        type: json
        data: '{}'
    docs: 'Adds, updates and deletes Webinar Session invitees in bulk (co-hosts and panelists in phase 1

      and also invited attendees in subsequent phases).

      The payload may contain multiple added, updated or deleted invitees.

      For each added record ''role'' and either ''firstName''/''lastName''/''email'' (for non-authenticated users)

      or ''linkedUser.*'' (for authenticated users) must be specified, but not both.

      For updated invitees ''id''  and ''role'' must be specified, ''linkedUser'' change is not supported.

      For deleted in'
  - info:
      name: Get Session Invitee
      type: http
    http:
      method: GET
      url: https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees/:invit

# --- truncated at 32 KB (414 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ringcentral/refs/heads/main/apis.yml