Zoom

Zoom module for RobinPath.

Package: @robinpath/zoom | Category: Utility | Type: Utility

Authentication

zoom.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the zoom module when you need to:

• listMeetings -- Use zoom.listMeetings to perform this operation
• getMeeting -- Use zoom.getMeeting to perform this operation
• createMeeting -- Use zoom.createMeeting to perform this operation
• updateMeeting -- Use zoom.updateMeeting to perform this operation
• deleteMeeting -- Use zoom.deleteMeeting to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure zoom credentials.	object
listMeetings	listMeetings	object
getMeeting	getMeeting	object
createMeeting	createMeeting	object
updateMeeting	updateMeeting	object
deleteMeeting	deleteMeeting	object
endMeeting	endMeeting	object
listMeetingRegistrants	listMeetingRegistrants	object
addMeetingRegistrant	addMeetingRegistrant	object
listRecordings	listRecordings	object
getRecording	getRecording	object
deleteRecording	deleteRecording	object
listUsers	listUsers	object
getUser	getUser	object
listWebinars	listWebinars	object
createWebinar	createWebinar	object
getMeetingParticipants	getMeetingParticipants	object
sendChatMessage	sendChatMessage	object
listChannels	listChannels	object

Functions

setCredentials

Configure zoom credentials.

Module: zoom | Returns: object -- API response.

zoom.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listMeetings

listMeetings

Module: zoom | Returns: object -- API response.

zoom.listMeetings

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMeeting

getMeeting

Module: zoom | Returns: object -- API response.

zoom.getMeeting

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createMeeting

createMeeting

Module: zoom | Returns: object -- API response.

zoom.createMeeting

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateMeeting

updateMeeting

Module: zoom | Returns: object -- API response.

zoom.updateMeeting

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteMeeting

deleteMeeting

Module: zoom | Returns: object -- API response.

zoom.deleteMeeting

Parameter	Type	Required	Description
input	string	No	Input parameter

---

endMeeting

endMeeting

Module: zoom | Returns: object -- API response.

zoom.endMeeting

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listMeetingRegistrants

listMeetingRegistrants

Module: zoom | Returns: object -- API response.

zoom.listMeetingRegistrants

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addMeetingRegistrant

addMeetingRegistrant

Module: zoom | Returns: object -- API response.

zoom.addMeetingRegistrant

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listRecordings

listRecordings

Module: zoom | Returns: object -- API response.

zoom.listRecordings

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getRecording

getRecording

Module: zoom | Returns: object -- API response.

zoom.getRecording

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteRecording

deleteRecording

Module: zoom | Returns: object -- API response.

zoom.deleteRecording

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listUsers

listUsers

Module: zoom | Returns: object -- API response.

zoom.listUsers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getUser

getUser

Module: zoom | Returns: object -- API response.

zoom.getUser

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listWebinars

listWebinars

Module: zoom | Returns: object -- API response.

zoom.listWebinars

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createWebinar

createWebinar

Module: zoom | Returns: object -- API response.

zoom.createWebinar

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getMeetingParticipants

getMeetingParticipants

Module: zoom | Returns: object -- API response.

zoom.getMeetingParticipants

Parameter	Type	Required	Description
input	string	No	Input parameter

---

sendChatMessage

sendChatMessage

Module: zoom | Returns: object -- API response.

zoom.sendChatMessage

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listChannels

listChannels

Module: zoom | Returns: object -- API response.

zoom.listChannels

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Zoom API error (${res.status}): ${t}	Check the error message for details
zoom.setCredentials requires accessToken.	Check the error message for details
zoom.updateMeeting requires an ID.	Check the error message for details
zoom.deleteMeeting requires an ID.	Check the error message for details
zoom.endMeeting requires an ID.	Check the error message for details
zoom.deleteRecording requires an ID.	Check the error message for details
Zoom: "..." not configured. Call zoom.setCredentials first.	Check the error message for details

@desc "List meetings and validate result"
do
  set $result as zoom.listMeetings
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Meetings

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "List meetings and iterate results"
do
  set $result as zoom.listMeetings
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createMeeting

Create a new resource and capture the result.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "Create meeting"
do
  set $result as zoom.createMeeting
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "Create meeting and update meeting"
do
  set $created as zoom.createMeeting
  # Update the created item
  zoom.updateMeeting
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "List meetings and create meeting"
do
  set $existing as zoom.listMeetings
  if $existing == null
    zoom.createMeeting
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Zoom workflow

Chain multiple zoom operations together.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "List meetings, get meeting, and more"
do
  set $r_listMeetings as zoom.listMeetings
  set $r_getMeeting as zoom.getMeeting
  set $r_createMeeting as zoom.createMeeting
  print "All operations complete"
enddo

6. Safe listMeetings with validation

Check results before proceeding.

@desc "Setup authentication"
do
  zoom.setCredentials $token
enddo

@desc "List meetings and validate result"
do
  set $result as zoom.listMeetings
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• json -- JSON module for complementary functionality