Error codes and troubleshooting
See the following sections for common error codes, descriptions, and troubleshooting suggestions, grouped by category.
Common errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
Errors_Success | 0 | Request is successful. | None. |
Errors_Wrong_Usage | 1 | Wrong usage of the interface. | Read the corresponding documentation to learn more about the interface. |
Errors_Internal_Error | 2 | Internal error. Usually appears when you do not have the complete package or mix up libraries from different versions. | Download the latest version of the SDK library. |
Errors_Uninitialize | 3 | The Zoom SDK has not been initialized. | Make sure you have initialized the SDK before you call any services. |
Errors_Memory_Error | 4 | Insufficient memory to create a service. | Free up some memory used by other applications and try again. If this error appears too often, contact Developer Support. |
Errors_Load_Module_Error | 5 | Unable to load module from the library. Usually appears when you do not have the complete SDK library or mix up the libraries from different versions. | Download the latest version of the SDK library. |
Errors_UnLoad_Module_Error | 6 | Unable to unload a module in the SDK library. | Double-check whether the module is stuck or it just needs more time to finish its work. |
Errors_Invalid_Parameter | 7 | Wrong usage of the parameters that pass to an interface. | Read the corresponding documentation to learn more about the interface. |
Errors_Unknown | 11 | Unknown error. Usually appears when rare errors occur. | Double-check the log file and see if there are any related error messages. If it appears too often, contact Developer Support. |
Authentication errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
Errors_Auth_Error | 1001 | Authentication error. | Contact Developer Support if you are getting this error. |
Errors_Auth_Empty_Key_or_Secret | 1002 | SDK key or secret is empty. | Pass the SDK key and secret. |
Errors_Auth_Wrong_Key_or_Secret | 1003 | SDK key or secret is invalid. | Pass a valid SDK key and secret. |
Errors_Auth_DoesNot_Support_SDK | 1004 | Your account does not support the SDK. | Check your Zoom account settings or contact Developer Support to enable it. |
Errors_Auth_Disable_SDK | 1005 | Your account has disabled the SDK feature. | Check your Zoom account settings or contact Developer Support to enable it. |
Session errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
Errors_Session_Module_Not_Found | 2001 | Unable to find the module for the Session service. Usually appears when you do not have the complete SDK library or mix up the libraries from different versions. | Download the latest version of the SDK library. |
Errors_SessionService_Invaild | 2002 | The Session service is invalid. | Make sure the SDK has been initialized correctly. |
Errors_Session_Join_Failed | 2003 | Unable to join the Session. | Double-check the information passed to join the Session. |
Errors_Session_No_Rights | 2004 | You do not have the permission to perform the operation on this Session. | Make sure you have the correct permission. |
Errors_Session_Already_In_Progress | 2005 | The request you are trying to perform (join session) is already in progress. | Do not send this request too frequently or try again. |
Errors_Session_Dont_Support_SessionType | 2006 | The Session type is not supported on the current system. | Contact Developer Support for help. |
Errors_Session_Reconncting | 2007 | Trying to reconnect to the Session. | Double-check your network connection. |
Errors_Session_Disconnect | 2008 | Disconnecting from the session. | When disconnecting from the session, unsubscribe from video and clean up the resources. |
Errors_Session_Not_Started | 2009 | The Session that you are trying to start did not start successfully. | Try again. |
Errors_Session_Need_Password | 2010 | The Session you are trying to join needs a password. | Pass the password to join. |
Errors_Session_Password_Wrong | 2011 | The password entered is incorrect. | Provide the correct password. |
Errors_Session_Remote_DB_Error | 2012 | The remote database has some errors. | Try again later. If the problem persists, contact Developer Support. |
Errors_Session_Invalid_Param | 2013 | Received invalid parameters of join Session. | Double-check the parameters you passed to the method and try again. |
Media errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
Errors_Session_Audio_Error | 3000 | The SDK is having issues with audio. | Double-check your audio devices. |
Errors_Session_Audio_No_Microphone | 3001 | Could not find a microphone. | Check the microphone connection. |
Errors_Session_Video_Error | 4000 | The SDK is having issues with video. | Double-check your video devices. |
Errors_Session_Video_Device_Error | 4001 | The SDK is having issues with video devices. | Double-check your video devices. |
Errors_Session_Live_Stream_Error | 5000 | The SDK is unable to start live streaming. | Ensure the parameters and information passed for live streaming are correct. |
Raw data errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
RawDataError_MALLOC_FAILED | 6001 | Unable to allocate memory for raw data. | Free some memory and try again. |
RawDataError_NOT_IN_Session | 6002 | Unable to retrieve raw data because it is not in a Session. | Start or join a Session to start retrieving raw data. |
RawDataError_NO_LICENSE | 6003 | You do not have the correct license to use the raw data feature. | Contact Developer Support to purchase the correct license type. |
RawDataError_VIDEO_MODULE_NOT_READY | 6004 | The video module is not ready to retrieve raw data. | Initialize the video module, subscribe, and try again. |
RawDataError_VIDEO_MODULE_ERROR | 6005 | Unable to use the video module. | Download the latest version of the SDK library and import the video module properly. |
RawDataError_VIDEO_DEVICE_ERROR | 6006 | The video device has some errors. | Make sure your video device is connected and the SDK has the proper permission to access the device. |
RawDataError_NO_VIDEO_DATA | 6007 | Unable to retrieve video raw data. | Make sure the video module has been initialized. |
RawDataError_SHARE_MODULE_NOT_READY | 6008 | The share module is not ready to retrieve raw data. | Initialize the share module, subscribe, and try again. |
RawDataError_SHARE_MODULE_ERROR | 6009 | Unable to use the share module. | Download the latest version of the SDK library and import the share module properly. |
RawDataError_NO_SHARE_DATA | 6010 | Unable to retrieve share raw data. | Make sure your share module has imported properly and the configurations are set. |
RawDataError_AUDIO_MODULE_NOT_READY | 6011 | The audio module is not ready to retrieve raw data. | Initialize the audio module, subscribe, and try again. |
RawDataError_AUDIO_MODULE_ERROR | 6012 | Unable to use the audio module. | Try to download the latest version of the SDK library and import the audio module properly. |
RawDataError_NO_AUDIO_DATA | 6013 | Unable to retrieve audio raw data. | Make sure the audio module has been initialized. |
Errors_RAWDATA_PREPROCESS_RAWDATA_ERROR | 6014 | Internal error preprocessing raw data. | Contact Developer Support. |
RawDataError_NO_DEVICE_RUNNING | 6015 | No raw data device is running. | Ensure your device is connected and active. |
RawDataError_INIT_DEVICE | 6016 | Failed to initialize the raw data device. | Check that the device is available and try again. |
RawDataError_VIRTUAL_DEVICE | 6017 | Error occurred during use of a virtual audio device. | Make sure you have enabled virtual mic/speaker devices before calling these interfaces. |
RawDataError_CANNOT_CHANGE_VIRTUAL_DEVICE_IN_PREVIEW | 6018 | Attempted to change a virtual device during preview. | Retry the interface outside of preview. |
RawDataError_INTERNAL_ERROR | 6019 | Error occurred during use of a raw audio device. This typically occurs when a module failed or was not found. | Restart the application and check the project properties. |
RawDataError_SEND_TOO_MUCH_DATA_IN_SINGLE_TIME | 6020 | Too much raw data sent in a single call. | Reduce the amount of data sent per call. |
RawDataError_SEND_TOO_FREQUENTLY | 6021 | Raw data interfaces were called too frequently in a short amount of time. | Check that interfaces are not being called unnecessarily. |
RawDataError_VIRTUAL_MIC_IS_TERMINATE | 6022 | The virtual microphone was terminated. | Start the virtual mic again to continue using these interfaces. |
Share errors
| Name | Error Code | Description | Suggestion |
|---|---|---|---|
Errors_Session_Share_Error | 7001 | Internal error. | Contact Developer Support. |
Errors_Session_Share_Module_Not_Ready | 7002 | The share module was not initialized correctly. | Restart your application and check the project properties. |
Errors_Session_Share_You_Are_Not_Sharing | 7003 | enableShareDeviceAudio or enableOptimizeForSharedVideo was called when the user was not sharing. | Only call enableShareDeviceAudio or enableOptimizeForSharedVideo when sharing. |
Errors_Session_Share_Type_Is_Not_Support | 7004 | Used incorrect share type for the interface that was called. | Use the correct share type. |
Errors_Session_Share_Internal_Error | 7005 | Internal error. | Restart the application and check the project properties. |
Additional error codes
Find additional error codes in the ZoomVideoSDKErrors.Errors constant field values in the SDK reference.
To determine the error numbers, find the previous numbered error in the header definition, and count sequentially. For example, Errors_JoinSession_Token_MismatchedSessionName is error 1507.
Errors_JoinSession_NoSessionName = 1500,
Errors_JoinSession_NoSessionToken,
Errors_JoinSession_NoUserName,
Errors_JoinSession_Invalid_SessionName,
Errors_JoinSession_Invalid_Password,
Errors_JoinSession_Invalid_SessionToken,
Errors_JoinSession_SessionName_TooLong,
Errors_JoinSession_Token_MismatchedSessionName,
Some of the errors are no longer used, but they are not marked as deprecated.