聊天室消息管理 - IM 即时通讯

开发者中心

IM 即时通讯

集成开发

聊天室消息管理

更新时间： 2024/07/01 15:54:47

网易云信 IM 支持聊天室中各种类型消息的收发，聊天室相关操作的通知类消息的接收。

本文介绍如何实现聊天室消息收发，及聊天室历史消息查询。

前提条件

在实现消息收发之前，请确保：

已实现聊天室登录。
已了解各消息类型的使用限制。

聊天室消息收发

消息流控机制

为保证用户体验（如避免服务器过载），聊天室存在流量控制机制（以下简称“流控机制”）：

针对普通消息：聊天室用户每秒至多可接收 20 条，超过部分会因为流控随机丢弃。
针对高优先级消息：聊天室用户每秒至多接收 10 条，超过部分可能会丢失。为避免丢失重要消息（通常为服务端消息），可将重要消息设置为高优先级消息，进而保证高优先级消息流控上限内（每秒 10 条）的消息不丢失。如何实现高优先级消息请参见消息发送配置选项。

API 调用时序

以收发聊天室文本消息为例，API 调用时序如下图：

实现步骤

接收方注册聊天室监听器，监听聊天室消息接收回调事件 onReceiveMessages。

Android

javaV2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();

V2NIMChatroomListener listener = new V2NIMChatroomListener() {
    @Override
    public void onReceiveMessages(List<V2NIMChatroomMessage> messages) {

    }
};

v2ChatroomService.addChatroomListener(listener);

iOS

objective-c@interface Listener: NSObject<V2NIMChatroomListener>
- (void)addToService;
@end

@implementation Listener

- (void)addToService
{
    id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];
    [service addChatroomListener:self];
}

- (void)onReceiveMessages:(NSArray *)messages
{

}
@end

macOS/Windows

cppV2NIMChatroomListener listener;
listener.onReceiveMessages = [](nstd::vector<V2NIMChatroomMessage> messages) {
    // handle receive messages
};
chatroomService.addChatroomListener(listener);

Web/uni-app/小程序

typescriptchatroom.V2NIMChatroomService.on('onReceiveMessages', function (messages: V2NIMChatroomMessage[]){})

Harmony

typescriptchatroom.chatroomService.on('onReceiveMessages', (messages: V2NIMChatroomMessage[]) => {})

发送方调用 V2NIMChatroomMessageCreator#createTextMessage 方法，构建一条文本消息。

Android

javaV2NIMChatroomMessage v2TextMessage = V2NIMChatroomMessageCreator.createTextMessage("text content");

iOS

objective-cV2NIMChatroomMessage *v2TextMessage = [V2NIMChatroomMessageCreator createTextMessage:@"text content"];

macOS/Windows

cppauto textMessage = V2NIMChatroomMessageCreator::createTextMessage("hello world");
if(!textMessage) {
    // create text message failed
}

Web/uni-app/小程序

typescripttry {
    const message = chatroom.V2NIMChatroomMessageCreator.createTextMessage('hello world')
} catch(err) {
    // todo error
}

Harmony

typescriptconst message: V2NIMChatroomMessage = this.chatroomClient.messageCreator.createTextMessage('hello world')

根据自身业务需求，配置消息发送参数 V2NIMSendChatroomMessageParams，包括发送、抄送、反垃圾、标签、空间位置等配置。支持设置聊天室消息为高优先级消息、是否保存在在服务端。

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`messageConfig`	`V2NIMChatroomMessageConfig`	否	-	聊天室消息相关配置
`routeConfig`	`V2NIMMessageRouteConfig`	否	-	消息事件抄送相关配置
`antispamConfig`	`V2NIMMessageAntispamConfig`	否	-	消息反垃圾相关配置，包括本地反垃圾或安全通配置，均需要在云信控制台开通。
`clientAntispamEnabled`	boolean	否	false	是否启用本地反垃圾。仅对文本消息生效如果开启本地发垃圾，发送消息时会进行本地反垃圾检测，完成后返回检测结果 `V2NIMClientAntispamOperatorType`： 0：检测通过，可以发送该消息。 1：发送替换后的文本消息。 2：检测不通过，消息发送失败，返回本地错误码。 3：消息发送后，由服务端拦截
`clientAntispamReplace`	String	若 `clientAntispamEnabled` 为 true 则必填	""	反垃圾命中后替换的文本
`receiverIds`	List	否	null	定向消息接收者账号列表。若该字段不为空，则表示该消息为聊天室定向消息，不在服务端进行存储。
`notifyTargetTags`	String	否	null	消息接收通知的标签，请参见标签表达式
`locationInfo`	`V2NIMLocationInfo`	否	null	消息空间位置信息配置

发送方调用 V2NIMChatroomService#sendMessage 方法，发送已构建的文本消息。发送消息时，设置消息发送成功回调参数 success 和消息发送失败回调参数 failure，监听消息发送是否成功。若消息发送成功，则通过 V2NIMSuccessCallback 回调返回的 V2NIMSendMessageResult 接收消息对象；若消息发送失败，则通过 V2NIMFailureCallback 获取相关错误码。

参数说明

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

Android

参数名称	类型	是否必填	默认值	描述
`message`	`V2NIMChatroomMessage`	是	-	聊天室消息对象，通过调用 `V2NIMChatroomMessageCreator` 中的接口创建。如果为空或不存在则返回 191004 参数错误。
`params`	`V2NIMSendChatroomMessageParams`	否	null	聊天室消息发送配置参数，包括发送、抄送、反垃圾、标签、空间位置等配置。
`success`	`V2NIMSuccessCallback`	是	-	消息发送成功回调，返回 `V2NIMSendMessageResult`。
`failure`	`V2NIMFailureCallback`	是	-	消息发送失败回调，返回错误码。
`progress`	`V2NIMProgressCallback`	否	null	附件上传进度回调，用于图片、语音、视频、文件类型消息。

iOS

参数名称	类型	是否必填	默认值	描述
`message`	`V2NIMChatroomMessage`	是	-	聊天室消息对象，通过调用 `V2NIMChatroomMessageCreator` 中的接口创建。如果为空或不存在则返回 191004 参数错误。
`params`	`V2NIMSendChatroomMessageParams`	否	null	聊天室消息发送配置参数，包括发送、抄送、反垃圾、标签、空间位置等配置。
`success`	`V2NIMSuccessCallback`	是	-	消息发送成功回调，返回 `V2NIMSendMessageResult`。
`failure`	`V2NIMFailureCallback`	是	-	消息发送失败回调，返回错误码。
`progress`	`V2NIMProgressCallback`	否	null	附件上传进度回调，用于图片、语音、视频、文件类型消息。

macOS/Windows

参数名称	类型	是否必填	默认值	描述
`message`	`V2NIMChatroomMessage`	是	-	聊天室消息对象，通过调用 `V2NIMChatroomMessageCreator` 中的接口创建。如果为空或不存在则返回 191004 参数错误。
`params`	`V2NIMSendChatroomMessageParams`	否	null	聊天室消息发送配置参数，包括发送、抄送、反垃圾、标签、空间位置等配置。
`success`	`V2NIMSuccessCallback`	是	-	消息发送成功回调，返回 `V2NIMSendMessageResult`。
`failure`	`V2NIMFailureCallback`	是	-	消息发送失败回调，返回错误码。
`progress`	`V2NIMProgressCallback`	否	null	附件上传进度回调，用于图片、语音、视频、文件类型消息。

Web/uni-app/小程序

参数名称	类型	是否必填	默认值	描述
`message`	`V2NIMChatroomMessage`	是	-	聊天室消息对象，通过调用 `V2NIMChatroomMessageCreator` 中的接口创建。如果为空或不存在则返回 191004 参数错误。
`params`	`V2NIMSendChatroomMessageParams`	否	null	聊天室消息发送配置参数，包括发送、抄送、反垃圾、标签、空间位置等配置。
`progress`	number	否	null	附件上传进度（百分比），用于图片、语音、视频、文件类型消息。

Harmony

参数名称	类型	是否必填	默认值	描述
`message`	`V2NIMChatroomMessage`	是	-	聊天室消息对象，通过调用 `V2NIMChatroomMessageCreator` 中的接口创建。如果为空或不存在则返回 191004 参数错误。
`params`	`V2NIMSendChatroomMessageParams`	否	null	聊天室消息发送配置参数，包括发送、抄送、反垃圾、标签、空间位置等配置。
`progress`	number	否	null	附件上传进度（百分比），用于图片、语音、视频、文件类型消息。

示例代码

Android

java// 新建一个聊天室实例，注意：每次 newInstance 都会返回一个新的实例，实际使用中请一个聊天室对应一个V2NIMChatroomClient实例，使用中需要临时缓存
V2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.newInstance();
// 获取聊天室服务
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();
// 创建一条文本消息
V2NIMChatroomMessage v2Message = V2NIMChatroomMessageCreator.createTextMessage("xxx");

V2NIMChatroomMessageConfig messageConfig = new V2NIMChatroomMessageConfig();
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认true
// messageConfig.setHistoryEnabled(true);
// 设置是否是高优先级消息，默认false
// messageConfig.setHighPriority(false);

V2NIMMessageRouteConfig routeConfig = V2NIMMessageRouteConfig.V2NIMMessageRouteConfigBuilder.builder()
// 根据实际情况配置
// .withRouteEnabled()
// .withRouteEnvironment()
.build();

V2NIMMessageAntispamConfig antispamConfig = V2NIMMessageAntispamConfig.V2NIMMessageAntispamConfigBuilder.builder()
// 根据实际情况配置
// .withAntispamBusinessId()
// .withAntispamCheating()
// .withAntispamCustomMessage()
// .withAntispamEnabled()
// .withAntispamExtension()
.build();

V2NIMSendChatroomMessageParams params = new V2NIMSendChatroomMessageParams();
// 设置消息相关配置
// params.setMessageConfig(messageConfig);
// 设置路由抄送相关配置
// params.setRouteConfig(routeConfig);
// 设置反垃圾相关配置
// params.setAntispamConfig(antispamConfig);
// 是否开启本地反垃圾，默认false
// params.setClientAntispamEnabled(false);
// 本地反垃圾的替换文本
// params.setClientAntispamReplace("xxx");
//设置聊天室定向消息接收者账号ID列表
// params.setReceiverIds(receiverIds);
// 设置消息的目标标签表达式
// params.setNotifyTargetTags("xxx");
// 设置位置信息
// params.setLocationInfo(locationInfo);
v2ChatroomService.sendMessage(v2Message,params,
new V2NIMSuccessCallback<V2NIMSendChatroomMessageResult>() {
    @Override
    public void onSuccess(V2NIMSendChatroomMessageResult result) {
        // 发送成功
    }
},
new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 发送失败
    }
},
new V2NIMProgressCallback() {
    @Override
    public void onProgress(int progress) {
        // 发送进度
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室服务
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:instanceId] getChatroomService];
// 创建一条文本消息
V2NIMChatroomMessage *message = [V2NIMChatroomMessageCreator createTextMessage:@"xxx"];
V2NIMChatroomMessageConfig *messageConfig = [V2NIMChatroomMessageConfig new];
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认 true
// messageConfig.historyEnabled = YES;
// 设置是否是高优先级消息，默认 false
// messageConfig.highPriority = NO;
V2NIMMessageRouteConfig *routeConfig = [V2NIMMessageRouteConfig new];
// 根据实际情况配置
// routeConfig.routeEnabled
// routeConfig.routeEnvironment
V2NIMMessageAntispamConfig *antispamConfig = [V2NIMMessageAntispamConfig new];
// 根据实际情况配置
// antispamConfig.antispamBusinessId
// antispamConfig.antispamCheating
// antispamConfig.antispamCustomMessage
// antispamConfig.antispamEnabled
// antispamConfig.antispamExtension

V2NIMSendChatroomMessageParams *params = [V2NIMSendChatroomMessageParams new];
// 设置消息相关配置
// params.messageConfig = messageConfig;
// 设置路由抄送相关配置
// params.routeConfig = routeConfig;
// 设置反垃圾相关配置
// params.antispamConfig = antispamConfig;
// 是否开启本地反垃圾，默认false
// params.clientAntispamEnabled = false;
// 本地反垃圾的替换文本
// params.clientAntispamReplace = @"xxx";
// 设置聊天室定向消息接收者账号ID列表
// params.receiverIds = receiverIds;
// 设置消息的目标标签表达式
// params.notifyTargetTags = @"xxx";
// 设置位置信息
// params.locationInfo = locationInfo;
[service sendMessage:message
            params:params
            success:^(V2NIMSendChatroomMessageResult *result)
            {
                // 发送成功
            }
            failure:^(V2NIMError *error)
            {
                // 发送失败
            }
            progress:^(NSUInteger progress)
            {
                // 上传进度
            }];

macOS/Windows

cpp// 创建一条文本消息
auto message = V2NIMChatroomMessageCreator::createTextMessage("hello world");
auto params = V2NIMSendChatroomMessageParams();
// 发送消息
chatroomService.sendMessage(
    message,
    params,
    [](V2NIMSendChatroomMessageResult result) {
        // send message succeeded
    },
    [](V2NIMError error) {
        // send message failed, handle error
    },
    [](uint32_t progress) {
        // upload progress
    });

Web/uni-app/小程序

typescriptawait chatroom.V2NIMChatroomService.sendMessage(
    message,
    // V2NIMSendChatroomMessageParams
    {
        locationInfo: {x: 0, y: 100, z: 0}
    },
    progress: (percentage) => {console.log('上传进度: ' + percentage)}
)

Harmony

typescript// 准备代发送的消息
const msg: V2NIMChatroomMessage = this.chatroomClient.messageCreator.createTextMessage(text)
// 发送聊天室消息时的参数
const params: V2NIMSendChatroomMessageParams  = {
// 配置参数，如
locationInfo: {x: 0, y: 100, z: 0}
}
// 发送进度回调，如上传附件时由该 cb 回调
const progressCb = (percentage: number)  => {
this.messageSetProgress(imgMsg, percentage)
console.info(`onUploadProgress: ${JSON.stringify(percentage)}`)
}
// send
const msgRes: V2NIMSendChatroomMessageResult = await this.chatroomClient.chatroomService.sendMessage(msg, params, progressCb)

接收方通过 onReceiveMessages 回调收到聊天室消息。

如果是富媒体消息（图片/音频/视频/文件消息），您需要自行实现富媒体消息资源下载，富媒体消息对应的附件类为 V2NIMMessageAttachment。

（可选）如发送富媒体消息，发送后可调用 V2NIMChatroomService#cancelMessageAttachmentUpload 方法取消附件的上传。

如果附件已经上传成功，操作将会失败。如果成功取消了附件的上传，对应的消息会发送失败，消息状态是 V2NIM_MESSAGE_SENDING_STATE_FAILED(2)，附件上传状态是 V2NIM_MESSAGE_ATTACHMENT_UPLOAD_STATE_FAILED(2)。

Android

java// 通过实例ID获取聊天室实例
V2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();
v2ChatroomService.cancelMessageAttachmentUpload(v2Message, new V2NIMSuccessCallback<Void>() {
    @Override
    public void onSuccess(Void unused) {
        // 取消成功
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 取消失败
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室服务
id<V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];
[service cancelMessageAttachmentUpload:message
                            success:^{
                                // 取消成功
                            }
                            failure:^(V2NIMError *error) {
                                // 取消失败
                            }];

macOS/Windows

cppV2NIMChatroomMessage message;
// ...
chatroomService.cancelMessageAttachmentUpload(
    message,
    []() {
        // cancel message attachment upload succeeded
    },
    [](V2NIMError error) {
        // cancel message attachment upload failed, handle error
    });

Web/uni-app/小程序

typescriptawait chatroom.V2NIMChatroomService.cancelMessageAttachmentUpload(message)

Harmony

typescriptawait this.chatroomClient.chatroomService.cancelMessageAttachmentUpload(message)

聊天室空间位置消息

空间位置消息功能，用于聊天室空间坐标场景下，给指定范围内的聊天室用户发送消息，例如在游戏地图内指定范围的区域内互发消息。

预设聊天室空间位置信息

在调用 enter 方法进入聊天室时，您可以通过配置进入聊天室参数 V2NIMChatroomEnterParams 中的空间位置配置字段 locationConfig，来预设进入聊天室时的初始空间坐标位置，并且可以订阅接收指定距离内的消息。

V2NIMChatroomLocationConfig 参数说明：

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`locationInfo`	`V2NIMLocationInfo`	是	-	聊天室空间位置坐标信息，配置 x、y、z 坐标值。
`distance`	Double	是	-	订阅聊天室消息的距离

enter 方法其他参数设置及示例代码请参见聊天室登录文档。

发送聊天室空间位置消息

调用 V2NIMChatroomService#sendMessage 方法发送聊天室消息时，您可以通过配置聊天室消息发送配置参数 V2NIMSendChatroomMessageParams 中的空间位置信息字段 locationInfo，设置该消息的空间坐标信息属性。

V2NIMLocationInfo 参数说明

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称类型是否必填默认值描述

x Double 是 - 聊天室空间 x 坐标

y Double 是 - 聊天室空间 y 坐标

z Double 是 - 聊天室空间 z 坐标

名称	类型	是否必填	默认值	描述
`x`	Double	是	-	聊天室空间 x 坐标
`y`	Double	是	-	聊天室空间 y 坐标
`z`	Double	是	-	聊天室空间 z 坐标

示例代码

Android

java// 新建一个聊天室实例，注意：每次 newInstance 都会返回一个新的实例，实际使用中请一个聊天室对应一个V2NIMChatroomClient实例，使用中需要临时缓存
V2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.newInstance();
// 获取聊天室服务
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();
// 创建一条文本消息
V2NIMChatroomMessage v2Message = V2NIMChatroomMessageCreator.createTextMessage("xxx");

V2NIMChatroomMessageConfig messageConfig = new V2NIMChatroomMessageConfig();
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认true
// messageConfig.setHistoryEnabled(true);
// 设置是否是高优先级消息，默认false
// messageConfig.setHighPriority(false);

V2NIMMessageRouteConfig routeConfig = V2NIMMessageRouteConfig.V2NIMMessageRouteConfigBuilder.builder()
// 根据实际情况配置
// .withRouteEnabled()
// .withRouteEnvironment()
.build();

V2NIMMessageAntispamConfig antispamConfig = V2NIMMessageAntispamConfig.V2NIMMessageAntispamConfigBuilder.builder()
// 根据实际情况配置
// .withAntispamBusinessId()
// .withAntispamCheating()
// .withAntispamCustomMessage()
// .withAntispamEnabled()
// .withAntispamExtension()
.build();

V2NIMSendChatroomMessageParams params = new V2NIMSendChatroomMessageParams();
// 设置位置信息
// params.setLocationInfo(locationInfo);
v2ChatroomService.sendMessage(v2Message,params,
new V2NIMSuccessCallback<V2NIMSendChatroomMessageResult>() {
    @Override
    public void onSuccess(V2NIMSendChatroomMessageResult result) {
        // 发送成功
    }
},
new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 发送失败
    }
},
new V2NIMProgressCallback() {
    @Override
    public void onProgress(int progress) {
        // 发送进度
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室服务
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:instanceId] getChatroomService];
// 创建一条文本消息
V2NIMChatroomMessage *message = [V2NIMChatroomMessageCreator createTextMessage:@"xxx"];
V2NIMChatroomMessageConfig *messageConfig = [V2NIMChatroomMessageConfig new];
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认 true
// messageConfig.historyEnabled = YES;
// 设置是否是高优先级消息，默认 false
// messageConfig.highPriority = NO;
V2NIMMessageRouteConfig *routeConfig = [V2NIMMessageRouteConfig new];
// 根据实际情况配置
// routeConfig.routeEnabled
// routeConfig.routeEnvironment
V2NIMMessageAntispamConfig *antispamConfig = [V2NIMMessageAntispamConfig new];
// 根据实际情况配置
// antispamConfig.antispamBusinessId
// antispamConfig.antispamCheating
// antispamConfig.antispamCustomMessage
// antispamConfig.antispamEnabled
// antispamConfig.antispamExtension

V2NIMSendChatroomMessageParams *params = [V2NIMSendChatroomMessageParams new];
// 设置位置信息
// params.locationInfo = locationInfo;
[service sendMessage:message
            params:params
            success:^(V2NIMSendChatroomMessageResult *result)
            {
                // 发送成功
            }
            failure:^(V2NIMError *error)
            {
                // 发送失败
            }
            progress:^(NSUInteger progress)
            {
                // 上传进度
            }];

macOS/Windows

cpp// 创建一条文本消息
auto message = V2NIMChatroomMessageCreator::createTextMessage("hello world");
auto params = V2NIMSendChatroomMessageParams();
// 发送消息
chatroomService.sendMessage(
    message,
    params,
    [](V2NIMSendChatroomMessageResult result) {
        // send message succeeded
    },
    [](V2NIMError error) {
        // send message failed, handle error
    },
    [](uint32_t progress) {
        // upload progress
    });

Web/uni-app/小程序

typescriptawait chatroom.V2NIMChatroomService.sendMessage(
    message,
    // V2NIMSendChatroomMessageParams
    {
        locationInfo: {x: 0, y: 100, z: 0}
    },
    progress: (percentage) => {console.log('上传进度: ' + percentage)}
)

Harmony

typescript// 准备代发送的消息
const msg: V2NIMChatroomMessage = this.chatroomClient.messageCreator.createTextMessage(text)
// 发送聊天室消息时的参数
const params: V2NIMSendChatroomMessageParams  = {
// 配置参数，如
locationInfo: {x: 0, y: 100, z: 0}
}
// 发送进度回调，如上传附件时由该 cb 回调
const progressCb = (percentage: number)  => {
this.messageSetProgress(imgMsg, percentage)
console.info(`onUploadProgress: ${JSON.stringify(percentage)}`)
}
// send
const msgRes: V2NIMSendChatroomMessageResult = await this.chatroomClient.chatroomService.sendMessage(msg, params, progressCb)

更新聊天室空间位置信息

您可以调用 updateChatroomLocationInfo 方法更新当前在聊天室的空间坐标位置，及消息订阅范围。

V2NIMChatroomLocationConfig 参数说明

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`locationInfo`	`V2NIMLocationInfo`	是	-	聊天室空间位置坐标信息，配置 x、y、z 坐标值。
`distance`	Double	是	-	基于空间位置订阅聊天室消息的距离

示例代码

Android

javaV2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();

V2NIMChatroomLocationConfig locationConfig = new V2NIMChatroomLocationConfig();
V2NIMLocationInfo locationInfo = new V2NIMLocationInfo(0.0, 0.0, 0,0);

locationConfig.setLocationInfo(locationInfo);
locationConfig.setDistance(100);
// 以上两个字段必填，否则会返回参数错误

v2ChatroomService.updateChatroomLocationInfo(locationConfig, new V2NIMSuccessCallback<Void>() {
    @Override
    public void onSuccess(Void unused) {
        // 更新成功
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 更新失败
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室实例
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];

V2NIMChatroomLocationConfig *locationConfig = [[V2NIMChatroomLocationConfig alloc] init];
V2NIMLocationInfo *locationInfo = [[V2NIMLocationInfo alloc] init];

locationConfig.locationInfo = locationInfo;
locationConfig.distance = 100;
// 以上两个字段必填，否则会返回参数错误
[service updateChatroomLocationInfo:locationConfig
                success:^()
                {
                    // 更新成功
                }
                failure:^(V2NIMError *error)
                {
                    // 更新失败
                }];

macOS/Windows

cppV2NIMChatroomLocationConfig locationConfig;
locationConfig.locationInfo.x = 1.0;
locationConfig.locationInfo.y = 1.0;
locationConfig.locationInfo.z = 1.0;
locationConfig.distance = 100;
chatroomService.updateChatroomLocationInfo(
    locationConfig,
    []() {
        // update chatroom location info succeeded
    },
    [](V2NIMError error) {
        // update chatroom location info failed, handle error
    });

Web/uni-app/小程序

typescriptawait chatroomV2.V2NIMChatroomService.updateChatroomLocationInfo(
{
    "locationInfo": {
    "x": 33,
    "y": 44,
    "z": 55
    },
    "distance": 77
}
)

Harmony

typescriptawait this.chatroomClient.chatroomService.updateChatroomLocationInfo(
{
    "locationInfo": {
    "x": 33,
    "y": 44,
    "z": 55
    },
    "distance": 77
}
)

聊天室定向消息

聊天室定向消息功能支持发送聊天室消息给聊天室中的指定对象，而非聊天室中所有人。

调用 V2NIMChatroomService#sendMessage 方法发送聊天室消息时，您可以通过配置聊天室消息发送配置参数 V2NIMSendChatroomMessageParams 中的字段 receiverIds，指定接收定向消息的聊天室用户列表。最多支持指定 100 个用户。

定向消息不支持保存离线消息（服务端存储），若发送定向消息时接收者处于离线状态，则后续重连后也无法收到该定向消息。

示例代码如下：

Android

java// 新建一个聊天室实例，注意：每次 newInstance 都会返回一个新的实例，实际使用中请一个聊天室对应一个V2NIMChatroomClient实例，使用中需要临时缓存
V2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.newInstance();
// 获取聊天室服务
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();
// 创建一条文本消息
V2NIMChatroomMessage v2Message = V2NIMChatroomMessageCreator.createTextMessage("xxx");

V2NIMChatroomMessageConfig messageConfig = new V2NIMChatroomMessageConfig();
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认true
// messageConfig.setHistoryEnabled(true);
// 设置是否是高优先级消息，默认false
// messageConfig.setHighPriority(false);

V2NIMMessageRouteConfig routeConfig = V2NIMMessageRouteConfig.V2NIMMessageRouteConfigBuilder.builder()
// 根据实际情况配置
// .withRouteEnabled()
// .withRouteEnvironment()
.build();

V2NIMMessageAntispamConfig antispamConfig = V2NIMMessageAntispamConfig.V2NIMMessageAntispamConfigBuilder.builder()
// 根据实际情况配置
// .withAntispamBusinessId()
// .withAntispamCheating()
// .withAntispamCustomMessage()
// .withAntispamEnabled()
// .withAntispamExtension()
.build();

V2NIMSendChatroomMessageParams params = new V2NIMSendChatroomMessageParams();
// params.setReceiverIds(receiverIds);
v2ChatroomService.sendMessage(v2Message,params,
new V2NIMSuccessCallback<V2NIMSendChatroomMessageResult>() {
    @Override
    public void onSuccess(V2NIMSendChatroomMessageResult result) {
        // 发送成功
    }
},
new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 发送失败
    }
},
new V2NIMProgressCallback() {
    @Override
    public void onProgress(int progress) {
        // 发送进度
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室服务
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:instanceId] getChatroomService];
// 创建一条文本消息
V2NIMChatroomMessage *message = [V2NIMChatroomMessageCreator createTextMessage:@"xxx"];
V2NIMChatroomMessageConfig *messageConfig = [V2NIMChatroomMessageConfig new];
// 根据实际情况配置
// 设置是否需要在服务端保存历史消息，默认 true
// messageConfig.historyEnabled = YES;
// 设置是否是高优先级消息，默认 false
// messageConfig.highPriority = NO;
V2NIMMessageRouteConfig *routeConfig = [V2NIMMessageRouteConfig new];
// 根据实际情况配置
// routeConfig.routeEnabled
// routeConfig.routeEnvironment
V2NIMMessageAntispamConfig *antispamConfig = [V2NIMMessageAntispamConfig new];
// 根据实际情况配置
// antispamConfig.antispamBusinessId
// antispamConfig.antispamCheating
// antispamConfig.antispamCustomMessage
// antispamConfig.antispamEnabled
// antispamConfig.antispamExtension

V2NIMSendChatroomMessageParams *params = [V2NIMSendChatroomMessageParams new];
// 设置聊天室定向消息接收者账号ID列表
// params.receiverIds = receiverIds;
[service sendMessage:message
            params:params
            success:^(V2NIMSendChatroomMessageResult *result)
            {
                // 发送成功
            }
            failure:^(V2NIMError *error)
            {
                // 发送失败
            }
            progress:^(NSUInteger progress)
            {
                // 上传进度
            }];

macOS/Windows

cpp// 创建一条文本消息
auto message = V2NIMChatroomMessageCreator::createTextMessage("hello world");
auto params = V2NIMSendChatroomMessageParams();
// 发送消息
chatroomService.sendMessage(
    message,
    params,
    [](V2NIMSendChatroomMessageResult result) {
        // send message succeeded
    },
    [](V2NIMError error) {
        // send message failed, handle error
    },
    [](uint32_t progress) {
        // upload progress
    });

Web/uni-app/小程序

typescriptawait chatroom.V2NIMChatroomService.sendMessage(
    message,
    // V2NIMSendChatroomMessageParams
    {
        receiverIds: ["account1", "account2", "account3"]
    },
    progress: (percentage) => {console.log('上传进度: ' + percentage)}
)

Harmony

typescript// 准备代发送的消息
const msg: V2NIMChatroomMessage = this.chatroomClient.messageCreator.createTextMessage(text)
// 发送聊天室消息时的参数
const params: V2NIMSendChatroomMessageParams  = {
  // 配置参数，如
  locationInfo: {x: 0, y: 100, z: 0}
}
// 发送进度回调，如上传附件时由该 cb 回调
const progressCb = (percentage: number)  => {
  this.messageSetProgress(imgMsg, percentage)
  console.info(`onUploadProgress: ${JSON.stringify(percentage)}`)
}
// send
const msgRes: V2NIMSendChatroomMessageResult = await this.chatroomClient.chatroomService.sendMessage(msg, params, progressCb)

聊天室通知消息

在聊天室中进行部分操作会产生聊天室通知消息。

聊天室通知消息类型

目前当出现以下事件，会产生通知消息：

V2NIMChatroomMessageNotificationType	值	描述
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_ENTER	0	成员进入聊天室，可通过云信控制台聊天室子功能配置是否开启聊天室用户进出消息系统下发（默认不开启）。
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_EXIT	1	成员退出聊天室，可通过云信控制台聊天室子功能配置是否开启聊天室用户进出消息系统下发（默认不开启）。
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_BLOCK_ADDED	2	聊天室成员被加入黑名单
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_BLOCK_REMOVED	3	聊天室成员被移除黑名单
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_CHAT_BANNED_ADDED	4	聊天室成员被禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_CHAT_BANNED_REMOVED	5	聊天室成员被取消禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_ROOM_INFO_UPDATED	6	聊天室信息更新
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_KICKED	7	聊天室成员被踢
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_TEMP_CHAT_BANNED_ADDED	8	聊天室成员被临时禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_TEMP_CHAT_BANNED_REMOVED	9	聊天室成员被解除临时禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MEMBER_INFO_UPDATED	10	聊天室成员信息更新（nick/avatar/extension）
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_QUEUE_CHANGE	11	聊天室队列变更
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_CHAT_BANNED	12	聊天室处于禁言状态
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_CHAT_BANNED_REMOVED	13	聊天室处于非禁言状态
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_TAG_TEMP_CHAT_BANNED_ADDED	14	聊天室标签成员被临时禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_TAG_TEMP_CHAT_BANNED_REMOVED	15	聊天室标签成员被解除临时禁言
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_MESSAGE_REVOKE	16	聊天室消息撤回
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_TAGS_UPDATE	17	聊天室标签更新
V2NIM_CHATROOM_MESSAGE_NOTIFICATION_TYPE_ROLE_UPDATE	18	聊天室成员角色更新

支持设置成员进出聊天室通知是否下发：

应用级别：
- 云信控制台聊天室子功能配置是否开启聊天室用户进出消息系统下发（默认不开启）
- 云信控制台聊天室子功能配置是否开启聊天室用户进出消息历史存储（默认开启）
单个聊天室：调用新版服务端 API 开启/关闭进出聊天室事件通知。

聊天室通知消息解析

所有的聊天室通知消息都以 V2NIMChatroomMessage 的形式封装。聊天室通知消息的解析如下：

聊天室通知消息解析步骤如下：

通过 V2NIMChatroomMessage.messageType 判断是否为聊天室通知消息（V2NIM_MESSAGE_TYPE_NOTIFICATION）。
将 V2NIMChatroomMessage.attachment 附件对象强类型转换为 V2NIMChatroomNotificationAttachment。
通过 V2NIMChatroomNotificationAttachment.type 获取具体的通知类型 V2NIMChatroomMessageNotificationType。

根据对应的 V2NIMChatroomMessageNotificationType 的类型构造相应的展示信息：

V2NIMChatroomNotificationAttachment.operatorId：事件的操作者 ID，表示是谁主动执行了该操作。
V2NIMChatroomNotificationAttachment.targetIds：事件的被操作者 ID 列表，表示该操作的承受者。(事件类型 0、1、5、6、7、8、9、10 有该字段)

V2NIMChatroomNotificationAttachment 参数说明：

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`type`	`V2NIMChatroomMessageNotificationType`	是	-	通知类型
`targetIds`	List	否	null	被操作者账号（accountId）列表
`targetNicks`	List	否	null	被操作者昵称列表
`targetTag`	String	否	null	被操作者标签
`operatorId`	String	否	null	操作者账号（accountId）
`operatorNick`	String	否	null	操作者昵称
`notificationExtension`	String	否	null	通知扩展字段
`tags`	List	否	null	通知标签列表

聊天室历史消息

聊天室默认保存最近 10 天的聊天室历史消息，不支持保存离线消息和漫游消息。您可以在云信控制台 IM 即时通讯的聊天室子功能配置下自行设置聊天室历史消息天数。

10 天之前发送的消息附件（图片、音频、视频等），其 URL 链接地址仍有效，但不支持查询，您需要自行保存 URL。

查询聊天室历史消息

通过调用 getMessageList 方法分页获取所有聊天室历史消息，包含聊天室通知消息。

参数说明

Android

参数名称	类型	是否必填	默认值	描述
`option`	`V2NIMChatroomMessageListOption`	是	-	聊天室消息查询选项，支持查询指定时间段和消息类型的聊天室历史消息。
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 V2NIMChatroomMessage 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

iOS

参数名称	类型	是否必填	默认值	描述
`option`	`V2NIMChatroomMessageListOption`	是	-	聊天室消息查询选项，支持查询指定时间段和消息类型的聊天室历史消息。
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 `V2NIMChatroomMessage` 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

macOS/Windows

参数名称	类型	是否必填	默认值	描述
`option`	`V2NIMChatroomMessageListOption`	是	-	聊天室消息查询配置项，支持查询指定时间段和消息类型的聊天室历史消息。
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 `V2NIMChatroomMessage` 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

Web/uni-app/小程序

参数名称	类型	是否必填	默认值	描述
`option`	`V2NIMChatroomMessageListOption`	是	-	聊天室消息查询选项，支持查询指定时间段和消息类型的聊天室历史消息。

Harmony

参数名称	类型	是否必填	默认值	描述
`option`	`V2NIMChatroomMessageListOption`	是	-	聊天室消息查询选项，支持查询指定时间段和消息类型的聊天室历史消息。

V2NIMChatroomMessageListOption 参数说明：

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`messageTypes`	List<`V2NIMMessageType`>	否	null	消息类型，为 null 或空列表则表示查询所有消息类型。仅支持 0:文本，1:图片，2:语音，3:视频，4:地理位置，5:通知，6:文件，10:提示，11:Robot，100:自定义，其它为非法参数。
`beginTime`	long	否	0	查询开始时间（毫秒）。首次查询传 0，下一次查询传入上一次查询返回值中的 `beginTime`。
`limit`	int	否	100	本次查询条数上限，取值范围为 [0，200]。传入小于 0 则默认为 100。
`direction`	`V2NIMQueryDirection`	否	`V2NIM_QUERY_DIRECTION_DESC` 时间降序	查询方向（查询结果方向）：按照时间升序或降序

示例代码

Android

java// 通过实例 ID 获取聊天室实例
V2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();

V2NIMChatroomMessageListOption option = new V2NIMChatroomMessageListOption();
// 设置查询数量
option.setLimit(100);
// 设置消息查询起始时间
option.setBeginTime(0L);
// 设置消息查询方向
option.setDirection(V2NIMMessageQueryDirection.V2NIM_QUERY_DIRECTION_DESC);
// 设置查询的消息类型，如果列表为空，表示查询所有类型的消息
List<V2NIMMessageType> messageTypes = getMessageTypes();
option.setMessageTypes(messageTypes);

v2ChatroomService.getMessageList(option, new V2NIMSuccessCallback<List<V2NIMChatroomMessage>>() {
    @Override
    public void onSuccess(List<V2NIMChatroomMessage> v2NIMChatroomMessages) {
        //查询成功
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        //查询失败
    }
});

iOS

objective-c// 通过实例 ID 获取聊天室服务
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];

V2NIMChatroomMessageListOption *option = [[V2NIMChatroomMessageListOption alloc] init];
// 设置查询数量
option.limit = 100;
// 设置消息查询起始时间
option.beginTime = 0L;
// 设置消息查询方向
option.direction = V2NIM_QUERY_DIRECTION_DESC;
// 设置查询的消息类型，如果列表为空，表示查询所有类型的消息
option.messageTypes = @[
    @(V2NIM_MESSAGE_TYPE_TEXT),
    @(V2NIM_MESSAGE_TYPE_IMAGE),
    @(V2NIM_MESSAGE_TYPE_LOCATION),
    @(V2NIM_MESSAGE_TYPE_NOTIFICATION),
    @(V2NIM_MESSAGE_TYPE_FILE),
    @(V2NIM_MESSAGE_TYPE_TIP),
    @(V2NIM_MESSAGE_TYPE_CUSTOM)
];
[service getMessageList:option
                success:^(NSArray<V2NIMChatroomMessage *> *messages)
                {
                    // 查询成功
                }
                failure:^(V2NIMError *error)
                {
                    // 查询失败
                }];

macOS/Windows

cppV2NIMChatroomMessageListOption option;
option.beginTime = 0;
option.limit = 10;
chatroomService.getMessageList(
    option,
    [](nstd::vector<V2NIMChatroomMessage> messages) {
        // get message list succeeded
    },
    [](V2NIMError error) {
        // get message list failed, handle error
    });

Web/uni-app/小程序

typescriptconst messageArr = await chatroom.V2NIMChatroomService.getMessageList({
    // 0 是降序查找。从最新的消息开始查询
    direction: V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC,
    // 查询开始时间
    beginTime: 0,
    limit: 100
})

Harmony

typescriptconst messages: V2NIMChatroomMessage[] = await this.chatroomClient.chatroomService.getMessageList({
    // 0 是降序查找。从最新的消息开始查询
    direction: V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC,
    // 查询开始时间
    beginTime: 0,
    limit: 100
})

按照标签查询聊天室历史消息

通过调用 getMessageListByTag 方法按照标签信息分页获取所有聊天室历史消息，包含聊天室通知消息。

参数说明

Android

参数名称	类型	是否必填	默认值	描述
`messageOption`	`V2NIMChatroomTagMessageOption`	是	-	按标签查询聊天室消息选项
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 `V2NIMChatroomMessage` 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

iOS

参数名称	类型	是否必填	默认值	描述
`messageOption`	`V2NIMChatroomTagMessageOption`	是	-	按标签查询聊天室消息选项
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 `V2NIMChatroomMessage` 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

macOS/Windows

参数名称	类型	是否必填	默认值	描述
`messageOption`	`V2NIMChatroomTagMessageOption`	是	-	按标签查询聊天室消息选项
`success`	`V2NIMSuccessCallback`	是	-	查询成功回调，返回 `V2NIMChatroomMessage` 列表。
`failure`	`V2NIMFailureCallback`	是	-	查询失败回调，返回错误码。

Web/uni-app/小程序

参数名称	类型	是否必填	默认值	描述
`messageOption`	`V2NIMChatroomTagMessageOption`	是	-	按标签查询聊天室消息选项

Harmony

参数名称	类型	是否必填	默认值	描述
`messageOption`	`V2NIMChatroomTagMessageOption`	是	-	按标签查询聊天室消息选项

V2NIMChatroomTagMessageOption 参数说明：

如果您的应用平台为 Android，则需要调用对应的成员函数获取对应参数。

名称	类型	是否必填	默认值	描述
`tags`	List	是	-	聊天室标签信息。如果为空或 size 为 0，则返回参数错误。
`messageTypes`	List<`V2NIMMessageType`>	否	null	消息类型，为 null 或空列表则表示查询所有消息类型。
`beginTime`	long	否	0	查询开始时间。该字段必须小于等于 `endTime`。
`endTime`	long	否	0	查询结束时间。该字段必须大于等于 `beginTime`，默认为系统当前时间。
`direction`	`V2NIMQueryDirection`	否	`V2NIM_QUERY_DIRECTION_DESC`	查询方向（查询结果方向）：按照时间升序或降序
`limit`	int	否	100	本次查询条数上限。必须大于 0，否则返回 191004 参数错误。

示例代码

Android

javaV2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();

V2NIMChatroomTagMessageOption messageOption = new V2NIMChatroomTagMessageOption();
// tag 列表
List<String> tags = getTags();
// 设置查询的 tag 列表，必传字段，传 null 或者 size 为 0，会返回参数错误
messageOption.setTags(tags);
// 设置查询数量
messageOption.setLimit(100);
List<V2NIMMessageType> messageTypes = getMessageTypes();
// 设置查询的消息类型，如果列表为空，表示查询所有类型的消息
messageOption.setMessageTypes(messageTypes);
messageOption.setDirection(V2NIMMessageQueryDirection.V2NIM_QUERY_DIRECTION_DESC);
// 设置查询开始时间，首次传0，单位毫秒
messageOption.setBeginTime(0L);
// 设置查询结束时间，默认0表示当前时间，单位毫秒
messageOption.setEndTime(0L);

v2ChatroomService.getMessageListByTag(messageOption, new V2NIMSuccessCallback<List<V2NIMChatroomMessage>>() {
    @Override
    public void onSuccess(List<V2NIMChatroomMessage> v2NIMChatroomMessages) {
        // 查询成功
    }
}, new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        // 查询失败
    }
});

iOS

objective-c// 通过实例ID获取聊天室实例
id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];
V2NIMChatroomTagMessageOption *messageOption = [[V2NIMChatroomTagMessageOption alloc] init];
// 设置查询的 tag 列表，必传字段，传 null 或者 size 为 0，会返回参数错误
messageOption.tags = @[@"tag1", @"tag2"];
// 设置查询数量
messageOption.limit = 100;
// 设置查询的消息类型，如果列表为空，表示查询所有类型的消息
messageOption.messageTypes = @[@(V2NIM_MESSAGE_TYPE_TEXT), @(V2NIM_MESSAGE_TYPE_FILE)];
// 设置查询方向
messageOption.direction = V2NIM_QUERY_DIRECTION_DESC;
// 设置查询开始时间，单位秒
messageOption.beginTime = 0;
// 设置查询结束时间，默认0表示当前时间，单位秒
messageOption.endTime = 0;
[service getMessageListByTag:messageOption
                    success:^(NSArray<V2NIMChatroomMessage *> *messages)
                    {
                        // 查询成功
                    }
                    failure:^(V2NIMError *error)
                    {
                        // 查询失败
                    }];

macOS/Windows

cppV2NIMChatroomTagMessageOption messageOption;
messageOption.tags = {"tag1", "tag2"};
messageOption.limit = 10;
chatroomService.getMessageListByTag(
    messageOption,
    [](nstd::vector<V2NIMChatroomMessage> messages) {
        // get message list by tag succeeded
    },
    [](V2NIMError error) {
        // get message list by tag failed, handle error
    });

Web/uni-app/小程序

typescriptconst messages = await chatroom.V2NIMChatroomService.getMessageListByTag({
    tags: ['tag1', 'tag2'], // 查询的 tags
    limit: 100,
    direction: V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC
})

Harmony

typescriptconst messages = await this.chatroomClient.chatroomService.getMessageListByTag({
    tags: ['tag1', 'tag2'], //查询的tags
    limit: 100,
    direction: V2NIMQueryDirection.V2NIM_QUERY_DIRECTION_DESC
})

聊天室消息撤回

目前仅支持调用新版服务端 API 撤回/删除聊天室历史消息实现消息撤回功能。您需要提前注册聊天室监听器，监听聊天室消息撤回回调 onMessageRevokedNotification。

Android

javaV2NIMChatroomClient v2ChatroomClient = V2NIMChatroomClient.getInstance(instanceId);
V2NIMChatroomService v2ChatroomService = v2ChatroomClient.getChatroomService();

V2NIMChatroomListener listener = new V2NIMChatroomListener() {

    @Override
    public void onMessageRevokedNotification(String messageClientId, long messageTime) {

    }
};

v2ChatroomService.addChatroomListener(listener);

iOS

objective-c@interface Listener: NSObject<V2NIMChatroomListener>
- (void)addToService;
@end

@implementation Listener

- (void)addToService
{
    id <V2NIMChatroomService> service = [[V2NIMChatroomClient getInstance:1] getChatroomService];
    [service addChatroomListener:self];
}

- (void)onMessageRevokedNotification:(NSString *)messageClientId
                         messageTime:(NSTimeInterval)messageTime
{

}

@end

macOS/Windows

cppV2NIMChatroomListener listener;
listener.onMessageRevokedNotification = [](nstd::string messageClientId, uint64_t messageTime) {
    // handle message revoked notification
};
chatroomService.addChatroomListener(listener);

Web/uni-app/小程序

typescriptchatroom.V2NIMChatroomService.on('onMessageRevokedNotification', function (messageClientId: string, messageTime: number){})

Harmony

typescriptchatroom.chatroomService.on('onMessageRevokedNotification', (messageClientId: string, messageTime: number) => {})

前提条件

聊天室消息收发

消息流控机制

API 调用时序

实现步骤

聊天室空间位置消息

预设聊天室空间位置信息

发送聊天室空间位置消息

更新聊天室空间位置信息

聊天室定向消息

聊天室通知消息

聊天室通知消息类型

聊天室通知消息解析

聊天室历史消息

查询聊天室历史消息

按照标签查询聊天室历史消息

聊天室消息撤回

相关信息