This page introduces the error codes and error messages that might be returned by the SDK when you call the Agora RDC APIs.
Possible reasons for the errors are given to assist you in debugging. If you receive a response that is not included here, Agora recommends you contact support@agora.io so that our technical support team can help resolve the issue.
The error codes and error messages might be returned in the following ways:
EVT_ERROR
callback.The error code reported through the EVT_ERROR
callback.
code | message | Description |
---|---|---|
8001 |
Admin required | The current operation requires computer administrator privileges. Obtain the privileges before retrying the operation. |
8002 |
Invalid view size | If the view area of the host side is not set or the shared screen of the host side is not specified, call the updateViewPort or updateView method first. |
Error codes related to initializing the Agora RDC service.
code | message | Description |
---|---|---|
0 |
INIT ERR OK | Initializes the Agora RDC service. |
1 |
INIT ERR FAILURE | A common failure occurs during initialization. |
2 |
INIT ERR ALREADY INITIALIZED | The Agora RDC service has been already initialized and cannot be initialized again. |
3 |
INIT ERR INVALID APP ID | 3: The App ID is invalid. Reinitialize with a valid App ID. Agora recommends that you check that the format of the App ID is valid. |
4 |
INIT ERR INVALID ARGUMENT | The event handler is empty. |
Error codes and error messages related to logging in to the Agora RDC System.
code | message | Description |
---|---|---|
0 |
LOGIN ERR OK | The method call succeeds, or login succeeds. |
1 |
LOGIN ERR UNKNOWN | Login fails. The reason is unknown. |
2 |
LOGIN ERR REJECTED | Login is rejected by the server. |
3 |
LOGIN ERR INVALID ARGUMENT | Invalid login argument. |
4 |
LOGIN ERR NVALID APP ID | The App ID is invalid. |
5 |
LOGIN ERR INVALID TOKEN | The token is invalid. |
6 |
LOGIN ERR TOKEN EXPIRED | The token has expired, and therefore the login is rejected. |
7 |
LOGIN ERR NOT AUTHORIZED | Unauthorized login. |
8 |
LOGIN ERR ALREADY LOGIN | The user is logged in or is logging in to the Agora RDC system, or the logout method is not called to log out. |
9 |
LOGIN ERR TIMEOUT | The login times out. The current timeout threshold is set as 12 seconds. You need to log in again. |
10 |
LOGIN ERR TOO OFTEN | Login too frequently. The method call frequency exceeds the default limit of two queries per second. |
101 |
LOGIN ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
Error codes and error messages related to logging out of the Agora RDC System.
code | message | Description |
---|---|---|
0 |
LOGOUT ERR OK | Logout succeeded. No error occurs. |
1 |
LOGOUT ERR REJECTED | Reserved for future use. |
101 |
LOGOUT ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
102 |
LOGOUT ERR USER NOT LOGGED IN | The login method was not called before logging out of the Agora RDC system, or the login method call was unsuccessful. |
Error codes and error messages related to users joining a channel.
code | message | Description |
---|---|---|
0 |
JOIN_CHANNEL_ERR_OK | The method call succeeds, or the user joins the channel successfully. |
1 |
JOIN_CHANNEL_ERR_FAILURE | Common failure. The user fails to join the channel. |
3 |
JOIN_CHANNEL_ERR_INVALID_ARGUMENT | The user fails to join the channel. The user fails to join the channel because the argument is invalid. |
4 |
JOIN_CHANNEL_TIMEOUT | A timeout occurs when joining the channel. The current timeout is set as five seconds. Possible cause: The user is disconnected from the RDC system. |
5 |
JOIN_CHANNEL_ERR_EXCEED_LIMIT | The number of the channels you are in exceeds the default limit of 20. |
6 |
JOIN_CHANNEL_ERR_ALREADY_JOINED | The user is joining or has joined the channel. |
7 |
JOIN_CHANNEL_ERR_TOO_OFTEN | The method call frequency exceeds the default limit of 50 queries every three seconds. |
8 |
JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN | The frequency of joining the same channel exceeds the default limit of two times every five seconds. |
101 |
JOIN_CHANNEL_ERR_NOT_INITIALIZED | The Agora RDC service is not initialized. |
102 |
JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN | The user does not call the login method, or the method call of login does not succeed before joining the channel. |
Error codes and error messages related to leaving the channel.
code | message | Description |
---|---|---|
0 |
LEAVE CHANNEL ERR OK | The method call succeeds, or the user leaves the channel successfully. |
1 |
LEAVE CHANNEL ERR FAILURE | Common failure. The user fails to leave the channel. |
2 |
LEAVE CHANNEL ERR REJECTED | Reserved for future use. |
3 |
LEAVE CHANNEL ERR NOT IN CHANNEL | The user is not in the channel. |
101 |
LEAVE CHANNEL ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
102 |
LEAVE CHANNEL ERR USER NOT LOGGED IN | The user did not call the login method before calling the leaveChannel method, or the login method call was unsuccessful. |
Error codes and error messages related to peer-to-peer messages.
code | message | Description |
---|---|---|
1 |
PEER MESSAGE ERR FAILURE | The sender fails to send the peer-to-peer message. |
2 |
PEER MESSAGE ERR SENT TIMEOUT | Sending a peer-to-peer message timed out. A timeout occurs when sending the peer-to-peer message. Possible cause: The user is disconnected from the RDC system. |
3 |
PEER MESSAGE ERR PEER UNREACHABLE | The peer user is not online (the user does not exist or is disconnected from the RDC system), and the peer-to-peer message sent is not received by the peer user. |
5 |
PEER MESSAGE ERR TOO OFTEN | Sending a message (including both peer-to-peer and channel message) exceeds the default limit of 180 per 3 seconds. |
6 |
PEER MESSAGE ERR INVALID USERID | The user ID is invalid. |
7 |
PEER MESSAGE ERR INVALID MESSAGE | The message is null or exceeds 32 KB in length. |
101 |
PEER MESSAGE ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
102 |
PEER MESSAGE ERR USER NOT LOGGED IN | The user does not call the login method, or the method call of login does not succeed before sending a peer-to-peer message. |
Error codes and error messages related to file uploads.
code | message | Description |
---|---|---|
0 |
UPLOAD MEDIA ERR OK | The method call succeeds, or the operation succeeds. |
1 |
UPLOAD MEDIA ERR FAILURE | An unknown error occurs. Check whether the file exists and whether you can access the file. |
2 |
UPLOAD MEDIA ERR INVALID ARGUMENT | Internal parameter error. Contact support@agora.io for help. |
3 |
UPLOAD MEDIA ERR TIMEOUT | A timeout occurs. The current timeout is set as 120 seconds. The SDK assumes that a timeout occurs if it has not detected any file transmission between the SDK and the file server for 120 seconds. |
4 |
UPLOAD MEDIA ERR SIZE OVERFLOW | The size of the file or image to upload exceeds 30 MB. |
5 |
UPLOAD MEDIA ERR CONCURRENCY LIMIT EXCEEDED | You have exceeded the limit of file loading tasks. You can initiate a maximum of nine file upload or download tasks at the same time (upload and download tasks count together). |
6 |
UPLOAD MEDIA ERR INTERRUPTED | The file upload task aborted due to the following reasons: The uploader is disconnected from the RDC system. The user has cancelled the upload task. |
101 |
UPLOAD MEDIA ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
102 |
UPLOAD MEDIA ERR NOT LOGGED IN | The user does not call the login method, or the method call of login does not succeed before this operation. |
Error codes and error messages related to file downloads.
code | message | Description |
---|---|---|
0 |
DOWNLOAD MEDIA ERR OK | The method call succeeds, or the operation succeeds. |
1 |
DOWNLOAD MEDIA ERR FAILURE | An unknown error occurs. Check whether you have write access. |
2 |
DOWNLOAD MEDIA ERR INVALID ARGUMENT | Internal parameter error. Contact support@agora.io for help. |
3 |
DOWNLOAD MEDIA ERR TIMEOUT | A timeout occurs. The current timeout is set as 120 seconds. The SDK assumes that a timeout occurs if it has not detected any file transmission between the SDK and the file server for 120 seconds. |
4 |
DOWNLOAD MEDIA ERR NOT EXIST | The file to be downloaded does not exist. This might be an internal parameter error. Contact support@agora.io for help. |
5 |
DOWNLOAD MEDIA ERR CONCURRENCY LIMIT EXCEEDED | You have exceeded the limit for file loading tasks. You can initiate a maximum of nine file download or upload tasks at the same time (download and upload tasks count together). |
6 |
DOWNLOAD MEDIA ERR INTERRUPTED | The file download task aborted halfway due to the following reasons: The downloader is disconnected from the RDC system. The user has cancelled the download task. |
101 |
DOWNLOAD MEDIA ERR NOT INITIALIZED | The Agora RDC service is not initialized. |
102 |
DOWNLOAD MEDIA ERR NOT LOGGED IN | The user does not call the login method, or the method call of login does not succeed before this operation. |
Error codes and error messages related to file transfers.
code | Description |
---|---|
1 |
Pass a null value into the content field. |
2 |
Clipboard content is empty. |
3 |
Incorrect input file path. |
4 |
Failed to upload file to server. |
5 |
Failed to create text message. |
6 |
The sender fails to send the text message. |