meeting

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Category of endpoints for Zoom meetings

Methods

addAltHost(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Add one alt-host if not already in the list. If another user in the alt-host list has been deactivated, all alt-hosts are removed and the requested user is added as the only alt-host. This is because Zoom doesn't give us enough information to determine which user is deactivated, and thus, the only way to resolve the issue is to remove all previously existing alt-hosts. (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
meetingId the id for the meeting to add hosts to
altHost the email or id of the alt host to be added
meetingObj <optional>
 Zoom meeting object that needs to be updated. Meeting ID is not used to fetch meeting if this object is passed
Returns:
updated meeting object after adding alternative host

create(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Create a new meeting (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
userId the user ID or email address of the user
meetingObj Zoom meeting object with meeting details https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}
Returns:
Zoom meeting object https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}

delete(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Delete a meeting (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Default Description
meetingId the Zoom ID of the meeting
occurrenceId <optional>
 ID for the meeting occurrence
notifyHosts <optional>
 false if truthy, sends cancellation email to hosts
Returns:
Zoom meeting object https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}

get(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Get info on a meeting (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Default Description
meetingId the Zoom ID of the meeting
occurrenceId <optional>
 ID for the meeting occurrence
showAllOccurrences <optional>
 false if truthy, retrieves all past occurrences
Returns:
Zoom meeting object

getActivitiesReport(opts)

Source:
Author:
  • Gabe Abrams
Get a meeting activities report (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
meetingId the Zoom UUID of the meeting
startTimestamp the start of the time range to get activities for, in ms since epoch
endTimestamp <optional>
 the end of the time range to get activities for, in ms since epoch. If not provided, defaults to startTimestamp + 24 hours
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 past meeting participants

getParticipantReport(opts)

Source:
Author:
  • Gabe Abrams
Get a participant report for a meeting (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
meetingId the Zoom UUID of the meeting
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 meeting participants with report details

getPastMeetingDetails(uuid)

Source:
Author:
  • Yuen Ler Chow
Get details of a past meeting instance (Light)
Parameters:
Name Type Description
uuid the Zoom UUID of the meeting
Returns:
details of a past meeting instance

getPollInfo(opts)

Source:
Author:
  • Yuen Ler Chow
Get poll info (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
meetingId the Zoom ID of the meeting
pollId the id of the poll
Returns:
object with all info about the poll

getQAReport(opts)

Source:
Author:
  • Gabe Abrams
Get a question and answer report for a meeting (Heavy)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
meetingId the Zoom UUID of the meeting
Returns:
list of questions and answers from the meeting

getTranscript(opts)

Source:
Author:
  • Gabe Abrams
Get meeting transcript (Medium)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
meetingId the Zoom ID of the meeting (or UUID of a past meeting instance)
Returns:
meeting transcript

listPastInstances(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Get a list of ended meeting instances (Medium)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Description
meetingId the Zoom ID of the meeting
Returns:
list of ended meeting instances https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/pastmeetings#responses

listPastMeetingParticipants(opts)

Source:
Author:
  • Gabe Abrams
Get list of participants in a past meeting (Medium)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
meetingId the Zoom UUID of the past meeting instance
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 past meeting participants

listPastPollOccurrences()

Source:
Author:
  • Yuen Ler Chow
List past poll occurrences (Medium)
Parameters:
Name Type Description
opts.uuid the Zoom UUID of the meeting
Returns:
list of past poll occurrences

update(opts)

Source:
Author:
  • Gabe Abrams
  • Aryan Pandey
Update a meeting (Light)
Parameters:
Name Type Description
opts object containing all arguments
Properties
Name Type Attributes Description
meetingId the Zoom ID of the meeting
meetingObj Zoom meeting object with updated details https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingupdate#request-body
occurrenceId <optional>
 ID for the meeting occurrence
Returns:
Zoom meeting object https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingcreate#request-body}