webinar

Source:
Author:
  • Gabe Abrams
Category of endpoints for Zoom webinars

Methods

addPanelist(opts)

Source:
Author:
  • Gabe Abrams
Add one panelist if not already in the list (Medium)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
webinarId the id for the webinar to add a panelist to
panelistName the name of the panelist
panelistId the email or id of the panelist

create(opts)

Source:
Author:
  • Gabe Abrams
Create a webinar (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
userId the user ID or email address of the user who will own the webinar
webinarObj Zoom webinar object with webinar details https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body
Returns:
Zoom Webinar object https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses

get(opts) → {Webinar}

Source:
Author:
  • Gabe Abrams
Get info on a Webinar (Light)
Parameters:
Name Type Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
webinarId number the Zoom ID of the Webinar
occurrenceId string <optional>
 ID for the Webinar occurrence
showAllOccurrences boolean <optional>
 false if truthy, retrieves all past occurrences
Returns:
Zoom Webinar object https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinar
Type
Webinar

getParticipantReport(opts)

Source:
Author:
  • Gabe Abrams
Get a list of participants for a webinar (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
webinarId the id for the webinar to query
onNewPage <optional>
 callback function that is called when a new page of results is received.
minMsBetweenPageRequests <optional>
 minimum time (in ms) to wait between paginated requests, for custom throttle control
Returns:
list of participants

getPollReport(opts)

Source:
Author:
  • Gabe Abrams
Get a poll report for a webinar (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
webinarId the id for the webinar to query
Returns:
list of polls

getQAReport(opts)

Source:
Author:
  • Gabe Abrams
Get a Q&A report for a webinar (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
webinarId the id for the webinar to query
Returns:
Q&A report for the webinar

listPanelists(opts)

Source:
Author:
  • Gabe Abrams
Get a list of panelists for a webinar (Medium)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
webinarId the id for the webinar to query
Returns:
list of panelists