please select
  • UIKit
  • SDK
  • Server APIs
Chat/
SDK/
Android/
Message/
SDK
  • Install Chat SDK
  • Initialize Chat SDK
  • Login and Logout
  • Message
    • Overview
    • Send a Message
    • Receive a Message
    • Retrieve Messages
    • Forward Messages
    • Modify a Message
    • Insert a Message
    • Delete Messages
    • Clear History Messages
    • Recall a Message
    • Send an Online Message
    • Message Read Receipt
    • Query Messages
    • Mentions
    • Targeted Group Message
    • Do not Notify
    • Key-Value Extensions
    • Reactions
    • Translation
    • Pin Messages
  • Conversation
    • Overview
    • Conversation List
    • Get Conversations
    • Unread Count
    • Pin Conversations
    • Delete Conversations
    • Draft
    • Mark
    • Conversation Group
  • Group
    • Overview
    • Manage Group
    • Profile
    • Manage Members
    • Member Profile
    • Attribute
    • Counter
  • Community and Topic
    • Manage Community
    • Permission Group
  • User
    • User Profile
    • User Status
    • Manage Friends
    • Friend Group
    • Block Lists
    • Follow
  • Local Search
    • Search Messages
    • Search Friends
    • Search Groups
    • Search Group Members
  • Signaling
  • API Reference
    • Java
  • Guideline for Beginners
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes
Docs Overview/
Chat/
SDK/
Android/
Message/
Insert a Message/

Insert a Message

Feature Description

When a message is inserted, the message will only be inserted into the local database but not be sent to the server. This API is used to insert tips into a conversation, such as "You have left the group" and "Keep your information secure. Do not send private information such as account, password, and verification code to the group chat". Such messages need to be displayed in the chat area, but do not need to be sent to others.
Caution
Inserted messages will be lost if the account is logged in on another mobile device or the application is uninstalled and reinstalled.

Inserting a local message into one-to-one messages

Call insertC2CMessageToLocalStorage (Android / iOS and macOS / Windows) to insert a local message into one-to-one messages.
Sample code:
Android
iOS and macOS
Windows
// Create a message
V2TIMMessage msg = V2TIMManager.getMessageManager().createTextMessage("Insert a local message between one-to-one messages");
// Insert the message into the local database
V2TIMManager.getMessageManager().insertC2CMessageToLocalStorage(msg, "receiver_userID", "sender_userID", new V2TIMValueCallback<V2TIMMessage>() {
  @Override
  public void onSuccess(V2TIMMessage message) {
      // Inserted the message into one-to-one messages successfully
  }

  @Override
  public void onError(int code, String desc) {
      // Failed to insert the message into one-to-one messages
  }
});
// Create a message
V2TIMMessage *msg = [[V2TIMManager sharedInstance] createTextMessage:@"Insert a local message between C2C messages"];
// Insert the message into the local database
[[V2TIMManager sharedInstance] insertC2CMessageToLocalStorage:msg
                                                           to:@"receiver_userID"  // `userID` of the receiver
                                                       sender:@"sender_userID"  // `userID` of the sender
                                                         succ:^{
    NSLog(@"Message inserted between one-to-one messages successfully");
} fail:^(int code, NSString *msg) {
    NSLog(@"Failed to insert the message between one-to-one messages, code: %d, msg: %@", code, msg);
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
    using SuccessCallback = std::function<void(const T&)>;
    using ErrorCallback = std::function<void(int, const V2TIMString&)>;

    ValueCallback() = default;
    ~ValueCallback() override = default;

    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }

    void OnSuccess(const T& value) override {
        if (success_callback_) {
            success_callback_(value);
        }
    }
    void OnError(int error_code, const V2TIMString& error_message) override {
        if (error_callback_) {
            error_callback_(error_code, error_message);
        }
    }

private:
    SuccessCallback success_callback_;
    ErrorCallback error_callback_;
};

V2TIMMessage message =
    V2TIMManager::GetInstance()->GetMessageManager()->CreateTextMessage(u8"Insert a local message between one-to-one messages");
V2TIMString userID = "receiver_userID";
V2TIMString sender = "sender_userID";

auto callback = new ValueCallback<V2TIMMessage>{};
callback->SetCallback(
    [=](const V2TIMMessage& message) {
        // Inserted the message between one-to-one messages successfully
        delete callback;
    },
    [=](int error_code, const V2TIMString& error_message) {
        // Failed to insert the message between one-to-one messages
        delete callback;
    });

V2TIMManager::GetInstance()->GetMessageManager()->InsertGroupMessageToLocalStorage(message, userID, sender,
                                                                                   callback);

Inserting a local message into group messages

Call insertGroupMessageToLocalStorage (Android / iOS and macOS / Windows) to insert a local message into group messages.
Sample code:
Android
iOS and macOS
Windows
// Create a message
V2TIMMessage msg = V2TIMManager.getMessageManager().createTextMessage("Insert a local message between group messages");
// Insert the message into the local database
V2TIMManager.getMessageManager().insertGroupMessageToLocalStorage(msg, "groupID", "sender_userID", new V2TIMValueCallback<V2TIMMessage>() {
  @Override
  public void onSuccess(V2TIMMessage message) {
      // Message inserted into group messages successfully
  }

  @Override
  public void onError(int code, String desc) {
      // Failed to insert the message into group messages
  }
});
// Create a message 
V2TIMMessage *msg = [[V2TIMManager sharedInstance] createTextMessage:@"Insert a local message between group messages"];
// Insert the message into the local database
[[V2TIMManager sharedInstance] insertGroupMessageToLocalStorage:msg 
                                                             to:@"groupID"  // `groupID` of the group chat
                                                         sender:@"sender_userID"  // `userID` of the sender
                                                           succ:^{
    NSLog(@"Message inserted between group messages successfully");
} fail:^(int code, NSString *msg) {
    NSLog(@"Failed to insert the message between group messages, code: %d, msg: %@", code, msg);
}];
template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
    using SuccessCallback = std::function<void(const T&)>;
    using ErrorCallback = std::function<void(int, const V2TIMString&)>;

    ValueCallback() = default;
    ~ValueCallback() override = default;

    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }

    void OnSuccess(const T& value) override {
        if (success_callback_) {
            success_callback_(value);
        }
    }
    void OnError(int error_code, const V2TIMString& error_message) override {
        if (error_callback_) {
            error_callback_(error_code, error_message);
        }
    }

private:
    SuccessCallback success_callback_;
    ErrorCallback error_callback_;
};

V2TIMMessage message =
    V2TIMManager::GetInstance()->GetMessageManager()->CreateTextMessage(u8"Insert a local message between group messages");
V2TIMString groupID = "groupID";
V2TIMString sender = "sender_userID";

auto callback = new ValueCallback<V2TIMMessage>{};
callback->SetCallback(
    [=](const V2TIMMessage& message) {
        // Message inserted between group messages successfully
        delete callback;
    },
    [=](int error_code, const V2TIMString& error_message) {
        // Failed to insert the message between group messages
        delete callback;
    });

V2TIMManager::GetInstance()->GetMessageManager()->InsertGroupMessageToLocalStorage(message, groupID, sender,
                                                                                   callback);