Tencent Cloud

Error Codes

Last updated: 2024-03-26 10:55:04

This document applies to 5.x.x versions of the TRTC Web SDK.
TRTC SDK v5.0 defines 8 types of error codes, which can be obtained through the RtcError object to perform corresponding handling.
Error Code Definitions
Key
Code
Description
﻿INVALID_PARAMETER﻿
5000
The parameters passed in when calling the interface do not meet the API requirements.

Handling suggestion: Please check whether the passed-in parameters comply with the API specifications, such as whether the parameter type is correct.
﻿INVALID_OPERATION﻿
5100
The prerequisite requirements of the API are not met when calling the interface.

Handling suggestion: Please check whether the calling logic complies with the API prerequisite requirements according to the corresponding API document. 
﻿
For example: 
1. Switching roles before entering the room successfully.
2. The remote user and stream being played do not exist.
﻿ENV_NOT_SUPPORTED﻿
5200
The current environment does not support this function, indicating that the current browser does not support calling the corresponding API.

Handling suggestion: Usually, TRTC.isSupported can be used to perceive which capabilities the current browser supports. If the browser does not support it, you need to guide the user to use a browser that supports this capability. Reference: Detect Capabilities﻿
﻿DEVICE_ERROR﻿
5300
Description: Exception occurred when obtaining device or collecting audio and video

The following interfaces will throw this error code when an exception occurs: startLocalVideo, updateLocalVideo, startLocalAudio, updateLocalAudio, startScreenShare, updateScreenShare
﻿
Suggestion: Guide the user to check whether the device has a camera and microphone, whether the system has authorized the browser, and whether the browser has authorized the page. It is recommended to increase the device detection process before entering the room to confirm whether the microphone and camera exist and can be captured normally before proceeding to the next call operation. Usually, this exception can be avoided after the device check.

Implementation reference: Detect Capabilities

If you need to distinguish more detailed exception categories, you can process according to the extraCode﻿
﻿SERVER_ERROR﻿
5400
This error code is thrown when abnormal data is returned from the server.

The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole

Handling suggestion: Server exceptions are usually handled during development. 
﻿
Common exceptions include: expired userSig, Tencent Cloud account arrears, TRTC service not enabled, etc. The server returns abnormal data for the following reasons.
﻿OPERATION_FAILED﻿
5500
The exception that the SDK cannot solve after multiple retries under the condition of meeting the API call requirements, usually caused by browser or network problems.

The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole

Handling suggestions:
Confirm whether the domain name and port required for communication meet your network environment requirements, refer to the document Dealing with Firewall Restrictions and Setting Proxies﻿
Other issues need to be handled by engineers. Contact us on telegram﻿
﻿OPERATION_ABORT﻿
5998
The error code thrown when the API execution is aborted. 
﻿
When the API is called or repeatedly called without meeting the API lifecycle, the API will abort execution to avoid meaningless operations.

For example: Call enterRoom, startLocalVideo continuously, and call exitRoom without entering the room.

The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole

Handling suggestions: Capture and identify this error code, then avoid unnecessary calls in business logic, or you can do nothing, because the SDK has done side-effect-free processing, you only need to identify and ignore this error code when catching it.
﻿UNKNOWN_ERROR﻿
5999
Description: Unknown error or undefined error
Handling suggestions: Contact us on telegram﻿
﻿

tencent cloud

Recent Pages

Error Codes

Error Code Definitions

Was this page helpful?

Was this page helpful?

Key	Code	Description
INVALID_PARAMETER	5000	The parameters passed in when calling the interface do not meet the API requirements. Handling suggestion: Please check whether the passed-in parameters comply with the API specifications, such as whether the parameter type is correct.
INVALID_OPERATION	5100	The prerequisite requirements of the API are not met when calling the interface. Handling suggestion: Please check whether the calling logic complies with the API prerequisite requirements according to the corresponding API document. For example: 1. Switching roles before entering the room successfully. 2. The remote user and stream being played do not exist.
ENV_NOT_SUPPORTED	5200	The current environment does not support this function, indicating that the current browser does not support calling the corresponding API. Handling suggestion: Usually, TRTC.isSupported can be used to perceive which capabilities the current browser supports. If the browser does not support it, you need to guide the user to use a browser that supports this capability. Reference: Detect Capabilities
DEVICE_ERROR	5300	Description: Exception occurred when obtaining device or collecting audio and video The following interfaces will throw this error code when an exception occurs: startLocalVideo, updateLocalVideo, startLocalAudio, updateLocalAudio, startScreenShare, updateScreenShare Suggestion: Guide the user to check whether the device has a camera and microphone, whether the system has authorized the browser, and whether the browser has authorized the page. It is recommended to increase the device detection process before entering the room to confirm whether the microphone and camera exist and can be captured normally before proceeding to the next call operation. Usually, this exception can be avoided after the device check. Implementation reference: Detect Capabilities If you need to distinguish more detailed exception categories, you can process according to the extraCode
SERVER_ERROR	5400	This error code is thrown when abnormal data is returned from the server. The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole Handling suggestion: Server exceptions are usually handled during development. Common exceptions include: expired userSig, Tencent Cloud account arrears, TRTC service not enabled, etc. The server returns abnormal data for the following reasons.
OPERATION_FAILED	5500	The exception that the SDK cannot solve after multiple retries under the condition of meeting the API call requirements, usually caused by browser or network problems. The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole Handling suggestions: Confirm whether the domain name and port required for communication meet your network environment requirements, refer to the document Dealing with Firewall Restrictions and Setting Proxies Other issues need to be handled by engineers. Contact us on telegram
OPERATION_ABORT	5998	The error code thrown when the API execution is aborted. When the API is called or repeatedly called without meeting the API lifecycle, the API will abort execution to avoid meaningless operations. For example: Call enterRoom, startLocalVideo continuously, and call exitRoom without entering the room. The following interfaces will throw this error code when an exception occurs: enterRoom, startLocalVideo, startLocalAudio, startScreenShare, startRemoteVideo, switchRole Handling suggestions: Capture and identify this error code, then avoid unnecessary calls in business logic, or you can do nothing, because the SDK has done side-effect-free processing, you only need to identify and ignore this error code when catching it.
UNKNOWN_ERROR	5999	Description: Unknown error or undefined error Handling suggestions: Contact us on telegram

tencent cloud

Sign Up

Log in

Recent Pages

Error Codes

Error Code Definitions

Was this page helpful?

Was this page helpful?