Clarification on zmClient.join() error handling in Zoom Web Video SDK

Video SDK Web
1

Description

  • When calling await state.zmClient.join(meetingId, token, userName, passcode);, I would like to know what is returned if the join operation fails. Does this method throw an exception or return a specific error object?

Browser Console Error

No specific error at this point. I just want to confirm the error handling behavior of the join() method.

Which Web Video SDK version?

Video SDK v2.2.5

Video SDK Code Snippets

try {
  await state.zmClient.join(meetingId, token, userName, passcode);
  console.log('Join success');
} catch (err) {
  console.error('Join failed:', err);
}

Device

  • Device:
  • OS: Window 11
  • Browser: Chrome 134.0.x

Additional context

I would like to confirm whether the join() method always throws an error (e.g. for invalid token or ended meeting) or if it simply rejects the promise with a specific error message.

Thank you

2

Hi @Thong1 The join() method will return a Promise<““ | ExecutedFailure> .

Success will return a string. Errors will be an object you will need to catch to view the contents.

More detail can be found here: ZoomVideo | Zoom Video SDK for Web - 2.2.5

3

Hi @Thong1

if it simply rejects the promise with a specific error message

The rejected promise will include an errorCode. The definitions of the specific errorCodes can be found in this document.

Thanks
Vic