{
  "opencollection": "1.0.0",
  "info": {
    "name": "RingCentral Adaptive Cards Historical Webinars 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": "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\nis greater than a maximum, the maximum value is applied\n"
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n"
              }
            ]
          },
          "docs": "Returns the list of participants of a given Webinar Session (host interface).\n"
        },
        {
          "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.\nFor a non-authenticated participant, API returns error.\n"
        },
        {
          "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\nis greater than a maximum, the maximum value is applied\n"
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n"
              }
            ]
          },
          "docs": "Returns the list of Invitees (co-hosts and panelists) of a given Webinar Session (host interface).\nAn implicit record created for a Webinar 'Host' is always returned.\n"
        },
        {
          "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\nis greater than a maximum, the maximum value is applied\n"
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n"
              }
            ]
          },
          "docs": "Returns the list of historical Webinar Sessions hosted by particular user(s) or all company users\nsorted by 'endTime' in the descending order. Depending on a session status 'endTime' can\nrepresent actual end time or scheduled end time.\nThe user must have \"WebinarSettings\" permission granted otherwise the API returns HTTP 403.\n"
        },
        {
          "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\nis greater than a maximum, the maximum value is applied\n"
              },
              {
                "name": "pageToken",
                "value": "",
                "type": "query",
                "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n"
              }
            ]
          },
          "docs": "Returns the list of historical Webinar Sessions hosted by a current authorized user\nsorted by 'endTime' in the descending order. Depending on a session status 'endTime' can\nrepresent actual end time or scheduled end time.\n"
        }
      ]
    }
  ],
  "bundled": true
}