Package io.rong.imlib

Enum RongIMClient.ErrorCode

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Field Summary

      Fields 
      Modifier and Type Field Description
      public int code
      public String msg
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      APP_NOT_CONNECT

      The application did not call the connect() method before invoking business operations.

      Call this method after the connection is successfully established.

      PARAMETER_ERROR

      Parameter exception.

      Please verify that the parameters are correctly and validly filled.

      IPC_DISCONNECT

      IPC process terminated unexpectedly.

      This issue may be triggered when the system reclaims resources and then invokes the interface. The SDK will handle automatic reconnection.

      This error can also occur if libRongIMLib.so or libsqlite.so is missing or crashes.

      UNKNOWN

      Unknown error.

      CONNECTED

      Connection established.

      MSG_SEND_OVERFREQUENCY

      *Source Message sending frequency is too high. Only 5 messages are allowed per second.

      RC_OPERATION_BLOCKED

      Operation is prohibited.

      This error code has been deprecated.

      RC_OPERATION_NOT_SUPPORT

      Operation not supported.

      Only available for Dedicated Cloud. The operation has been disabled on the server.

      RC_REQUEST_OVERFREQUENCY

      The request has exceeded the rate limit. Please try again later.

      The API is being called too frequently. Please try again later.

      MSG_ROAMING_SERVICE_UNAVAILABLE

      Cloud storage for historical messages is not enabled.

      You can enable this service in the RCdeveloper console.

      RC_CHATROOM_RESET

      Chatroom has been reset

      NOT_IN_DISCUSSION

      Not in this discussion group.

      RC_MSG_BLOCKED_SENSITIVE_WORD

      The sent message contains sensitive words (the sender fails to send, and the receiver will not receive the message).

      RC_MSG_REPLACED_SENSITIVE_WORD

      The sensitive words in the message have been replaced (the recipient will receive the message after replacement).

      NOT_IN_GROUP

      Not in this group.

      FORBIDDEN_IN_GROUP

      Has been muted in the group.

      NOT_IN_CHATROOM

      Not in this chatroom.

      FORBIDDEN_IN_CHATROOM

      In this chatroom, the user has been muted

      KICKED_FROM_CHATROOM

      Indicates that the user has been kicked out and banned from joining the chatroom.

      The duration of the ban depends on the time parameter passed when the server calls the kick-out API.

      RC_CHATROOM_NOT_EXIST

      The chatroom does not exist

      RC_CHATROOM_IS_FULL

      Chatroom member limit exceeded. By default, there is no limit on the number of chatroom members, but developers can submit a ticket to request a member limit for the App Key. When the member limit is set, this error code will be returned if the number of members exceeds the limit when calling the join chatroom API.

      RC_CHATROOM_ILLEGAL_ARGUMENT

      The chatroom interface parameters are invalid.

      Please ensure that the parameters are not empty or valid.

      RC_SETTING_SYNC_FAILED

      An issue occurred while synchronizing the operation with the server, possibly due to excessive frequency of operations. If this error occurs, please retry after a delay of 0.5 seconds.

      RC_APP_PUBLICSERVICE_DEFFOLLOWED

      The official account is defaulted to be followed. Regarding the conversation type: ConversationType_APP_PUBLIC_SERVICE.

      RC_APP_PUBLICSERVICE_FOLLOWED

      Official Account is followed, for conversation type:ConversationType_APP_PUBLIC_SERVICE

      RC_APP_PUBLICSERVICE_DEFUNFOLLOWED

      Official Account is unfollowed by default. For conversation type: ConversationType_APP_PUBLIC_SERVICE.

      RC_APP_PUBLICSERVICE_UNFOLLOWED

      The official account has been unfollowed. Regarding the conversation type: ConversationType_APP_PUBLIC_SERVICE.

      RC_APP_PUBLICSERVICE_UNFOLLOW

      Not following this Official Account, for conversation type: ConversationType_APP_PUBLIC_SERVICE

      RC_PUBLICSERVICE_ERROR_TYPE

      Invalid Official Account. (The official account session identified by the conversation type and ID is invalid.)

      For conversation type: ConversationType_PUBLIC_SERVICE

      RC_PUBLICSERVICE_DEFFOLLOWED

      The official account is defaulted to be followed. For the conversation type: ConversationType_PUBLIC_SERVICE.

      RC_PUBLICSERVICE_FOLLOWED

      The official account has been followed. Regarding the conversation type: ConversationType_PUBLIC_SERVICE.

      RC_PUBLICSERVICE_DEFUNFOLLOWED

      The official account is defaulted to be unfollowed. For the conversation type: ConversationType_PUBLIC_SERVICE.

      RC_PUBLICSERVICE_UNFOLLOWED

      The official account has been unfollowed. Regarding the conversation type: ConversationType_PUBLIC_SERVICE.

      RC_PUBLICSERVICE_UNFOLLOW

      The official account is not followed. Regarding the conversation type: ConversationType_PUBLIC_SERVICE.

      REJECTED_BY_BLACKLIST

      The message failed to send because you have been added to the recipient's blocklist.

      NOT_IN_WHITELIST

      Not in the recipient's allowlist, message sending failed.

      RC_NET_CHANNEL_INVALID

      The connection has been released.

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_NET_UNAVAILABLE

      Connection Unavailable

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_MSG_RESP_TIMEOUT

      The client sends a message request, and the RCserver responds with a timeout.

      RC_HTTP_SEND_FAIL

      Navigation HTTP request failed

      If this error occurs occasionally, the SDK will automatically reconnect. No developer intervention is required.

      RC_HTTP_REQ_TIMEOUT

      Failed to request connection to the navigation address.

      The SDK will handle automatic reconnection, so developers do not need to intervene. If this issue persists in a private cloud environment, please verify that the navigation address is correct.

      RC_HTTP_RECV_FAIL

      Failed to receive data after requesting connection to the navigation address.

      The SDK will handle automatic reconnection, and developers do not need to intervene. If this issue persists in a private cloud environment, please verify that the navigation address is correct.

      RC_NAVI_RESOURCE_ERROR

      Navigation HTTP request failed

      For connection-related error codes, the SDK will automatically handle reconnection, and developers do not need to handle it.

      RC_NODE_NOT_FOUND

      Navigation HTTP response data format error

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to handle it.

      RC_DOMAIN_NOT_RESOLVE

      After parsing the navigation data, no valid IP address was found.

      If this issue occurs in a private cloud environment, please verify whether the navigation data is functioning correctly.

      RC_SOCKET_NOT_CREATED

      Failed to create Socket connection

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_SOCKET_DISCONNECTED

      Socket disconnected

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to handle it.

      RC_PING_SEND_FAIL

      PING Failed

      Connection-related error codes. The SDK will handle automatic reconnection, and developers do not need to handle it.

      RC_PONG_RECV_FAIL

      PING Timeout

      Connection-related error codes. The SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_MSG_SEND_FAIL

      Signaling failed to send

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to handle it.

      RC_CONN_OVERFREQUENCY

      Connection too frequent

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_MSG_SIZE_OUT_OF_LIMIT

      The message size exceeds the limit. The message body (content serialized into JSON format) has a maximum size of 128k bytes.

      RC_NETWORK_IS_DOWN_OR_UNREACHABLE

      Network connection is unavailable.

      The SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_CONN_ACK_TIMEOUT

      Connection ACK timeout

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to handle it.

      RC_CONN_PROTO_VERSION_ERROR

      Incorrect Signaling Version

      Error codes related to connection issues. The SDK will handle automatic reconnection, and developers do not need to handle it manually.

      RC_CONN_ID_REJECT

      Invalid App Key

      Please verify that the App Key you are using is correct.

      RC_CONN_SERVER_UNAVAILABLE

      The server is currently unavailable (reserved)

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to intervene.

      RC_CONN_USER_OR_PASSWD_ERROR

      Token is invalid

      The token is incorrect. Please verify that the App Key used for client initialization matches the App Key used to obtain the token from your server.

      RC_CONN_NOT_AUTHRORIZED

      App verification failed

      App verification failed because you enabled the app verification feature, but the verification did not pass.

      RC_CONN_REDIRECTED

      Connection Redirection

      For connection-related error codes, the SDK will handle automatic reconnection, and developers do not need to manage it.

      RC_CONN_PACKAGE_NAME_INVALID

      does not match the registered information in the backend.

      RC_CONN_APP_BLOCKED_OR_DELETED

      App Key is banned or deleted

      Please check if the App Key you are using is banned or deleted.

      RC_CONN_USER_BLOCKED

      User is banned

      Please verify that the Token you are using is correct and that the corresponding UserId is not banned. Added in version 5.2.3: In versions prior to 5.2.3, this error may also occur if the user account has been deactivated.

      RC_DISCONN_KICK

      User Kicked Offline

      The current user logged in on another device, and this device was kicked offline.

      RC_DISCONN_USER_BLOCKED

      The connection to the server has been disconnected; the user is banned.

      RC_CONN_TOKEN_EXPIRE

      Token Expired

      This occurs because you have set a token expiration time in the developer console. You need to request a new token from your server and establish a connection again using the new token.

      RC_CONN_OTHER_DEVICE_LOGIN

      User logged in on another device

      During reconnection, the current user logged in on another device

      CONCURRENT_LIMIT_ERROR

      The number of simultaneously online users exceeds the set limit

      RC_CONN_CLUSTER_ERROR

      Environment verification failed

      Please check if the App Key and connection environment (development environment/production environment) match

      RC_CONN_APP_AUTH_FAILED

      .connectExt

      RC_CONN_DISPOSABLE_TOKEN_USED

      The token has already been used and cannot be used for connection. A one-time token can only be used once; subsequent attempts will result in this error.

      RC_CONN_USER_ABANDON

      User has been deactivated

      RC_QUERY_ACK_NO_DATA

      Internal protocol layer error.

      Data error during query, upload, or download process.

      This error code has been deprecated.

      RC_MSG_DATA_INCOMPLETE

      Internal protocol layer error.

      This error code has been deprecated.

      RC_CONN_REFUSED

      Connection Refused

      For connection-related error codes, the SDK will automatically handle reconnection, and developers do not need to intervene.

      RC_CONNECTION_RESET_BY_PEER

      The connection was interrupted by the server, possibly because the operator deemed the link illegal or invalid and disconnected it directly. After this error code occurs, the SDK will automatically trigger a reconnection, and no action is required from the app side.

      BIZ_ERROR_CLIENT_NOT_INIT

      SDK is not initialized

      You must initialize the SDK before using any of its features.

      BIZ_ERROR_DATABASE_ERROR

      Database error.

      When connecting to RongCloud, the SDK will open the database. If you call a business interface without connecting to RongCloud, this error may occur because the database is not yet open.

      The database path includes the userId. If the userId passed when obtaining the token contains special characters, it may cause this error. The userId supports a combination of uppercase and lowercase English letters, numbers, and certain special symbols +, =, -, _. The maximum length is 64 bytes.

      BIZ_ERROR_NO_CHANNEL

      Channel is invalid.

      This error code has been deprecated.

      BIZ_ERROR_RECONNECT_SUCCESS

      Reconnection succeeded.

      This error code has been deprecated.

      BIZ_ERROR_CONNECTING

      Connection in progress, calling connect again will be rejected.

      This error code has been deprecated.

      RC_TAG_INVALID_FOR_CONVERSATION

      Conversation not in tag

      ROAMING_SERVICE_UNAVAILABLE_CHATROOM

      The chatroom cloud storage service is not enabled.

      EXCCED_MAX_KV_SIZE

      Exceeds the maximum number of state settings for a chatroom. By default, a chatroom can have up to 100 settings.

      TRY_OVERWRITE_INVALID_KEY

      Illegal overwrite of status value in chatroom

      Status already exists, no permission to overwrite

      EXCCED_MAX_CALL_API_SIZE

      Exceeds the frequency limit for setting chatroom status. A single chatroom can set and delete status up to 100 times per second.

      KV_STORE_NOT_AVAILABLE

      The chatroom status storage feature is not enabled. Please contact the business team to enable it.

      KEY_NOT_EXIST

      The chatroom status value does not exist

      KV_STORE_NOT_ALL_SUCCESS

      *Chatroom Batch Set or Delete KV Partially Unsuccessful**

      KV_STORE_OUT_OF_LIMIT

      Exceeding the limit for batch setting or deleting KV pairs in the chatroom (maximum 10 at a time)

      RC_CONNECTION_EXIST

      The connection already exists.

      KV_STORE_NOT_SYNC

      Chatroom status not synchronized

      Local data and server not synchronized

      RC_RECALL_PARAMETER_INVALID

      Invalid recall message parameters.

      Please verify that the recall message parameters are correctly filled in.

      RC_RECALL_MESSAGE_USER_INVALID

      IMLib can recall messages sent by oneself or others. The IM service has a switch to control whether only messages sent by oneself can be recalled. When this switch is enabled, attempting to recall messages sent by others will result in this error. @Since 5.2.4

      RC_PUSHSETTING_PARAMETER_INVALID

      Invalid remote push settings parameters.

      Please verify that the remote push parameters are correctly configured.

      RC_SIGHT_SERVICE_UNAVAILABLE

      Small video service is not enabled. Please contact our sales team to enable it.

      RC_SIGHT_MSG_DURATION_LIMIT_EXCEED

      The duration of the short video exceeds the limit

      The default maximum duration for a short video is 2 minutes

      RC_GIF_MSG_SIZE_LIMIT_EXCEED

      GIF message file size exceeds the limit

      The default maximum size for a GIF file is 2 MB

      RC_ENVIRONMENT_ERROR

      Incorrect connection environment (RCpublic cloud SDK cannot connect to a private cloud environment).

      Please verify the environment you need to connect to and use the correct SDK version.

      RC_CONNECT_TIMEOUT

      SDK internal connection timeout. This error occurs when calling the connect interface with an invalid timeLimit value.

      The SDK will not attempt to reconnect automatically. The application must manually call the connect interface to establish a connection.

      RC_PUBLIC_SERVICE_PROFILE_NOT_EXIST

      The requested public service information does not exist.

      Please verify that the type of public service and the public service ID match.

      RC_MESSAGE_CANT_EXPAND

      The message cannot be extended. Only one-to-one and group chats are supported. Other message types will return this error.

      When sending a message, the `canIncludeExpansion` property of the Message object must be set to true for extension to be allowed.

      RC_MESSAGE_EXPAND_FAIL

      Message extension failed.

      This is usually caused by network issues. Please ensure that your network is stable and the RCSDK is properly connected.

      RC_MSG_EXPANSION_SIZE_LIMIT_EXCEED

      The message extension size exceeds the limit. By default, the key length in the message extension dictionary should not exceed 32 characters, and the value length should not exceed 64 characters. The number of key-value pairs in the Expansion should not exceed 300.

      RC_FILE_UPLOAD_FAILED

      Media message media file HTTP upload failed

      RC_VIDEO_COMPRESS_FAILED

      Video compression failed

      RC_MESSAGE_NULL_EXCEPTION

      The message returned by the message processing interface is null

      RC_MEDIA_EXCEPTION

      Media file upload failed. The media file does not exist or its size is 0.

      RC_FILE_EXPIRED

      Files have expired or been cleared. Short video files are stored by default for 7 days, while other files are stored by default for 6 months. They will be automatically cleared upon expiration. If short video files need to be stored for a longer period, you can enable the Short Video Plus feature in the **Service Management -> Short Video -> Service Settings** section of the [RCDeveloper Console](https://developer.rongcloud.cn/advance/index). After enabling this feature, short video files will be stored by default for 6 months.

    • Method Summary

      Modifier and Type Method Description
      static RongIMClient.ErrorCode valueOf(int code) Sets the error code value.
      int getValue() Retrieves the error code value.
      String getMessage() Retrieves the error message.
      static Array<RongIMClient.ErrorCode> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static RongIMClient.ErrorCode valueOf(String name) Returns the enum constant of this type with the specified name.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • valueOf

         static RongIMClient.ErrorCode valueOf(int code)

        Sets the error code value.

        Parameters:
        code - The error code.
        Returns:

        The error code enumeration.

      • getValue

         int getValue()

        Retrieves the error code value.

        Returns:

        The error code value.

      • getMessage

         String getMessage()

        Retrieves the error message.

        Returns:

        The error message.

      • values

         static Array<RongIMClient.ErrorCode> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static RongIMClient.ErrorCode valueOf(String name)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

        Returns:

        the enum constant with the specified name