快速实现消息收发 - IM 即时通讯

开发者中心

IM 即时通讯

集成开发

快速实现消息收发

更新时间： 2024/07/24 11:07:29

网易云信 IM 即时通讯服务提供一整套即时通讯基础能力，助您快速实现多样化的即时通讯场景。

本文主要介绍通过集成 NetEase IM SDK（NIM SDK）并调用 API，快速实现消息收发功能。

开发环境准备

兼容 Android 5.0 及以上版本。
兼容 iOS 9.0 及以上版本，可使用 iPhone/iPad 真机或模拟器。
兼容 Windows 7、Windows 8/8.1、Windows 10、macOS 10.10（仅支持 x86_64 架构，不支持 i386）。
兼容微软 IE（9+）、谷歌 Chrome（4+）、微软 Edge（12+）、Mozilla Firefox（11＋）、苹果 Safari（5+）、DCloud uni-app、微信/支付宝/百度/抖音小程序。
兼容 DevEco Studio NEXT Developer Beta1（5.0.3.300）及以上。
兼容 HarmonyOS SDK API 11 及以上，运行环境 HarnomyOS NEXT 2.1.2.5（Canary1）以上。

前提条件

已在云信控制台创建应用，获取 App Key。
已注册云信 IM 账号，获取 IM 账号和 Token。
（若使用聊天室功能）已开通和配置聊天室功能。
（若使用聊天室功能）已调用服务端接口创建聊天室。
（若使用圈组功能）已在云信控制台开通和配置圈组功能。

实现流程

流程概览

单聊/群聊消息收发

实现单聊/群聊消息收发的流程，可分为下图所示的步骤。

聊天室消息收发

实现聊天室消息收发的流程，可分为下图所示的步骤。

圈组消息收发

实现圈组消息收发的流程，可分为下图所示的步骤。

集成 SDK

各端 SDK 的集成请参考相关集成文档。

初始化 SDK

各端 SDK 的集成请参考相关集成文档。

单聊/群聊消息收发

登录 IM

客户端用户在使用云信即时通讯功能前需要先登录云信 IM 服务器。

建议参考 IM 登录最佳实践实现 IM 登录以及相应的上层应用逻辑。

调用 login 方法进行登录。以静态 Token 登录为例，示例代码如下：

Android

JavaNIMClient.getService(V2NIMLoginService.class).login("account", "token", null, new V2NIMSuccessCallback<Void>() {
    @Override
    public void onSuccess(Void unused) {
        // TODO
    }
},
    new V2NIMFailureCallback() {
    @Override
    public void onFailure(V2NIMError error) {
        int code = error.getCode();
        String desc = error.getDesc();
        // TODO
    }
});

iOS

Objective-C- (void)login
{
    NSString *accountId = @"accountId";
    NSString *token = @"token";
    [[NIMSDK sharedSDK].v2LoginService login:accountId token:token
            option:nil
                success:^{
        NSLog(@"login succ");
    }
                failure:^(V2NIMError * _Nonnull error) {
        NSLog(@"login fail: error = %@", error);
    }];
}

Windows/macOS

C++V2NIMLoginOption option;
loginService.login(
    "accountId",
    "token",
    option,
    []() {
        // login succeeded
    },
    [](V2NIMError error) {
        // login failed, handle error
    });

Web/uni-app/小程序

TypeScripttry {
    await nim1.V2NIMLoginService.login("ACCOUNT_ID", "TOKEN", {
    "forceMode": false
    })
} catch (err) {
    // TODO failed, check code
    // console.log(err.code)
}

HarmonyOS

TypeScripttry {
await nim.loginService.login("ACCOUNT_ID", "TOKEN", {
    forceMode: false
} as V2NIMLoginOption)
} catch (err) {
// TODO failed, check code
// console.log(err.code)
}

其他登录方式请参见登录登出 IM。

消息收发

本节以发送发和接收方的消息交互为例，介绍快速实现单聊消息收发的流程。更多消息类型的收发，请参见消息收发。

在创建或加入群组后，用户发送和接收消息的接口与单聊消息收发相同，区别在于会话类型（V2NIMConversationType）的参数配置，V2NIM_CONVERSATION_TYPE_TEAM(2) 为高级群，V2NIM_CONVERSATION_TYPE_SUPER_TEAM(3) 为超大群。

接收方调用 addMessageListener 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages。示例代码如下：

Android

javaV2NIMMessageService v2MessageService = NIMClient.getService(V2NIMMessageService.class);

V2NIMMessageListener messageListener = new V2NIMMessageListener() {

    @Override
    public void onReceiveMessages(List<V2NIMMessage> messages) {

    }
};
v2MessageService.addMessageListener(messageListener);

iOS

objective-c[[[NIMSDK sharedSDK] v2MessageService] addMessageListener:listener];

Windows/macOS

cppV2NIMMessageListener listener;
listener.onReceiveMessages = [](nstd::vector<V2NIMMessage> messages) {
    // receive messages
};
messageService.addMessageListener(listener);

Web/uni-app/小程序

typescriptnim.V2NIMMessageService.on("onReceiveMessages", function (messages: V2NIMMessage[]) {})

HarmonyOS

typescriptnim.messageService.on("onReceiveMessages", function (messages: V2NIMMessage[]) {})

发送方调用 createTextMessage 方法构建文本消息，然后调用 sendMessage 方法向接收方发送文本消息。示例代码如下：

Android

javaV2NIMMessageService v2MessageService = NIMClient.getService(V2NIMMessageService.class);
// 创建一条文本消息
V2NIMMessage v2Message = V2NIMMessageCreator.createTextMessage("xxx");
// 以单聊类型为例
String conversationId = V2NIMConversationIdUtil.conversationId("xxx", V2NIMConversationType.V2NIM_CONVERSATION_TYPE_P2P);
// 根据实际情况配置
V2NIMMessageAntispamConfig antispamConfig = V2NIMMessageAntispamConfig.V2NIMMessageAntispamConfigBuilder.builder()
.withAntispamBusinessId()
.withAntispamCheating()
.withAntispamCustomMessage()
.withAntispamEnabled()
.withAntispamExtension()
.build();

// 根据实际情况配置
V2NIMMessageConfig messageConfig = V2NIMMessageConfig.V2NIMMessageConfigBuilder.builder()
.withConversationUpdateEnabled()
.withHistoryEnabled()
.withOfflineEnabled()
.withOnlineSyncEnabled()
.withReadReceiptEnabled()
.withRoamingEnabled()
.withUnreadEnabled()
.build();
// 根据实际情况配置
V2NIMMessagePushConfig pushConfig = V2NIMMessagePushConfig.V2NIMMessagePushConfigBuilder.builder()
.withContent()
.withForcePush()
.withForcePushAccountIds()
.withForcePushContent()
.withPayload()
.withPushEnabled()
.withPushNickEnabled()
.build();
// 根据实际情况配置
V2NIMMessageRobotConfig robotConfig = V2NIMMessageRobotConfig.V2NIMMessageRobotConfigBuilder.builder()
.withAccountId()
.withCustomContent()
.withFunction()
.withTopic()
.build();
// 根据实际情况配置
V2NIMMessageRouteConfig routeConfig = V2NIMMessageRouteConfig.V2NIMMessageRouteConfigBuilder.builder()
.withRouteEnabled()
.withRouteEnvironment()
.build();
// 根据实际情况配置
V2NIMSendMessageParams sendMessageParams = V2NIMSendMessageParams.V2NIMSendMessageParamsBuilder.builder()
.withAntispamConfig(antispamConfig)
.withClientAntispamEnabled()
.withClientAntispamReplace()
.withMessageConfig(messageConfig)
.withPushConfig(pushConfig)
.withRobotConfig(robotConfig)
.withRouteConfig(routeConfig)
.build();
// 发送消息
v2MessageService.sendMessage(v2Message, conversationId, sendMessageParams,
new V2NIMSuccessCallback<V2NIMSendMessageResult>() {
    @Override
    public void onSuccess(V2NIMSendMessageResult v2NIMSendMessageResult) {
        // TODO: 发送成功
    },
    new V2NIMFailureCallback() {
        @Override
        public void onFailure(V2NIMError error) {
            // TODO: 发送失败
        }
    });
}

iOS

objective-c// 创建一条文本消息
V2NIMMessage *message = [V2NIMMessageCreator createTextMessage:@"v2 message"];
V2NIMSendMessageParams *params = [[V2NIMSendMessageParams alloc] init];
// 发送消息
[[[NIMSDK sharedSDK] v2MessageService] sendMessage:message 
                                    conversationId:@"conversationId"
                                            params:params
                                        success:^(V2NIMSendMessageResult * _Nonull result) {
                                            // 发送成功回调
                                            }
                                        failure:^(V2NIMError * _Nonnull error) {
                                            // 发送失败回调， error 包含错误原因
                                            }
}];

Windows/macOS

cpp// 以单聊类型为例
auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");
// 创建一条文本消息
auto message = V2NIMMessageCreator::createTextMessage("hello world");
auto params = V2NIMSendMessageParams();
// 发送消息
messageService.sendMessage(
    message,
    conversationId,
    params,
    [](V2NIMSendMessageResult result) {
        // send message succeeded
    },
    [](V2NIMError error) {
        // send message failed, handle error
    });

Web/uni-app/小程序

typescripttry {
// 创建一条文本消息
const message: V2NIMMessage = nim.V2NIMMessageCreator.createTextMessage("hello")
// 发送消息
const res: V2NIMSendMessageResult = await nim.V2NIMMessageService.sendMessage(message, 'test1|1|test2')
// todo success
} catch (err) {
// todo error
}

HarmonyOS

typescripttry {
// 创建一条文本消息
const message: V2NIMMessage = nim.messageCreator.createTextMessage("hello")
// 发送消息
const res: V2NIMSendMessageResult = await nim.messageService.sendMessage(message, 'test1|1|test2')
// todo Success
} catch (err) {
// todo error
}

目前 NIM SDK 支持多种消息类型，包括文本消息、图片消息、语音消息、视频消息、文件消息、地理位置消息、提示消息、通知消息以及自定义消息。具体请参见消息收发。

接收方通过 onReceiveMessages 回调收到文本消息。

聊天室消息收发

登录聊天室

发送方和接收方调用 newInstance 方法创建聊天室实例。调用成功后，返回聊天室实例（instanceId），聊天室实例与聊天室（roomId）形成一一绑定关系。

示例代码如下：

Android

javaV2NIMChatroomClient chatroomClient = V2NIMChatroomClient.newInstance();

iOS

objective-cV2NIMChatroomClient *chatroomClient = [V2NIMChatroomClient newInstance];

Windows/macOS

cppauto chatroomClient = V2NIMChatroomClient::newInstance();
if (!chatroomClient) {
    // create instance failed
    // ...
    return;
}
auto instanceId = chatroomClient->getInstanceId();
// save instanceId to cache
// ...

Web/uni-app/小程序

typescriptconst chatroom = V2NIMChatroomClient.newInstance(
    {
        appkey: 'YOUR_APPKEY'
    }
)

HarmonyOS

typescriptconst context: common.Context = getContext(this).getApplicationContext()
const chatroom = V2NIMChatroomClient.newInstance(context，
    {
        appkey: 'YOUR_APPKEY'
    }
)

发送方和接收方调用 addChatroomClientListener 方法注册聊天室登录相关监听器，包括聊天室连接状态变更、进出聊天室、被踢出聊天室。

示例代码如下：

Android

javachatroomClient.addChatroomClientListener(new V2NIMChatroomClientListener() {
    @Override
    public void onChatroomStatus(V2NIMChatroomStatus status, V2NIMError error) {
        
    }

    @Override
    public void onChatroomEntered() {

    }

    @Override
    public void onChatroomExited(V2NIMError error) {

    }

    @Override
    public void onChatroomKicked(V2NIMChatroomKickedInfo kickedInfo) {

    }
});

iOS

objective-c@interface ClientListener : NSObject <V2NIMChatroomClientListener>
- (void)addToClient:(NSInteger)clientId;
@end

@implementation ClientListener
- (void)addToClient:(NSInteger)clientId
{
    V2NIMChatroomClient *instance = [V2NIMChatroomClient getInstance:clientId];
    [instance addChatroomClientListener:self];
}

- (void)onChatroomStatus:(V2NIMChatroomStatus)status
                error:(nullable V2NIMError *)error
{

}
- (void)onChatroomEntered
{

}

- (void)onChatroomExited:(nullable V2NIMError *)error
{

}

- (void)onChatroomKicked:(V2NIMChatroomKickedInfo *)kickedInfo
{

}
@end

Windows/macOS

cppV2NIMChatroomClientListener listener;
listener.onChatroomStatus = [](V2NIMChatroomStatus status, nstd::optional<V2NIMError> error) {
    // handle chatroom status
};
listener.onChatroomEntered = []() {
    // handle chatroom entered
};
listener.onChatroomExited = [](nstd::optional<V2NIMError> error) {
// handle chatroom exited
};
listener.onChatroomKicked = [](V2NIMChatroomKickedInfo kickedInfo) {
    // handle chatroom kicked
};
chatroomClient.addChatroomClientListener(listener);

Web/uni-app/小程序

typescriptchatroom.on("onChatroomStatus", function (status: V2NIMChatroomStatus, err?: V2NIMError) {})
chatroom.on("onChatroomEntered", function () {})
chatroom.on("onChatroomExited", function (err?: V2NIMError) {})
chatroom.on("onChatroomKicked", function (kickedInfo: V2NIMChatroomKickedInfo) {})

HarmonyOS

typescriptconst chatroom = this.getInstance(instanceId)
chatroom.on("onChatroomStatus",  (status: V2NIMChatroomStatus, err?: V2NIMError) => {
})
chatroom.on("onChatroomEntered",  ()=> {
})
chatroom.on("onChatroomExited", (err?: V2NIMError) => {
})
chatroom.on("onChatroomKicked", (kickedInfo: V2NIMChatroomKickedInfo)=> {
})

在登录聊天室之前，需要先提前获取聊天室地址。可以通过以下两种方式获取：

若当前客户端已登录 IM，那么可以通过 getChatroomLinkAddress 方法获取指定聊天室的地址。

示例代码如下：

Android

javaNIMClient.getService(V2NIMLoginService.class).getChatroomLinkAddress("123", new V2NIMSuccessCallback<List<String>>() {
            @Override
            public void onSuccess(List<String> result) {
                // get success
            }
        }, new V2NIMFailureCallback() {
            @Override
            public void onFailure(V2NIMError error) {
                // get failed
            }
        });

iOS

objective-cNSString *roomId = @"36";
[NIMSDK.sharedSDK.v2LoginService getChatroomLinkAddress:roomId
                                                success:^(NSArray<NSString *> *links) {
                                                    // get success
                                                }
                                                failure:^(V2NIMError *error) {
                                                    // get failed
                                                }];

Windows/macOS

cpploginService.getChatroomLinkAddress(
    "roomId",
    [](nstd::vector<nstd::string> linkAddresses) {
        // handle link addresses
    },
    [](V2NIMError error) {
        // handle error
    });

Web/uni-app/小程序

typescriptconst addressArray = await nim.V2NIMLoginService.getChatroomLinkAddress('36', isMiniApp)

若当前客户端未登录 IM，那么 SDK 无法获取聊天室服务器的地址，需要客户端向开发者应用服务器请求该地址，而应用服务器需要向网易云信服务器请求，然后将请求结果原路返回给客户端。具体请参考获取聊天室地址服务端 API。

发送方和接收方调用 enter 方法登录聊天室。以静态 Token 登录为例，示例代码如下：

Android

java//创建V2NIMChatroomClient(注意：不要每次都newInstance，用完不再使用需要destroyInstance)
V2NIMChatroomClient chatroomClient = V2NIMChatroomClient.newInstance();
//获取chatroomClient的实例ID，可以缓存起来，后面通过instanceId可以得到V2NIMChatroomClient
int instanceId = chatroomClient.getInstanceId()

……

V2NIMChatroomLinkProvider chatroomLinkProvider = new V2NIMChatroomLinkProvider() {
    @Override
    public List<String> getLinkAddress(String roomId, String accountId) {
        return "聊天室Link地址";
    }
};
V2NIMChatroomEnterParams enterParams = V2NIMChatroomEnterParams.V2NIMChatroomEnterParamsBuilder.builder(chatroomLinkProvider)
.withAccountId("账号名")
.withToken("静态token")
// 按需设置      
//.withRoomNick("进入聊天室后显示的昵称")
//.withRoomAvatar("进入聊天室后显示的头像")
//.withTimeout("进入方法超时时间")
//.withServerExtension("用户扩展字段")
//.withNotificationExtension("通知扩展字段，进入聊天室通知开发者扩展字段")
//.withTagConfig("进入聊天室标签信息配置")
//.withLocationConfig("进入聊天室空间位置信息配置")
//.withAntispamConfig("用户资料反垃圾检测配置");
.build();

V2NIMChatroomClient chatroomClient = V2NIMChatroomClient.getInstance(instanceId);
if(chatroomClient != null){
    chatroomClient.enter(roomId, enterParams,
        new V2NIMSuccessCallback<V2NIMChatroomEnterResult>() {
            @Override
            public void onSuccess(V2NIMChatroomEnterResult result) {
                //进入成功
            }
        },
        new V2NIMFailureCallback() {
            @Override
            public void onFailure(V2NIMError error) {
                //进入失败
            }
        });
}

iOS

objective-c@interface V2NIMEnterChatroom: NSObject <V2NIMChatroomLinkProvider>
@end
@implementation V2NIMEnterChatroom
- (void)enter
{
NSString *roomId = @"36";
//创建V2NIMChatroomClient(注意：不要每次都newInstance，用完不再使用需要destroyInstance)
V2NIMChatroomClient *client = [V2NIMChatroomClient newInstance];
//获取chatroomClient的实例ID，可以缓存起来，后面通过instanceId可以得到V2NIMChatroomClient
NSInteger instanceId = client.getInstanceId;

V2NIMChatroomEnterParams *enterParams = [[V2NIMChatroomEnterParams alloc] init];
enterParams.linkProvider = self;
enterParams.accountId = @"账号名";
enterParams.token = @"静态token";
// 按需设置
// enterParams.roomNick: 进入聊天室后显示的昵称
// enterParams.roomAvatar: 进入聊天室后显示的头像
// enterParams.timeout: 进入方法超时时间
// enterParams.serverExtension: 用户扩展字段
// enterParams.notificationExtension: 通知扩展字段，进入聊天室通知开发者扩展字段
// enterParams.tagConfig: 进入聊天室标签信息配置
// enterParams.locationConfig: 进入聊天室空间位置信息配置
// enterParams.antispamConfig: 用户资料反垃圾检测配置

V2NIMChatroomClient *chatroomClient = [V2NIMChatroomClient getInstance:instanceId];
[chatroomClient enter:roomId
        enterParams:enterParams
            success:^(V2NIMChatroomEnterResult *result)
            {
                //进入成功
            }
            failure:^(V2NIMError *error)
            {
                    //进入失败
            }];
}

- (nullable NSArray<NSString *> *)getLinkAddress:(NSString *)roomId
                                    accountId:(NSString *)accountId
{
    return @[@"聊天室Link地址"];
}
@end

Windows/macOS

cppV2NIMChatroomEnterParams enterParams;
enterParams.accountId = "accountId";
enterParams.token = "token";
enterParams.roomNick = "nick";
enterParams.roomAvatar = "avatar";
enterParams.linkProvider = [](nstd::string roomId, nstd::string account) {
    nstd::vector<nstd::string> linkAddresses;
    // get link addresses
    // ...
    return linkAddresses;
};
enterParams.serverExtension = "server extension";
enterParams.notificationExtension = "notification extension";
chatroomClient.enter(
    "roomId",
    enterParams,
    [](V2NIMChatroomEnterResult result) {
        // enter succeeded
    },
    [](V2NIMError error) {
        // enter failed, handle error
    });

Web/uni-app/小程序

typescripttry {
    const chatroom = V2NIMChatroomClient.newInstance({
    appkey: 'YOUR_APPKEY',
    debugLevel: 'debug'
    })
    await chatroom.enter('YOUR_ROOM_ID', {
        accountId: 'YOUR_ACCOUNT_ID',
        token: 'YOUR_TOKEN'
    })      
} catch (err) {
    // TODO failed, check code
    // console.log(err.code)
}

HarmonyOS

typescripttry {
    const chatroom = V2NIMChatroomClient.newInstance({
    appkey: 'YOUR_APPKEY',
    debugLevel: 'debug'
    })
    await chatroom.enter('YOUR_ROOM_ID', {
        accountId: 'YOUR_ACCOUNT_ID',
        token: 'YOUR_TOKEN'
    })      
} catch (err) {
    // TODO failed, check code
    // console.log(err.code)
}

登录聊天室成功后，调用 getChatroomService方法获取聊天室服务。后续聊天室相关操作（聊天室成员、消息等）均在返回的 V2NIMChatroomService 类中实现。

Web/uni-app/小程序可跳过此步骤。

示例代码如下：

Android

javaV2NIMChatroomService chatroomService = chatroomClient.getChatroomService()

iOS

objective-c[[V2NIMChatroomClient getInstance:instanceId] getChatroomService];

Windows/macOS

cppauto& chatroomService = client.getChatroomService();

HarmonyOS

typescriptconst client: V2NIMChatroomClient = this.getInstance(instanceId)
const ret = client.chatroomService

消息收发

本节以发送方与接收方的消息交互为例，介绍通过 NIM SDK 快速实现聊天室消息收发的流程。

其他类型消息收发相关详情，请参见聊天室消息管理。

接收方注册聊天室监听器，监听聊天室消息接收回调事件 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

Windows/macOS

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

Web/uni-app/小程序

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

HarmonyOS

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

发送方调用 createTextMessage 方法，构建一条文本消息。并调用 sendMessage 方法，发送已构建的文本消息。

示例代码如下：

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)
            {
                // 上传进度
            }];

Windows/macOS

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)}
)

HarmonyOS

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 回调收到聊天室消息。

圈组消息收发

登录圈组

NIM SDK V10 已采用融合登录方案，用户只需要调用 V2NIMLoginService#login 方法登录一次，则可以同时使用 IM 与圈组，无需再单独登录圈组服务器。具体示例代码请参考登录 IM。

调用 V2NIMLoginService#login 后调用 QChatService#login 方法将会报错。

消息收发

Android 圈组消息收发
iOS 圈组消息收发
Windows/macOS 圈组消息收发
Web/uni-app/小程序圈组消息收发

后续步骤

为保障通信安全，如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号和 token，请确保在后续的正式生产环境中，将其替换为通过 IM 新版服务端 API 生成的正式 IM 账号和 token。

在线咨询

微信咨询

电话咨询

此文档是否对你有帮助？

有帮助

去反馈

开发环境准备
前提条件
实现流程
流程概览
集成 SDK
初始化 SDK
单聊/群聊消息收发
登录 IM
消息收发
聊天室消息收发
登录聊天室
消息收发
圈组消息收发
登录圈组
消息收发
后续步骤