Class RCIMIWEngine

constructor

• new RCIMIWEngine(): RCIMIWEngine

  Returns RCIMIWEngine

Static_instance

Staticcreate

• create(appKey: string, options?: RCIMIWEngineOptions): RCIMIWEngine

  创建接口引擎@param context 上下文

  Parameters

  • appKey: string

    开发者后台获取的 AppKey
  • options: RCIMIWEngineOptions = {}

    引擎配置项

  Returns RCIMIWEngine

  引擎实例

destroy

• destroy(): Promise<number>

  销毁引擎 引擎销毁后如果当前未退出登录，SDK 会自动退出，且仍接受 push

  Returns Promise<number>

setDeviceToken

• setDeviceToken(deviceToken: string): Promise<number>

  Parameters

  • deviceToken: string

  Returns Promise<number>

registerNativeCustomMessage

• registerNativeCustomMessage(
      messageIdentifier: string,
      persistentFlag: RCIMIWNativeCustomMessagePersistentFlag,
  ): Promise<number>

  Register native custom message

  Parameters

  • messageIdentifier: string

    Unique identifier of the message
  • persistentFlag: RCIMIWNativeCustomMessagePersistentFlag

    Storage policy of the message

  Returns Promise<number>

  Status code of current operation. 0 means success, non-zero indicates failure. Refer to error codes for details

registerNativeCustomMediaMessage

• registerNativeCustomMediaMessage(
      messageIdentifier: string,
      persistentFlag: RCIMIWNativeCustomMessagePersistentFlag,
  ): Promise<number>

  Register native custom media message

  Parameters

  • messageIdentifier: string

    Unique identifier of the message
  • persistentFlag: RCIMIWNativeCustomMessagePersistentFlag

    Storage policy of the message

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, non-zero indicates failure. Refer to error codes for details

connect

• connect(
      token: string,
      timeout: number,
      callback?: RCIMIWConnectCallback,
  ): Promise<number>

  Connect to RC server. Call this once globally in your app. If a non-business error code is returned, the SDK will retry. If still unsuccessful, it will retry when the device’s network status changes.

  Parameters

  • token: string

    Token obtained from the server API
  • timeout: number

    Connection timeout in seconds. If timeLimit ≤ 0, IM will keep trying until success or failure (e.g., invalid token). If timeLimit > 0, IM will try for up to timeLimit seconds. If connected within timeLimit, the SDK will auto-reconnect on network changes or app state changes. If not connected within timeLimit, the listener will notify timeout, and you’ll need to call connect again.
  • Optionalcallback: RCIMIWConnectCallback

    Connection event callback. Supported since SDK 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success, and the result is handled in the callback. Non-zero means failure, and no callback will be triggered. Check error codes for details.

disconnect

• disconnect(receivePush: boolean): Promise<number>

  Disconnect link Note: The SDK automatically reconnects during app state changes or network issues to ensure reliability. Only call this method if your app logic requires logout.

  Parameters

  • receivePush: boolean

    Whether to receive push after disconnecting. true: receive remote push, false: stop receiving remote push

  Returns Promise<number>

  Status code of the operation. 0 indicates success, with results in the callback. Non-zero means the operation failed, and no callback will be triggered. Refer to error codes for details.

createTextMessage

• createTextMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      text: string,
  ): Promise<RCIMIWTextMessage>

  Build a text message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • text: string

    Text content

  Returns Promise<RCIMIWTextMessage>

  Text message entity

createImageMessage

• createImageMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWImageMessage>

  Build an image message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • path: string

    Local path of the image message, must be valid

  Returns Promise<RCIMIWImageMessage>

  Image message entity

createFileMessage

• createFileMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWFileMessage>

  Build a file message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups, pass null for other conversation types
  • path: string

    Local path of the file message, must be a valid path

  Returns Promise<RCIMIWFileMessage>

  File message entity

createSightMessage

• createSightMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
      duration: number,
  ): Promise<RCIMIWSightMessage>

  Build a short video message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • path: string

    Local path of the short video message. Must be valid.
  • duration: number

    Duration of the short video message

  Returns Promise<RCIMIWSightMessage>

  Video message entity

createVoiceMessage

• createVoiceMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
      duration: number,
  ): Promise<RCIMIWVoiceMessage>

  Build a voice message (HD voice)

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only supported for super groups. Pass null for other session types.
  • path: string

    Local path of the voice message, must be valid
  • duration: number

    Duration of the voice message

  Returns Promise<RCIMIWVoiceMessage>

  Voice message entity

createReferenceMessage

• createReferenceMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      referenceMessage: RCIMIWMessage,
      text: string,
  ): Promise<RCIMIWReferenceMessage>

  Build a reference message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for supergroups. Pass null for other conversation types.
  • referenceMessage: RCIMIWMessage

    Referenced message
  • text: string

    Referenced text content

  Returns Promise<RCIMIWReferenceMessage>

  Reference message entity

createGIFMessage

• createGIFMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      path: string,
  ): Promise<RCIMIWGIFMessage>

  Build a GIF message

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only for super groups, set to null for other session types
  • path: string

    Local path of the GIF message

  Returns Promise<RCIMIWGIFMessage>

  GIF message entity

createCustomMessage

• createCustomMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      policy: RCIMIWCustomMessagePolicy,
      messageIdentifier: string,
      fields: Map<string, string>,
  ): Promise<RCIMIWCustomMessage>

  Build custom message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for super groups, pass null for other types
  • policy: RCIMIWCustomMessagePolicy

    Message storage policy
  • messageIdentifier: string

    Unique message identifier
  • fields: Map<string, string>

    Key-value pairs for message content

  Returns Promise<RCIMIWCustomMessage>

  Custom message entity

createLocationMessage

• createLocationMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      longitude: number,
      latitude: number,
      poiName: string,
      thumbnailPath: string,
  ): Promise<RCIMIWLocationMessage>

  Build location message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups, pass null for other types
  • longitude: number

    Longitude
  • latitude: number

    Latitude
  • poiName: string

    POI info
  • thumbnailPath: string

    Local path to thumbnail, must be valid

  Returns Promise<RCIMIWLocationMessage>

  Location message entity

createNativeCustomMessage

• createNativeCustomMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messageIdentifier: string,
      fields: Map<string, Object>,
  ): Promise<RCIMIWNativeCustomMessage>

  Build native custom message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for super groups, pass null for other types
  • messageIdentifier: string

    Unique identifier of the message
  • fields: Map<string, Object>

    Key-value pairs of message content

  Returns Promise<RCIMIWNativeCustomMessage>

  Native custom message

createNativeCustomMediaMessage

• createNativeCustomMediaMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messageIdentifier: string,
      path: string,
      fields: Map<string, Object>,
  ): Promise<RCIMIWNativeCustomMediaMessage>

  Build native custom media message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for super groups, pass null for other types
  • messageIdentifier: string

    Unique message identifier
  • path: string

    Local path of the media file, must be valid
  • fields: Map<string, Object>

    Key-value pairs for message content

  Returns Promise<RCIMIWNativeCustomMediaMessage>

  Native custom media message

sendMessage

• sendMessage(
      message: RCIMIWMessage,
      callback?: RCIMIWSendMessageCallback,
  ): Promise<number>

  Send a regular message

  Parameters

  • message: RCIMIWMessage

    The message entity to send
  • Optionalcallback: RCIMIWSendMessageCallback

    Event callback for sending messages. SDK supports callback method from version 5.3.1. Other callback methods are deprecated since version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—specific results require implementing the interface callback. Non-zero indicates failure—no callback will be triggered. Refer to error codes for details

sendMediaMessage

• sendMediaMessage(
      message: RCIMIWMediaMessage,
      listener?: RCIMIWSendMediaMessageListener,
  ): Promise<number>

  Send media message

  Parameters

  • message: RCIMIWMediaMessage

    Media message entity to send
  • Optionallistener: RCIMIWSendMediaMessageListener

    Event listener for sending media message

  Returns Promise<number>

  Status code of current operation. 0 means success—results are in the callback. Non-zero means failure—no callback triggered. Check error codes for details

cancelSendingMediaMessage

• cancelSendingMediaMessage(
      message: RCIMIWMediaMessage,
      callback?: IRCIMIWCancelSendingMediaMessageCallback,
  ): Promise<number>

  Cancel sending a media message

  Parameters

  • message: RCIMIWMediaMessage

    Media message entity to cancel
  • Optionalcallback: IRCIMIWCancelSendingMediaMessageCallback

    Event callback for canceling the media message. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback is triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success, specific results require implementing the interface callback. Non-zero means the operation failed, no callback is triggered, and detailed errors refer to the error codes.

downloadMediaMessage

• downloadMediaMessage(
      message: RCIMIWMediaMessage,
      listener?: RCIMIWDownloadMediaMessageListener,
  ): Promise<number>

  Download media message

  Parameters

  • message: RCIMIWMediaMessage

    Media message entity to download
  • Optionallistener: RCIMIWDownloadMediaMessageListener

    Event listener for media message download

  Returns Promise<number>

  Status code of current operation. 0 means success, detailed results require interface callback. Non-zero means failure, no callback triggered, refer to error codes for details

cancelDownloadingMediaMessage

• cancelDownloadingMediaMessage(
      message: RCIMIWMediaMessage,
      callback?: IRCIMIWCancelDownloadingMediaMessageCallback,
  ): Promise<number>

  Cancel media message download

  Parameters

  • message: RCIMIWMediaMessage

    Media message entity to cancel download
  • Optionalcallback: IRCIMIWCancelDownloadingMediaMessageCallback

    Event callback for canceling media message download. SDK supports callback from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback is triggered.

  Returns Promise<number>

  Status code of current operation. 0 means success, with specific results in the callback. Non-zero means failure, and no callback is triggered. Check error codes for details.

getConversation

• getConversation(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetConversationCallback,
  ): Promise<number>

  Fetch a conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for super groups, pass null for other types
  • Optionalcallback: IRCIMIWGetConversationCallback

    Callback for conversation events. SDK supports callback from version 5.3.1. Other callback methods deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success, results via callback. Non-zero means failure, no callback triggered. Refer to error codes for details

getConversations

• getConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      startTime: number,
      count: number,
      callback?: IRCIMIWGetConversationsCallback,
  ): Promise<number>

  Fetch specific conversations

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Conversation types
  • channelId: string

    Channel ID, only for supergroups, pass null for other types
  • startTime: number

    Timestamp (ms), fetch conversations before this time, pass 0 for latest data
  • count: number

    Number of queries, 0 < count ≤ 50
  • Optionalcallback: IRCIMIWGetConversationsCallback

    Callback for conversation list events. SDK supports callback since 5.3.1. Other callback methods deprecated in 5.4.0, will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success, detailed results via callback. Non-zero means failure, no callback triggered, see error codes for details

getUnreadConversations

• getUnreadConversations(
      conversationTypes: RCIMIWConversationType[],
      callback?: IRCIMIWGetUnreadConversationsCallback,
  ): Promise<number>

  Get a list of conversations with unread messages by type

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Supports single chat, group chat, and system conversations
  • Optionalcallback: IRCIMIWGetUnreadConversationsCallback

    Callback for conversation list events

  Returns Promise<number>

  Status code of the current operation. 0 means success, results are returned via callback. Non-zero means failure, no callback triggered. See error codes for details

removeConversation

• removeConversation(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWRemoveConversationCallback,
  ): Promise<number>

  Remove a conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for supergroups, pass null for other types
  • Optionalcallback: IRCIMIWRemoveConversationCallback

    Callback for conversation removal. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success, non-zero means failure. Detailed errors refer to error codes

removeConversations

• removeConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      callback?: IRCIMIWRemoveConversationsCallback,
  ): Promise<number>

  Remove conversations by type

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Set of conversation types
  • channelId: string

    Channel ID, only supported for super groups. Pass null for other conversation types.
  • Optionalcallback: IRCIMIWRemoveConversationsCallback

    Callback for conversation removal events. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only callback is triggered.

  Returns Promise<number>

  Status code of the operation. 0 indicates success, specific results require implementing the callback. Non-zero indicates failure, no callback is triggered. Refer to error codes for details.

getUnreadCount

• getUnreadCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadCountCallback,
  ): Promise<number>

  Get unread message count for a session Note: Chat rooms not supported!

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only for super groups. Pass null for other session types.
  • Optionalcallback: IRCIMIWGetUnreadCountCallback

    Callback for unread count events. SDK supports callback since version 5.3.1. Other callback methods deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of current operation. 0 means success, result needs to be handled in callback. Non-zero means failure, no callback triggered. Refer to error codes for details.

getTotalUnreadCount

• getTotalUnreadCount(
      channelId: string,
      callback?: IRCIMIWGetTotalUnreadCountCallback,
  ): Promise<number>

  Get total unread count

  Parameters

  • channelId: string

    Channel ID, only supported for super groups. Pass null for other session types.
  • Optionalcallback: IRCIMIWGetTotalUnreadCountCallback

    Callback for unread count events. SDK supports callback from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for details. Non-zero means the call failed and no callback will be triggered. Refer to error codes for details.

getUnreadMentionedCount

• getUnreadMentionedCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadMentionedCountCallback,
  ): Promise<number>

  Get the count of unread @ messages in a session Note: Not supported in chat rooms

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other session types
  • Optionalcallback: IRCIMIWGetUnreadMentionedCountCallback

    Callback for unread @ message count. SDK supports callback since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for results. Non-zero means the call failed, and no callback will be triggered. Refer to error codes for details

getUltraGroupAllUnreadCount

• getUltraGroupAllUnreadCount(
      callback?: IRCIMIWGetUltraGroupAllUnreadCountCallback,
  ): Promise<number>

  Get the total count of unread messages from all supergroup chats the user has joined.

  Parameters

  • Optionalcallback: IRCIMIWGetUltraGroupAllUnreadCountCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated starting from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—implement the callback for results. Non-zero means the call failed—no callback will be triggered. Refer to error codes for details.

getUltraGroupAllUnreadMentionedCount

• getUltraGroupAllUnreadMentionedCount(
      callback?: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback,
  ): Promise<number>

  Get the total count of unread @ mentions across all super group chats the user has joined

  Parameters

  • Optionalcallback: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only this callback is triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback is triggered. Refer to error codes for details

getUltraGroupUnreadCount

• getUltraGroupUnreadCount(
      targetId: string,
      callback?: IRCIMIWGetUltraGroupUnreadCountCallback,
  ): Promise<number>

  Get unread message count for a specific conversation

  Parameters

  • targetId: string

    Conversation ID
  • Optionalcallback: IRCIMIWGetUltraGroupUnreadCountCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If a callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success, with results in the callback. Non-zero means failure, no callback triggered. Refer to error codes for details.

getUltraGroupUnreadMentionedCount

• getUltraGroupUnreadMentionedCount(
      targetId: string,
      callback?: IRCIMIWGetUltraGroupUnreadMentionedCountCallback,
  ): Promise<number>

  Get the count of @ mentions in a super group chat

  Parameters

  • targetId: string

    Chat ID
  • Optionalcallback: IRCIMIWGetUltraGroupUnreadMentionedCountCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. Refer to error codes for details.

getUnreadCountByConversationTypes

• getUnreadCountByConversationTypes(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      contain: boolean,
      callback?: IRCIMIWGetUnreadCountByConversationTypesCallback,
  ): Promise<number>

  Load unread count by conversation types Note: Chat rooms aren’t supported!

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Set of conversation types
  • channelId: string

    Channel ID, only for super groups. Pass null for other conversation types.
  • contain: boolean

    Include unread count from muted messages
  • Optionalcallback: IRCIMIWGetUnreadCountByConversationTypesCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for results. Non-zero means failure—no callback is triggered. Refer to error codes for details.

clearUnreadCount

• clearUnreadCount(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWClearUnreadCountCallback,
  ): Promise<number>

  Clear unread message count for a session Note: Not supported for chat rooms!

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only for super groups, pass null for other session types
  • timestamp: number

    Timestamp of the last read message, pass the latest timestamp to clear all
  • Optionalcallback: IRCIMIWClearUnreadCountCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the operation. 0 indicates success, non-zero means failure without triggering the callback. Refer to error codes for details

saveDraftMessage

• saveDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      draft: string,
      callback?: IRCIMIWSaveDraftMessageCallback,
  ): Promise<number>

  Save session draft info

  Parameters

  • type: RCIMIWConversationType

    Session type
  • targetId: string

    Session ID
  • channelId: string

    Channel ID, only supported for super groups. Pass null for other session types
  • draft: string

    Text content of the draft
  • Optionalcallback: IRCIMIWSaveDraftMessageCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated since version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, and the result needs to be handled in the callback. Non-zero indicates failure, and no callback will be triggered. Refer to error codes for details

getDraftMessage

• getDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetDraftMessageCallback,
  ): Promise<number>

  Fetch draft messages in a conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types
  • Optionalcallback: IRCIMIWGetDraftMessageCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success. For detailed results, implement the callback interface. Non-zero values indicate failure, and no callback will be triggered. Refer to error codes for details

clearDraftMessage

• clearDraftMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWClearDraftMessageCallback,
  ): Promise<number>

  Clear draft messages in a specific conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for supergroups, pass null for other conversation types
  • Optionalcallback: IRCIMIWClearDraftMessageCallback

    Event callback. SDK supports callback mode starting from version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, detailed results require implementing the callback. Non-zero indicates failure, no callback will be triggered, refer to error codes for details

getBlockedConversations

• getBlockedConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      callback?: IRCIMIWGetBlockedConversationsCallback,
  ): Promise<number>

  Get the list of muted conversations

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Conversation types
  • channelId: string

    Channel ID, only supported for supergroups. Pass null for other conversation types
  • Optionalcallback: IRCIMIWGetBlockedConversationsCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for results. Non-zero means failure—no callback will be triggered. Refer to error codes for details

changeConversationTopStatus

• changeConversationTopStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      top: boolean,
      callback?: IRCIMIWChangeConversationTopStatusCallback,
  ): Promise<number>

  Pin a conversation. If it doesn’t exist, the SDK creates and pins it automatically.

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for super groups. Pass null for other types.
  • top: boolean

    Pin status
  • Optionalcallback: IRCIMIWChangeConversationTopStatusCallback

    Event callback. Supported since SDK 5.3.1. Other callback methods deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback triggered. See error codes for details.

getConversationTopStatus

• getConversationTopStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetConversationTopStatusCallback,
  ): Promise<number>

  Get the pinned status of a conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for super groups. Pass null for other conversation types.
  • Optionalcallback: IRCIMIWGetConversationTopStatusCallback

    Event callback. SDK supports callback mode starting from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for results. Non-zero means the operation failed, and no callback will be triggered. Refer to error codes for details.

syncConversationReadStatus

• syncConversationReadStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWSyncConversationReadStatusCallback,
  ): Promise<number>

  Sync conversation read status

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for supergroups. Pass null for other conversation types
  • timestamp: number

    Timestamp of the last read message in the conversation
  • Optionalcallback: IRCIMIWSyncConversationReadStatusCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, detailed results need to implement the callback interface. Non-zero indicates failure, and no callback will be triggered. Refer to error codes for details

sendTypingStatus

• sendTypingStatus(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      currentType: string,
  ): Promise<number>

  Send a typing status to the conversation. Currently, only one-on-one chats are supported.

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only used for super groups. Pass null for other conversation types.
  • currentType: string

    Current status

  Returns Promise<number>

  Status code of the operation. 0 means success, with results in the callback. Non-zero means failure, no callback triggered. Check error codes for details.

getMessages

• getMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      sentTime: number,
      order: RCIMIWTimeOrder,
      policy: RCIMIWMessageOperationPolicy,
      count: number,
      callback?: IRCIMIWGetMessagesCallback,
  ): Promise<number>

  Load historical messages

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types
  • sentTime: number

    Current message timestamp
  • order: RCIMIWTimeOrder

    Message retrieval direction. BEFORE: get messages before sentTime (descending), AFTER: get messages after sentTime (ascending)
  • policy: RCIMIWMessageOperationPolicy

    Message loading strategy. LOCAL: load local only, REMOTE: load remote only, LOCAL_REMOTE: load both local and remote
  • count: number

    Number of messages to retrieve, 0 < count ≤ 20
  • Optionalcallback: IRCIMIWGetMessagesCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback is triggered

  Returns Promise<number>

  Status code of the current operation. 0 means success, check the callback for results. Non-zero means failure, no callback is triggered. Refer to error codes for details

getMessageById

• getMessageById(
      messageId: number,
      callback?: IRCIMIWGetMessageCallback,
  ): Promise<number>

  Get message body by message id (unique value in local database index)

  Parameters

  • messageId: number

    Message id, available in the message object
  • Optionalcallback: IRCIMIWGetMessageCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for results. Non-zero means the call failed, and no callback will be triggered. Refer to error codes for details.

getMessageByUId

• getMessageByUId(
      messageUId: string,
      callback?: IRCIMIWGetMessageCallback,
  ): Promise<number>

  Get message entity by global unique ID

  Parameters

  • messageUId: string

    Message UID, available in the message object. Only sent messages have a value.
  • Optionalcallback: IRCIMIWGetMessageCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated since 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for results. Non-zero means failure—no callback will be triggered. Refer to error codes for details.

getFirstUnreadMessage

• getFirstUnreadMessage(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetFirstUnreadMessageCallback,
  ): Promise<number>

  Get the first unread message

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only for super groups—set to null for other types
  • Optionalcallback: IRCIMIWGetFirstUnreadMessageCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for results. Non-zero means failure—no callback will be triggered. Refer to error codes for details

getUnreadMentionedMessages

• getUnreadMentionedMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetUnreadMentionedMessagesCallback,
  ): Promise<number>

  Fetch unread @ messages in a conversation

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types
  • Optionalcallback: IRCIMIWGetUnreadMentionedMessagesCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. Refer to error codes for details

insertMessage

• insertMessage(
      message: RCIMIWMessage,
      callback?: IRCIMIWInsertMessageCallback,
  ): Promise<number>

  Insert a message

  Parameters

  • message: RCIMIWMessage

    The message to insert
  • Optionalcallback: IRCIMIWInsertMessageCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback is triggered.

  Returns Promise<number>

  Status code of the operation. 0 indicates success—check the callback for results. Non-zero means the operation failed, and no callback is triggered. Refer to error codes for details.

insertMessages

• insertMessages(
      messages: RCIMIWMessage[],
      callback?: IRCIMIWInsertMessagesCallback,
  ): Promise<number>

  Insert multiple messages—supergroups not supported

  Parameters

  • messages: RCIMIWMessage[]

    Collection of messages to insert
  • Optionalcallback: IRCIMIWInsertMessagesCallback

    Event callback. SDK supports callback-style events starting from version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—specific results require implementing the callback. Non-zero means the operation failed, and no callback will be triggered. Refer to error codes for details.

clearMessages

• clearMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      timestamp: number,
      policy: RCIMIWMessageOperationPolicy,
      callback?: IRCIMIWClearMessagesCallback,
  ): Promise<number>

  Clear messages

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for supergroups. Pass null for other conversation types
  • timestamp: number

    Clear messages up to this timestamp. 0 ≤ timestamp ≤ sentTime of the last message in the current conversation. 0 clears all messages, other values clear messages ≤ recordTime
  • policy: RCIMIWMessageOperationPolicy

    Clear policy
  • Optionalcallback: IRCIMIWClearMessagesCallback

    Event callback. SDK supports callback method from version 5.3.1. Other callback methods deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only callback is triggered

  Returns Promise<number>

  Status code of current operation. 0 means success, non-0 means failure. For detailed errors, refer to error codes

deleteLocalMessages

• deleteLocalMessages(
      messages: RCIMIWMessage[],
      callback?: IRCIMIWDeleteLocalMessagesCallback,
  ): Promise<number>

  Delete local messages

  Parameters

  • messages: RCIMIWMessage[]

    Message collection
  • Optionalcallback: IRCIMIWDeleteLocalMessagesCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated since version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for details. Non-zero means the operation failed, and no callback will be triggered. Refer to error codes for more info.

deleteMessages

• deleteMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      messages: RCIMIWMessage[],
      callback?: IRCIMIWDeleteMessagesCallback,
  ): Promise<number>

  Delete messages

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • messages: RCIMIWMessage[]

    Message collection
  • Optionalcallback: IRCIMIWDeleteMessagesCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—results are returned via the callback. Non-zero indicates failure—no callback is triggered. Refer to error codes for details.

recallMessage

• recallMessage(
      message: RCIMIWMessage,
      callback?: IRCIMIWRecallMessageCallback,
  ): Promise<number>

  Recall a message

  Parameters

  • message: RCIMIWMessage

    Message to be recalled
  • Optionalcallback: IRCIMIWRecallMessageCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, and the result needs to be handled in the callback. Non-zero indicates failure, and no callback will be triggered. Refer to the error codes for details.

sendPrivateReadReceiptMessage

• sendPrivateReadReceiptMessage(
      targetId: string,
      channelId: string,
      timestamp: number,
      callback?: IRCIMIWSendPrivateReadReceiptMessageCallback,
  ): Promise<number>

  Send read receipt for messages in a conversation

  Parameters

  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • timestamp: number

    Timestamp of the last read message in the conversation
  • Optionalcallback: IRCIMIWSendPrivateReadReceiptMessageCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success. Specific results require implementing the callback. Non-zero indicates failure, and no callback will be triggered. Refer to error codes for details.

sendGroupReadReceiptRequest

• sendGroupReadReceiptRequest(
      message: RCIMIWMessage,
      callback?: IRCIMIWSendGroupReadReceiptRequestCallback,
  ): Promise<number>

  Request group chat message read receipt

  Parameters

  • message: RCIMIWMessage

    Message to request read receipt for
  • Optionalcallback: IRCIMIWSendGroupReadReceiptRequestCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered.

  Returns Promise<number>

  Status code of current operation. 0 means success—check callback for details. Non-zero means failure—no callback triggered. Refer to error codes for details.

sendGroupReadReceiptResponse

• sendGroupReadReceiptResponse(
      targetId: string,
      channelId: string,
      messages: RCIMIWMessage[],
      callback?: IRCIMIWSendGroupReadReceiptResponseCallback,
  ): Promise<number>

  Send group read receipt

  Parameters

  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • messages: RCIMIWMessage[]

    List of messages in the conversation to send read receipts for
  • Optionalcallback: IRCIMIWSendGroupReadReceiptResponseCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, with specific results in the callback. Non-zero indicates failure, no callback will be triggered. Refer to error codes for details

updateMessageExpansion

• updateMessageExpansion(
      messageUId: string,
      expansion: Map<string, string>,
      callback?: IRCIMIWUpdateMessageExpansionCallback,
  ): Promise<number>

  Update message expansion info Each message can carry up to 300 key-value pairs, with a max of 20 pairs per update

  Parameters

  • messageUId: string

    Message’s unique ID, available in the message object—only sent messages have this value
  • expansion: Map<string, string>

    Key-value pairs to update, stored in a HashMap. Keys support letters, numbers, and special characters (+ = - _)—no Chinese characters. Values can include spaces
  • Optionalcallback: IRCIMIWUpdateMessageExpansionCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. See error codes for details

removeMessageExpansionForKeys

• removeMessageExpansionForKeys(
      messageUId: string,
      keys: string[],
      callback?: IRCIMIWRemoveMessageExpansionForKeysCallback,
  ): Promise<number>

  Remove specific key-value pairs from message extensions

  Parameters

  • messageUId: string

    Message’s messageUid, available in the message object. Only successfully sent messages have a value
  • keys: string[]

    List of keys to remove from message extensions, type is ArrayList
  • Optionalcallback: IRCIMIWRemoveMessageExpansionForKeysCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback is triggered

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for results. Non-zero means the operation failed, and no callback is triggered. Refer to error codes for details

changeMessageSentStatus

• changeMessageSentStatus(
      messageId: number,
      sentStatus: RCIMIWSentStatus,
      callback?: IRCIMIWChangeMessageSentStatusCallback,
  ): Promise<number>

  Set message sending status

  Parameters

  • messageId: number

    Message ID, available in the message object
  • sentStatus: RCIMIWSentStatus

    Status to modify
  • Optionalcallback: IRCIMIWChangeMessageSentStatusCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback is triggered

  Returns Promise<number>

  Status code of the operation. 0 means success, specific results require interface callback. Non-zero means failure, no callback triggered, see error codes for details

changeMessageReceiveStatus

• changeMessageReceiveStatus(
      messageId: number,
      receivedStatus: RCIMIWReceivedStatus,
      callback?: IRCIMIWChangeMessageReceivedStatusCallback,
  ): Promise<number>

  Set message receive status

  Parameters

  • messageId: number

    Message ID, available from the message object
  • receivedStatus: RCIMIWReceivedStatus

    Status to modify
  • Optionalcallback: IRCIMIWChangeMessageReceivedStatusCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. Refer to error codes for details

joinChatRoom

• joinChatRoom(
      targetId: string,
      messageCount: number,
      autoCreate: boolean,
      callback?: IRCIMIWJoinChatRoomCallback,
  ): Promise<number>

  Join a chat room

  Parameters

  • targetId: string

    Chat room session ID
  • messageCount: number

    Number of messages to fetch upon entry, -1 fetches none, 0 fetches 10, max 50
  • autoCreate: boolean

    Create chat room if it doesn’t exist, TRUE creates and joins, FALSE joins directly if exists
  • Optionalcallback: IRCIMIWJoinChatRoomCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods deprecated in 5.4.0, will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of current operation, 0 means success, non-0 means failure, no callback triggered, see error codes for details

leaveChatRoom

• leaveChatRoom(
      targetId: string,
      callback?: IRCIMIWLeaveChatRoomCallback,
  ): Promise<number>

  Leave a chat room

  Parameters

  • targetId: string

    Chat room session ID
  • Optionalcallback: IRCIMIWLeaveChatRoomCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. Refer to error codes for details

getChatRoomMessages

• getChatRoomMessages(
      targetId: string,
      timestamp: number,
      order: RCIMIWTimeOrder,
      count: number,
      callback?: IRCIMIWGetChatRoomMessagesCallback,
  ): Promise<number>

  Fetch chat room message history. Note: Enable cloud storage for chat room messages first.

  Parameters

  • targetId: string

    Chat room session ID
  • timestamp: number

    Start message timestamp
  • order: RCIMIWTimeOrder

    Fetch order: 0 for reverse, 1 for forward
  • count: number

    Number of messages to fetch, 0 < count ≤ 50
  • Optionalcallback: IRCIMIWGetChatRoomMessagesCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback is triggered.

  Returns Promise<number>

  Status code of current operation. 0 means success—check callback for details. Non-zero means failure—no callback is triggered. Refer to error codes for details.

addChatRoomEntry

• addChatRoomEntry(
      targetId: string,
      key: string,
      value: string,
      deleteWhenLeft: boolean,
      overwrite: boolean,
      callback?: IRCIMIWAddChatRoomEntryCallback,
  ): Promise<number>

  Set custom chat room properties

  Parameters

  • targetId: string

    Chat room session ID
  • key: string

    Property name, supports uppercase, lowercase letters, numbers, and special characters + = - _, max length 128 characters
  • value: string

    Property value, max length 4096 characters
  • deleteWhenLeft: boolean

    Automatically delete key-value pair when user disconnects or leaves
  • overwrite: boolean

    Overwrite existing key if present
  • Optionalcallback: IRCIMIWAddChatRoomEntryCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods deprecated in 5.4.0, planned for removal in 6.x. If callback is provided, only callback is triggered

  Returns Promise<number>

  Status code of current operation. 0 indicates success, non-zero indicates failure. Detailed errors refer to error codes

addChatRoomEntries

• addChatRoomEntries(
      targetId: string,
      entries: Map<string, string>,
      deleteWhenLeft: boolean,
      overwrite: boolean,
      callback?: IRCIMIWAddChatRoomEntriesCallback,
  ): Promise<number>

  Set chat room custom properties in bulk

  Parameters

  • targetId: string

    Chat room session ID
  • entries: Map<string, string>

    Chat room properties
  • deleteWhenLeft: boolean

    Whether to automatically delete the key-value pair when user disconnects or leaves
  • overwrite: boolean

    Whether to force overwrite
  • Optionalcallback: IRCIMIWAddChatRoomEntriesCallback

    Event callback. SDK supports callback method from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of current operation. 0 indicates success—check callback for details. Non-zero indicates failure—no callback will be triggered. Refer to error codes for details

getChatRoomEntry

• getChatRoomEntry(
      targetId: string,
      key: string,
      callback?: IRCIMIWGetChatRoomEntryCallback,
  ): Promise<number>

  Get a single chat room property

  Parameters

  • targetId: string

    Chat room session ID
  • key: string

    Chat room property key
  • Optionalcallback: IRCIMIWGetChatRoomEntryCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for results. Non-zero means the operation failed—no callback will be triggered. Refer to error codes for details.

getChatRoomAllEntries

• getChatRoomAllEntries(
      targetId: string,
      callback?: IRCIMIWGetChatRoomAllEntriesCallback,
  ): Promise<number>

  Get all chatroom properties

  Parameters

  • targetId: string

    Chatroom session ID
  • Optionalcallback: IRCIMIWGetChatRoomAllEntriesCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of current operation. 0 means success—specific results need to implement the callback. Non-zero means the operation failed—no callback will be triggered. Refer to error codes for details

removeChatRoomEntry

• removeChatRoomEntry(
      targetId: string,
      key: string,
      force: boolean,
      callback?: IRCIMIWRemoveChatRoomEntryCallback,
  ): Promise<number>

  Remove custom chat room attributes.

  Parameters

  • targetId: string

    Chat room session ID
  • key: string

    Chat room attribute key
  • force: boolean

    Force deletion
  • Optionalcallback: IRCIMIWRemoveChatRoomEntryCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated starting from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 indicates success, and results are returned via callback. Non-zero indicates failure, and no callback is triggered. Refer to error codes for details.

removeChatRoomEntries

• removeChatRoomEntries(
      targetId: string,
      keys: string[],
      force: boolean,
      callback?: IRCIMIWRemoveChatRoomEntriesCallback,
  ): Promise<number>

  Delete chat room custom attributes in bulk

  Parameters

  • targetId: string

    Chat room session ID
  • keys: string[]

    Chat room attributes
  • force: boolean

    Force override
  • Optionalcallback: IRCIMIWRemoveChatRoomEntriesCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated starting from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback is triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for results. Non-zero means the operation failed, and no callback is triggered. Refer to error codes for details.

addToBlacklist

• addToBlacklist(
      userId: string,
      callback?: IRCIMIWAddToBlacklistCallback,
  ): Promise<number>

  Block a user Once blocked, they’ll see “Message failed—you’re blocked” when trying to message you. You can still message them.

  Parameters

  • userId: string

    User ID
  • Optionalcallback: IRCIMIWAddToBlacklistCallback

    Event callback. SDK supports callback since version 5.3.1. Other callback methods are deprecated as of 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the operation. 0 means success—check the callback for results. Non-zero means failure—no callback will be triggered. See error codes for details.

removeFromBlacklist

• removeFromBlacklist(
      userId: string,
      callback?: IRCIMIWRemoveFromBlacklistCallback,
  ): Promise<number>

  Remove a user from the blacklist

  Parameters

  • userId: string

    User ID
  • Optionalcallback: IRCIMIWRemoveFromBlacklistCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for details. Non-zero means the operation failed—no callback will be triggered. Refer to error codes for details.

getBlacklistStatus

• getBlacklistStatus(
      userId: string,
      callback?: IRCIMIWGetBlacklistStatusCallback,
  ): Promise<number>

  Check if a user is on the blacklist

  Parameters

  • userId: string

    User ID
  • Optionalcallback: IRCIMIWGetBlacklistStatusCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—results are returned via the callback. Non-zero values indicate failure, and no callback will be triggered. Refer to error codes for details.

getBlacklist

• getBlacklist(callback?: IRCIMIWGetBlacklistCallback): Promise<number>

  Get the current user’s blacklist

  Parameters

  • Optionalcallback: IRCIMIWGetBlacklistCallback

    Event callback. SDK supports callback mode since version 5.3.1. Other callback methods are deprecated in version 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for results. Non-zero means failure—no callback will be triggered. Refer to error codes for details

searchMessages

• searchMessages(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      keyword: string,
      startTime: number,
      count: number,
      callback?: IRCIMIWSearchMessagesCallback,
  ): Promise<number>

  Search messages in a specific conversation by keyword.

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported in super groups. Pass null for other conversation types.
  • keyword: string

    Search keyword
  • startTime: number

    Search messages before beginTime. Pass 0 to start from the latest message and search backward.
  • count: number

    Number of messages to query, 0 < count ≤ 50.
  • Optionalcallback: IRCIMIWSearchMessagesCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated since 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, with detailed results in the callback. Non-zero means the call failed, no callback will be triggered. Refer to error codes for details.

searchMessagesByTimeRange

• searchMessagesByTimeRange(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      keyword: string,
      startTime: number,
      endTime: number,
      offset: number,
      count: number,
      callback?: IRCIMIWSearchMessagesByTimeRangeCallback,
  ): Promise<number>

  Search messages in a specific conversation within a time range by keyword.

  Parameters

  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for super groups, pass null for other conversation types
  • keyword: string

    Search keyword
  • startTime: number

    Start time
  • endTime: number

    End time
  • offset: number

    Offset
  • count: number

    Number of search results to return, 0 < count ≤ 50
  • Optionalcallback: IRCIMIWSearchMessagesByTimeRangeCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of the current operation. 0 indicates success, detailed results require implementing the callback, non-0 indicates failure and won't trigger the callback, refer to error codes for details

searchMessagesByUserId

• searchMessagesByUserId(
      userId: string,
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      startTime: number,
      count: number,
      callback?: IRCIMIWSearchMessagesByUserIdCallback,
  ): Promise<number>

  Search messages in a specific conversation by user ID.

  Parameters

  • userId: string

    User ID
  • type: RCIMIWConversationType

    Conversation type
  • targetId: string

    Conversation ID
  • channelId: string

    Channel ID, only supported for super groups. Pass null for other conversation types.
  • startTime: number

    Start time for query. Pass 0 to search from the latest message, searching backward from this time.
  • count: number

    Number of search results to return. 0 < count ≤ 50.
  • Optionalcallback: IRCIMIWSearchMessagesByUserIdCallback

    Event callback. SDK supports callback method from version 5.3.1. Other callback methods are deprecated as of version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for results. Non-zero indicates failure—no callback will be triggered. Refer to error codes for details.

searchConversations

• searchConversations(
      conversationTypes: RCIMIWConversationType[],
      channelId: string,
      messageTypes: RCIMIWMessageType[],
      keyword: string,
      callback?: IRCIMIWSearchConversationsCallback,
  ): Promise<number>

  Search conversations by keyword.

  Parameters

  • conversationTypes: RCIMIWConversationType[]

    Conversation type collection
  • channelId: string

    Channel ID, only supported for super groups, pass null for other conversation types
  • messageTypes: RCIMIWMessageType[]

    Message types to search
  • keyword: string

    Keyword to search
  • Optionalcallback: IRCIMIWSearchConversationsCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If callback is provided, only callback will be triggered

  Returns Promise<number>

  Status code of current operation. 0 means success, results need to be handled via callback. Non-zero means failure, no callback will be triggered, refer to error codes for details

changeNotificationQuietHours

• changeNotificationQuietHours(
      startTime: string,
      spanMinutes: number,
      level: RCIMIWPushNotificationQuietHoursLevel,
      callback?: IRCIMIWChangeNotificationQuietHoursCallback,
  ): Promise<number>

  Mute notifications for a specific time period

  Parameters

  • startTime: string

    Start time in HH:MM:SS format
  • spanMinutes: number

    Duration in minutes, 0 < spanMinutes < 1440 (e.g., 60 means 1 hour, 1439 means all day)
  • level: RCIMIWPushNotificationQuietHoursLevel

    Notification level
  • Optionalcallback: IRCIMIWChangeNotificationQuietHoursCallback

    Event callback. Supported since SDK 5.3.1. Other callback methods deprecated in 5.4.0 and will be removed in 6.x. If callback is provided, only it will be triggered

  Returns Promise<number>

  Status code of the operation. 0 means success, non-zero means failure. Detailed errors refer to error codes

removeNotificationQuietHours

• removeNotificationQuietHours(
      callback?: IRCIMIWRemoveNotificationQuietHoursCallback,
  ): Promise<number>

  Remove global quiet hours for message notifications

  Parameters

  • Optionalcallback: IRCIMIWRemoveNotificationQuietHoursCallback

    Event callback. SDK supports callback method from version 5.3.1. Other callback methods are deprecated starting from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 indicates success—check the callback for details. Non-zero means the operation failed—no callback will be triggered. Refer to error codes for details.

getNotificationQuietHours

• getNotificationQuietHours(
      callback?: IRCIMIWGetNotificationQuietHoursCallback,
  ): Promise<number>

  Get the set quiet hours for message notifications

  Parameters

  • Optionalcallback: IRCIMIWGetNotificationQuietHoursCallback

    Event callback. SDK supports callback mode from version 5.3.1. Other callback methods are deprecated from version 5.4.0 and will be removed in 6.x. If a callback is provided, only the callback will be triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success—check the callback for details. Non-zero means failure—no callback will be triggered. Refer to error codes for details.

changeConversationNotificationLevel

• changeConversationNotificationLevel(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      level: RCIMIWPushNotificationLevel,
      callback?: IRCIMIWChangeConversationNotificationLevelCallback,
  ): Promise<number>

  Set message notification level for a conversation Note: For supergroups, leaving channelId empty sets the do-not-disturb level for messages not in any channel, without affecting all channels in the supergroup

  Parameters

  • type: RCIMIWConversationType

    Conversation type. Note the following restrictions:

    • Supergroup type: If supergroup service was enabled before 2022.09.01, setting a do-not-disturb level for all messages in a supergroup (i.e., messages in all channels and messages not in any channel) is not supported by default. This API only sets the do-not-disturb level for messages not in any channel within the specified supergroup (targetId). Submit a ticket to modify this behavior.
    • Chatroom type: Not supported, as chatroom messages don’t support push notifications by default.
  • targetId: string

    Conversation ID
  • channelId: string

    Supergroup channel ID. Pass null for other types.

    • If a channel ID is provided, the do-not-disturb level is set for that specific channel. If no channel ID is specified, it applies to all supergroup messages.
    • Note: For customers who enabled supergroup service before 2022.09.01, if no channel ID is specified, pass an empty string "" to set the do-not-disturb level only for messages not in any channel within the specified supergroup (targetId). Submit a ticket to modify this behavior.
  • level: RCIMIWPushNotificationLevel

    Message notification level
  • Optionalcallback: IRCIMIWChangeConversationNotificationLevelCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated as of 5.4.0 and will be removed in 6.x. If callback is provided, only the callback is triggered.

  Returns Promise<number>

  Status code of the operation. 0 indicates success. Specific results require implementing the callback. Non-zero indicates failure, and no callback is triggered. Refer to error codes for details.

getConversationNotificationLevel

• getConversationNotificationLevel(
      type: RCIMIWConversationType,
      targetId: string,
      channelId: string,
      callback?: IRCIMIWGetConversationNotificationLevelCallback,
  ): Promise<number>

  Get conversation notification status

  Parameters

  • type: RCIMIWConversationType

    Conversation type. Note the following limitations:

    • Supergroup type: If you enabled supergroup before 2022.09.01, setting a Do Not Disturb level for all messages in a single supergroup is not supported by default (“all messages” refers to messages in all channels and messages not in any channel). This API only sets the Do Not Disturb level for messages not in any channel in the specified supergroup (targetId). Submit a ticket for changes.
    • Chatroom type: Not supported, as chatroom messages don’t support push notifications by default.
  • targetId: string

    Conversation ID
  • channelId: string

    Supergroup channel ID. Pass null for other types.

    • If a channel ID is passed, the Do Not Disturb level is set for that specific channel. If no channel ID is specified, it applies to all supergroup messages.
    • Note: For customers who enabled supergroup before 2022.09.01, if no channel ID is specified, pass an empty string "" to set the Do Not Disturb level only for messages not in any channel in the specified supergroup (targetId). Submit a ticket for changes.
  • Optionalcallback: IRCIMIWGetConversationNotificationLevelCallback

    Event callback. SDK supports callback from version 5.3.1. Other callback methods are deprecated as of 5.4.0 and will be removed in 6.x. If a callback is passed, only the callback is triggered.

  Returns Promise<number>

  Status code of the current operation. 0 means success, and specific results require implementing the callback. Non-zero means the operation failed, and no callback is triggered. Refer to error codes for details.