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/
Reactions/

Reactions

Feature Description

The message response feature refers to interacting with a specific message, a typical scenario being emoji responses. Emoji responses are interactive responses using emoticons, and we can see the number of respondents and the list of respondents for each emoji.
Note：
This feature is only available to Advanced Edition customers. You can use it after purchasing the Advanced Edition.
This feature is supported only by the Enhanced SDK v7.4 or later

Effect

You can achieve the following emoji response effects with this feature:


API Description

You can implement emoji response capabilities based on SDK API:
Call addMessageReaction interface to add an emoji to a message. After adding successfully, the current operating user will be stored under the emoji.
Call removeMessageReaction interface to delete the added emoji. After deleting successfully, the current operating user will no longer be stored under the emoji.
Call getMessageReactions interface to batch fetch the emoji list of multiple messages. Each emoji contains the total number of current users and the first N (default 10) user profiles.
Call getAllUserListOfMessageReaction interface to paginate fetching the full list of user profiles using the message emoji.
Listen to the onRecvMessageReactionsChanged callback to perceive the change of user profile of the emoji. The callback will carry the latest user profile of the emoji (including the total number of users and the first N user profiles).
For specific usage instructions, refer to the following text.

Add message reaction

Calling the addMessageReaction (Android / iOS & Mac / Windows) interface can add message reaction.
Add message reaction interface input parameter explanation is as follows:
Input Parameter
Definition
Description
message
Message object
The message must be in a Sent successfully status.
reactionID
Message reaction ID
In the emoticon response scenario, the reactionID is the emoticonID.
Note
1. A single message supports up to 10 reactions, and a single reaction supports up to 100 users.
2. If the total count of reactions in a single message exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_COUNT_LIMIT error.
3. If the total count of users in a single reaction exceeds the maximum limit, the interface will report ERR_SVR_MSG_REACTION_USER_COUNT_LIMIT error.
4. If the reaction already contains the current operating user, the interface will report ERR_SVR_MSG_REACTION_ALREADY_CONTAIN_USER error.
Sample code:
Android
iOS & Mac
Windows
V2TIMManager.getMessageManager().addMessageReaction(message, "emoji", new V2TIMCallback() {
    @Override
    public void onSuccess() {
       // add message reaction succ
    }
    @Override
    public void onError(int code, String desc) {
       // add message reaction failed
    }
});
[[V2TIMManager sharedInstance] addMessageReaction:message reactionID:@"emoji" succ:^{
    // add message reaction succ
} fail:^(int code, NSString *desc) {
    // add message reaction failed
}];
class Callback final : public V2TIMCallback {
public:
    using SuccessCallback = std::function<void()>;
    using ErrorCallback = std::function<void(int, const V2TIMString &)>;
    Callback() = default;
    ~Callback() override = default;
    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }
    void OnSuccess() override {
        if (success_callback_) {
            success_callback_();
        }
    }
    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_;
};

auto *callback = new Callback{};
callback->SetCallback(
    [=]() {
        // add message reaction succ
        delete callback;
    },
    [=](int error_code, const V2TIMString &error_message) {
        // add message reaction failed
        delete callback;
    });
V2TIMManager::GetInstance()->GetMessageManager()->AddMessageReaction(message, "emoji", callback);

Remove message reaction

Calling the removeMessageReaction (Android / iOS & Mac/ Windows) interface can add message reaction.
Remove message reaction interface input parameter explanation is as follows:
Input Parameter
Definition
Description
message
Message object
The message must be in a Sent successfully status.
reactionID
Message reaction ID
In the emoticon response scenario, the reactionID is the emoticonID.
Note
If the reaction does not exist, the interface will report ERR_SVR_MSG_REACTION_NOT_EXISTS error.
If the reaction does not contain the current user, the interface will report ERR_SVR_MSG_REACTION_NOT_CONTAIN_USER error.
Sample code:
Android
iOS & Mac
Windows
V2TIMManager.getMessageManager().removeMessageReaction(message, "emoji", new V2TIMCallback() {
    @Override
    public void onSuccess() {
       // remove message reaction succ
    }
    @Override
    public void onError(int code, String desc) {
       // remove message reaction failed
    }
});
[[V2TIMManager sharedInstance] removeMessageReaction:message reactionID:@"emoji" succ:^{
    // remove message reaction succ
} fail:^(int code, NSString *desc) {
    // remove message reaction failed
}];
class Callback final : public V2TIMCallback {
public:
    using SuccessCallback = std::function<void()>;
    using ErrorCallback = std::function<void(int, const V2TIMString &)>;
    Callback() = default;
    ~Callback() override = default;
    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }
    void OnSuccess() override {
        if (success_callback_) {
            success_callback_();
        }
    }
    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_;
};

auto *callback = new Callback{};
callback->SetCallback(
    [=]() {
        // remove message reaction succ
        delete callback;
    },
    [=](int error_code, const V2TIMString &error_message) {
        // remove message reaction failed
        delete callback;
    });
V2TIMManager::GetInstance()->GetMessageManager()->RemoveMessageReaction(message, "emoji", callback);

Get message reactions

Calling the getMessageReactions (Android / iOS & Mac/ Windows) interface can get multiple message reactions.
Get message reactions interface input parameter explanation is as follows:
Input Parameter
Definition
Description
messageList
Message object list
Supports up to 20 messages at a time.
maxUserCountPerReaction
Each Reaction returns the maximum user profile quantity
The value range is 【0,10】. Every reaction only supports returning the first 10 user profile at most. If you need more user profile, you can call the getAllUserListOfMessageReaction interface to pull in pages.
Get message reactions information resultV2TIMMessageReactionResult object explanation is as follows:
Input Parameter
Definition
Description
resultCode
Result code
0：indicates success.
Non-zero: indicates failure.
resultInfo
Result info
result info.
msgID
Unique ID of the message
Unique ID of the message.
reactionList
Message reaction list
Message reaction V2TIMMessageReaction object list.
The detailed explanation of the V2TIMMessageReaction object is as follows:
Input Parameter
Definition
Description
reactionID
Message reaction id
In the emoticon response scenario, the reactionID is the emoticonID.
totalUserCount
Total user count
The total count of users which have added reaction with the same ID to a message.
partialUserList

Partial user list
The partial user list which have added reaction with the same ID to a message.
The count of users depends on the maxUserCountPerReaction value set when calling the getMessageReactions interface.
reactedByMyself
Whether I have used this reaction
This field returns true if I use the reaction.
Sample code:
Android
iOS & Mac
Windows
V2TIMManager.getMessageManager().getMessageReactions(msgList, 5, 
    new V2TIMValueCallback<List<V2TIMMessageReactionResult>>() {
    @Override
    public void onSuccess(List<V2TIMMessageReactionResult> v2TIMMessageReactionResults) {
        // get message reactions succ
        for (V2TIMMessageReactionResult reactionResult : v2TIMMessageReactionResults) {
            int resultCode = reactionResult.getResultCode();
            String resultInfo = reactionResult.getResultInfo();
            List<V2TIMMessageReaction> reactionList = reactionResult.getReactionList();
            for (V2TIMMessageReaction reaction : reactionList) {
                String reactionID = reaction.getReactionID();
                int totalUserCount = reaction.getTotalUserCount();
                List<V2TIMUserInfo> partialUserList = reaction.getPartialUserList();
            }
        }
    }
    @Override
    public void onError(int code, String desc) {
        // get message reactions failed
    }
});
[[V2TIMManager sharedInstance] getMessageReactions:msgList maxUserCountPerReaction:5 
    succ:^(NSArray<V2TIMMessageReactionResult *> *resultList) {
    // get message reactions succ
    for (V2TIMMessageReactionResult *result in resultList) {
        int32_t resultCode = result.resultCode;
        NSString *resultInfo = result.resultInfo;
        NSArray *reactionList = result.reactionList;
        for (V2TIMMessageReaction *reaction in reactionList) {
            NSString *reactionID = reaction.reactionID;
            uint32_t totalUserCount = reaction.totalUserCount;
            NSArray *partialUserList = reaction.partialUserList;
        }
    }
} fail:^(int code, NSString *desc) {
    // get message reactions failed
}];
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() = defalt;
    ~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_;
};

auto *callback = new ValueCallback<V2TIMMessageReactionResultVector>{};
callback->SetCallback(
    [=](const V2TIMMessageReactionResultVector &messageReactionResultList) {
        // get message reactions succ
        delete callback;
    },
    [=](int error_code, const V2TIMString &error_message) {
        // get message reactions failed
        delete callback;
    });
V2TIMMessageVector message_list;
message_list.PushBack(message);
V2TIMManager::GetInstance()->GetMessageManager()->GetMessageReactions(message_list, 5, callback);

Get user list of message reaction

Calling the getAllUserListOfMessageReaction (Android / iOS & Mac / Windows) interface can get all user list of message reaction.
Get all user list of message reaction interface input parameter explanation is as follows:
Input Parameter
Definition
Description
message
Message object
The message must be in a Sent successfully status.
reactionID
Message reaction ID
In the emoticon response scenario, the reactionID is the emoticonID.
nextSeq
The next pulling-by-page cursor
Pass 0 for the first time, and pass the nextSeq returned by succ for subsequent pagination.
count
The maximum count of users fetched per page
Up to 100.
Sample code:
Android
iOS & Mac
Windows
int nextSeq = 0;
int count = 100;
V2TIMManager.getMessageManager().getAllUserListOfMessageReaction(message, "emoji", nextSeq, count, 
    new V2TIMValueCallback<V2TIMMessageReactionUserResult>() {
    @Override
    public void onSuccess(V2TIMMessageReactionUserResult v2TIMMessageReactionUserResult) {
        // get all user list of message reaction succ
        // nextSeq：next pull sequence
    }
    @Override
    public void onError(int code, String desc) {
        // get all user list of message reaction failed
    }
});
uint32_t nextSeq = 0;
uint32_t count = 100;
[[V2TIMManager sharedInstance] getAllUserListOfMessageReaction:message reactionID:@"emoji" nextSeq:nextSeq count:count 
   succ:^(NSArray<V2TIMUserInfo *> *userList, uint32_t nextSeq, BOOL isFinished) {
    // get all user list of message reaction succ
    // nextSeq：next pull sequence
} fail:^(int code, NSString *desc) {
    // get all user list of message reaction failed
}];
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() = defalt;
    ~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_;
};

auto *callback = new ValueCallback<V2TIMMessageReactionUserResult>{};
callback->SetCallback(
    [=](const V2TIMMessageReactionUserResult &messageReactionUserResult) {
        // get all user list of message reaction succ
        delete callback;
    },
    [=](int error_code, const V2TIMString &error_message) {
        // get all user list of message reaction failed
        delete callback;
    });
V2TIMManager::GetInstance()->GetMessageManager()->GetAllUserListOfMessageReaction(message, "emoji", 0, 100, callback);

Message reaction changed notification

If you have added an advanced message event listener in advance by calling addAdvancedMsgListener, you will receive the onRecvMessageReactionsChanged (Android / iOS & Mac / Windows) callback when the message reaction information is updated. It should be noted that this callback is an incremental callback for message Reaction, and it will only carry the changed Reaction information. When the totalUserCount field value in the changed Reaction information is 0, it means that no users are using this Reaction, and you can remove the display of this Reaction on the UI.
Sample code:
Android
iOS & Mac
Windows
V2TIMManager.getMessageManager().addAdvancedMsgListener(new V2TIMAdvancedMsgListener() {
    @Override
    public void onRecvMessageReactionsChanged(List<V2TIMMessageReactionChangeInfo> changeInfos) {
       // receive message reactions changed notify
       String msgID = changeInfo.getMessageID();
       // changed reaction list
       List<V2TIMMessageReaction> reactionList = changeInfo.getReactionList();
    }
});
[[V2TIMManager sharedInstance] addAdvancedMsgListener:self];
- (void)onRecvMessageReactionsChanged:(NSArray<V2TIMMessageReactionChangeInfo *> *)changeList {
     // receive message reactions changed notify
    for (V2TIMMessageReactionChangeInfo *changeInfo in changeList) {
        NSString *msgID = changeInfo.msgID;
        // changed reaction list
        NSArray *reactionList = changeInfo.reactionList;
    }
}
V2TIMManager::GetInstance()->GetMessageManager()->AddAdvancedMsgListener(this);
void OnRecvMessageReactionsChanged(const V2TIMMessageReactionChangeInfoVector &changeInfos) override {
     // receive message reactions changed notify
     for (size_t i = 0; i < changeInfos.Size(); i++) {
         V2TIMMessageReactionChangeInfo reactionChangeInfo = changeInfos[i];
         V2TIMString msgID = reactionChangeInfo.msgID;
         // changed reaction list
         V2TIMMessageReactionVector reactionList = reactionChangeInfo.reactionList;
     }
 }