Options
All
  • Public
  • Public/Protected
  • All
Menu

Definition of exception code

Index

Enumeration members Audio

Enumeration members CRC

Enumeration members Camera control

Enumeration members Chat

Enumeration members Client

Enumeration members Command channel

Enumeration members Common

Enumeration members Common stream

Enumeration members Live streaming

Enumeration members PSTN

Enumeration members Recording

Enumeration members Screen share

Enumeration members Session

Enumeration members Subsession

Enumeration members Transcription

Enumeration members Video

Enumeration members Video processor

Audio Enumeration members

AUDIO_CAPTURE_FAILED = 6010

Occurs in stream.startAudio method, the sub reason as follows:

  • 1- Permission denied by user
  • 2- Permission denied by system
  • 3- Device in use
  • 4- No device found
  • 5- Unknown reason
  • 6- Constraint violation
  • 7- Permission dismissed by user
AUDIO_CAPTURE_LOADING = 6011

Occurs in stream.startAudio or stream.stopAudio method, the audio capture is in loading

AUDIO_ENCODING_REQUIRED = 6013

Occurs in stream.startAudio method, only occurs on legacy Safari browser, the audio decoding/encoding is required.

Legacy Safari Only

AUDIO_IN_PSTN = 6012

Occurs in stream.startAudio method, the audio is already connected by a PSTN call.

AUDIO_NOT_STARTED = 6015

Occurs in the stream.mute/unmuteAudio or stream.mute/unmuteShareAudio methods when audio or shared audio has not been started.

AUDIO_SHARE_AUDIO_CONFLICT = 6014

Occurs in stream.stopAudio method, only occurs on legacy Chrome browsers when sharing tab audio or system audio.

Legacy Chrome Only

SECONDARY_AUDIO_DEVICE_CONFLICT = 6018

Occurs in stream.startSecondaryAudio method due to the microphone ID being used for session audio.

SECONDARY_AUDIO_NOT_STARTED = 6020

Occurs in stream.stopSecondaryAudio method, due to the secondary audio not being started.

SECONDARY_AUDIO_SCREEN_SHARING_CONFLICT = 6019

Occurs in stream.startSecondaryAudio method due to screen sharing being in progress.

SECONDARY_AUDIO_UNSUPPORTED = 6017

Occurs in stream.startSecondaryAudio method due to the platform being unsupported.

CRC Enumeration members

CRC_NOT_CONNECTED = 6023

Occurs in stream.cancelCallCRCDevice method due to the CRC device not being connected.

Camera control Enumeration members

FAR_END_CAMERA_CONTROL_DEVICE_UNSUPPORTED = 6150

Occurs in stream.controlCamera or stream.controlFarEndCamera or stream.requestFarEndCameraControl methods due to camera control being unsupported on the platform.

FAR_END_CAMERA_CONTROL_MISMATCH_STATE = 6151

Occurs in stream.requestFarEndCameraControl or stream.approveFarEndCameraControl or stream.declineFarEndCameraControl or stream.giveUpFarEndCameraControl or stream.controlCamera methods due to the camera control is mismatch.

FAR_END_CAMERA_INVALID_RANGE = 6153

Occurs in stream.controlFarEndCamera method because the range is invalid.

FAR_END_CAMERA_PERMISSION_REQUIRED = 6152

Occurs in stream.controlFarEndCamera method because the camera control permission is not granted.

FAR_END_CAMERA_RATE_LIMIT = 6154

Occurs in stream.controlFarEndCamera method because the method call rate has exceeded the limit.

Chat Enumeration members

CHAT_DELETE_ACCOUNT_DISABLE = 7011

Occurs in chat.deleteMessage method because the delete chat message is disabled in the account.

CHAT_EMPTY_FILE = 7005

Occurs in chat.sendFile method because the file is empty.

CHAT_EMPTY_MESSAGE = 7000

Occurs in chat.send method because the message is empty.

CHAT_EXCEED_FILE_SIZE = 7008

Occurs in chat.sendFile method because the file size exceed the max size. Refer to the account setting update the file size limit.

CHAT_FILE_ACCOUNT_DISABLE = 7010

Occurs in chat.sendFile method because the file transfer function is disabled in the account.

CHAT_INSUFFICIENT_PRIVILEGE = 7002

Occurs in chat.send method because the privilege is not allowed.

CHAT_INVALID_MSG_ID_OR_URL = 7009

Occurs in chat.downloadFile method because the message ID or file URL is invalid.

CHAT_INVALID_PRIVILEGE = 7003

Occurs in chat.setPrivilege method because only the host or manager can set the privilege.

CHAT_INVALID_RETRY_TOKEN = 7006

Occurs in chat.sendFile method because the retry token is invalid.

CHAT_MISMATCH_FILE_TYPE = 7007

Occurs in chat.sendFile method because the file is not in the allowed file type. Refer to the account setting update the allowed file types.

CHAT_MISMATCH_USER = 7001

Occurs in chat.send method because the user does not match.

CHAT_SUBSESSION_CONFLICT = 7004

Occurs in chat.setPrivilege or chat.sendFile methods because the user is in a subsession.

Client Enumeration members

CLIENT_DEPENDENT_ASSETS_INACCESSIBLE = 5001

Occur in the client.init method, due to the inability to access self-deployed dependent assets

CLIENT_DUPLICATED_JOIN = 5012

Occurs in client.join method due to a duplicate call while the user is already in a session.

CLIENT_HOST_DISALLOW_RENAME = 5014

Occurs in client.changeName method due to the host disallowing users from changing their names themselves.

CLIENT_HOST_OR_MANAGER_PERMISSION_REQUIRED = 5006

Operation requires host or manager permission

CLIENT_HOST_PERMISSION_REQUIRED = 5007

Operation requires host permission.

CLIENT_INVALID_JOIN_PARAMETER = 5013

Occurs in client.join method due to the parameter is incorrect.

  • invalid signature
  • Topic, token and userName must be string and required
  • The maximum length of topic is 200
  • The maximum length of username is 200
  • The maximum length of password is 10
CLIENT_MISMATCH_USER = 5011

User ID doesn't match

CLIENT_ORIGIN_HOST_PERMISSION_REQUIRED = 5008

Operation requires origin host or manager permission.

CLIENT_PLATFORM_UNSUPPORTED = 5000

Occur in the client.init method because the platform does not meet the basic WebRTC requirements.

CLIENT_SESSION_STATE_CLOSED = 5002

Called a function that requires the user to be in a session, but the session is closed.

CLIENT_SESSION_STATE_RECONNECTING = 5003

Called a function that requires the user to be in a session, but the session is reconnecting.

Command channel Enumeration members

CMD_CHANNEL_NOT_READY = 7104

Occurs in cmd.send method because the channel is not ready.

CMD_EMPTY_MESSAGE = 7100

Occurs in cmd.send method because the message is empty.

CMD_EXCEED_MESSAGE_LENGTH = 7103

Occurs in cmd.send method because the message length exceed the max length(512 bytes).

CMD_INVALID_MESSAGE_TYPE = 7102

Occurs in cmd.send method because the message type is not a string.

CMD_MISMATCH_USER = 7101

Occurs in cmd.send method because the user does not match.

Common Enumeration members

INTERNAL_ERROR = 2

Internal error

This type of error is caused by a Zoom service issue. If you encounter this error, please report it to Zoom.

OPERATION_TIMEOUT = 1

Operation timeout

This type of error is caused by a Zoom service issue. If you encounter this error, please report it to Zoom.

Common stream Enumeration members

STREAM_MISMATCH_DEVICE = 6000

The device ID (microphone, audio speaker, camera) does not match any device in the list.

STREAM_MISMATCH_RENDER_ELEMENT = 6003

Occurs in video or sharing-related functions when the target element does not match the required render element type.

STREAM_MISMATCH_USER = 6001

User ID doesn't match

STREAM_SESSION_JOIN_REQUIRED = 6002

Occurs when a method is called before the client.join method has resolved.

Live streaming Enumeration members

LIVE_STREAM_ACCOUNT_DISABLE = 7400

Occurs in liveStream.startLiveStream method because the live stream is disabled in the account.

LIVE_STREAM_INVALID_PARAMETER = 7401

Occurs in liveStream.startLiveStream method because the parameter is invalid.

LIVE_STREAM_MISMATCH_STATE = 7402

Occurs in liveStream.startLiveStream method because the live stream is in progress.

PSTN Enumeration members

PSTN_MISMATCH_COUNTRY_CODE = 6021

Occurs in stream.inviteByPhone method due to the country code does not match any code in the list.

PSTN_NOT_CONNECTED = 6022

Occurs in stream.hangup method due to the PSTN being not being connected.

Recording Enumeration members

RECORDING_ACCOUNT_DISABLE = 7200

Occurs in recording.startCloudRecording method because the cloud recording is not enabled in the account setting.

RECORDING_ISO_DISABLE = 7203

Occurs in recording.acceptIndividualRecording method because the individual recording is not enabled.

RECORDING_MISMATCH_STATE = 7202

Occurs in recording.startCloudRecording method because the recording state does not match.

RECORDING_STOP_FORBIDDEN = 7201

Occurs in recording.startCloudRecording method because pausing/stopping cloud recording is forbidden in the account setting.

Screen share Enumeration members

SCREEN_SHARE_HOST_PRIVILEGE_REQUIRED = 6204

Occurs in stream.startShareScreen method because only the host has the share privilege

SCREEN_SHARE_INVALID_PRIVILEGE = 6208

Occurs in stream.setScreenSharePrivilege method because privilege is invalid.

SCREEN_SHARE_MISMATCH_STATE = 6205

Occurs in stream.startShareScreen or stream.shareToBreakoutRoom or stream.enableOptimizeForSharedVideo or stream.muteOthersScreenShare methods because the screen share state does not match.

SCREEN_SHARE_OPTIMIZE_VIDEO_CONFLICT = 6207

Occurs in stream.enableOptimizeForSharedVideo method because multiple screen sharing is being enabled.

SCREEN_SHARE_OPTIMIZE_VIDEO_UNSUPPORTED = 6206

Occurs in stream.startShareScreen or stream.enableOptimizeForSharedVideo methods because the platform does not support the video share.

SCREEN_SHARE_SUBSESSION_CONFLICT = 6203

Occurs in stream.startShareScreen method because the user attempted to share their screen to subsessions while already in a subsession.

SCREEN_SHARE_SYSTEM_DENIED = 6201

Occurs in stream.startShareScreen method because the permission in the system setting is not allowed.

SCREEN_SHARE_UNSUPPORTED = 6202

Occurs in stream.startShareScreen method because the platform does not support getDisplayMedia method.

SCREEN_SHARE_USER_DENIED = 6200

Occurs in stream.startShareScreen method because the user denied the screen share.

Session Enumeration members

SESSION_ENDED = 4004

The session has been ended.

SESSION_EXCEED_CAPACITY = 4005

The number of users in the session exceeds the capacity.

SESSION_FETCH_INFO_ERROR = 200

Session creation or retrieval error—this is usually caused by an incorrect field value in the JWT token.

  • connection error
  • The token has expired, is over 2 days old, or is ineffective
  • Password max of 10 characters
  • This account does not exist or does not belong to you
  • Verify JWT failed
  • invalid session key
SESSION_INCORRECT_PASSCODE = 3004

The session passcode is incorrect.

SESSION_INVALID_PARAMETER = 4003

Incorrect parameters for connecting to the Zoom server. If you encounter this issue, please report it to Zoom.

SESSION_ROLE_TYPE_ERROR = 3010

The role type in jwt token is incorrect.

SESSION_USER_REMOVED = 3009

The user was removed by the session host and is prevented from rejoining the same session.

Subsession Enumeration members

SUBSESSION_ACCOUNT_DISABLE = 7500

Occurs in subsession.createSubsessions method because the subsession function is disabled in the account.

SUBSESSION_BROADCAST_DISABLE = 7506

Occurs in subsession.broadcast because broadcast message function is disabled in the account.

SUBSESSION_BROADCAST_INVALID_CONTENT = 7507

Occurs in subsession.broadcast because the message is empty or an invalid string.

SUBSESSION_BROADCAST_VOICE_DISABLE = 7508

Occurs in subsession.startBroadcastVoice because broadcast voice is disabled in the account.

SUBSESSION_BROADCAST_VOICE_MISMATCH_STATE = 7510

Occurs in subsession.startBroadcastVoice because the host cannot broadcast voice without an active audio connection during the session.

SUBSESSION_BROADCAST_VOICE_RESTRICTED = 7509

Occurs in subsession.startBroadcastVoice because the host cannot broadcast voice with in a subsession.

SUBSESSION_EXCEED_CAPACITY = 7501

Occurs in subsession.createSubsessions method because the number of created subsessions has exceeded the maximum limit(100).

SUBSESSION_EXIT_RESTRICTED = 7505

Occurs in subsession.leaveSubsession because the host restricts users from leaving the subsession.

SUBSESSION_MISMATCH_ID = 7502

Occurs in subsession.openSubsessions or subsession.joinSubsession or subsession.assignUserToSubsession or subsession.moveUserToSubsession methods because the subsession ID is incorrect.

SUBSESSION_MISMATCH_STATE = 7504

Occurs in subsession.openSubsessions or other methods because the subsession status is not correct.

SUBSESSION_MISMATCH_USER = 7503

Occurs in subsession.openSubsessions or subsession.moveBackToMainSession or subsession.assignUserToSubsession or subsession.moveUserToSubsession methods because the user ID is incorrect.

Transcription Enumeration members

TRANSCRIPTION_ACCOUNT_DISABLE = 7300

Occurs in liveTranscription.startLiveTranscription method because the feature is disabled in the account.

TRANSCRIPTION_FEATURE_DISABLE = 7301

Occurs in liveTranscription.startLiveTranscription method because the feature is disabled by the session host.

TRANSCRIPTION_LANGUAGE_UNSUPPORTED = 7302

Occurs in liveTranscription.setSpeakingLanguage method because the language is not supported.

TRANSCRIPTION_MISMATCH_STATE = 7303

Occurs in liveTranscription.setSpeakingLanguage or liveTranscription.setTranslationLanguage methods because the transcription has not been supported.

TRANSLATION_ACCOUNT_DISABLE = 7304

Occurs in liveTranscription.setTranslationLanguage method because the feature is disabled in the account.

TRANSLATION_LANGUAGE_UNSUPPORTED = 7305

Occurs in liveTranscription.setTranslationLanguage method because the translation language is not supported.

Video Enumeration members

VIDEO_CAMERA_PERMISSION_DENIED = 6100

Occurs in stream.startVideo method due to the user denied camera permission.

VIDEO_CAMERA_TAKEN = 6103

Occurs in stream.startVideo method due to the camera is taken by another program.

VIDEO_CAPTURE_LOADING = 6105

Occurs in stream.startVideo or stream.stopVideo method due to the video capture is in loading.

VIDEO_ESTABLISH_STREAM_ERROR = 6110

Occurs in stream.startVideo method due to the video stream establish error.

VIDEO_MASK_IMAGE_INACCESSIBLE = 6115

Occurs in stream.previewMask due to the mask image is inaccessible.

VIDEO_MASK_PROCESSOR_CONFLICT = 6116

Occurs in stream.previewMask method due to the virtual processor is in progress.

VIDEO_METHOD_DEPRECATED = 6112

Occurs in stream.renderVideo method due to the method is not applicable for WebRTC video.

VIDEO_MISMATCH_CAMERA = 6102

Occurs in stream.startVideo method due to the camera does not match the device list.

VIDEO_MISMATCH_STATE = 6109

Occurs in stream.startVideo or stream.stopVideo method due to the video state is not matched.

VIDEO_NO_CAMERA = 6101

Occurs in stream.startVideo method due to no camera.

VIDEO_RENDER_LIMIT_EXCEED = 6111

Occurs in stream.renderVideo or stream.attachVideo method due to number of rendered video exceed the limit.

VIDEO_SPOTLIGHT_MISMATCH_STATE = 6117

Occurs in stream.spotlightVideo method due to video not been started or been spotlighted.

VIDEO_SPOTLIGHT_MULTI_CONFLICT = 6118

Occurs in stream.removeSpotlightedVideo method due to multiple spotlighted videos cannot be removed.

VIDEO_VB_IMAGE_INACCESSIBLE = 6113

Occurs in stream.previewVirtualBackgroundmethod due to the virtual background image is inaccessible.

VIDEO_VB_INITIALIZE_ERROR = 6104

Occurs in stream.startVideo method due to the virtual background initialization error.

VIDEO_VB_MISMATCH_STATE = 6114

Occurs in stream.previewVirtualBackground method due to the virtual background state is not matched.

VIDEO_VB_PROCESSOR_CONFLICT = 6108

Occurs in stream.startVideo method due to the virtual processor is in progress.

VIDEO_VB_UNSUPPORTED = 6107

Occurs in stream.startVideo method due to the virtual background is not supported on the platform.

Video processor Enumeration members

VIDEO_PROCESSOR_DUPLICATE_CREATE = 6121

Occurs in stream.createProcessor method due to a duplicate video processor creation.

VIDEO_PROCESSOR_LIMIT_EXCEED = 6120

Occurs in stream.addProcessor method due to adding more than 1 video processor at the same time.

VIDEO_PROCESSOR_MISMATCH_PROCESSOR = 6122

Occurs in stream.addProcessor method because unable to find the target processor.

VIDEO_PROCESSOR_UNSUPPORTED = 6119

Occurs in stream.createProcessor method due to video processor being unsupported on the platform.