浏览 SDKs · WASM
平台
SDKsWASM

创建 @ 消息

使用 WASM SDK 创建群聊 @ 文本消息。

复制

参数说明

参数类型是否必填说明
textstring是消息正文;建议使用稳定的 @userID 标记。
atUserIDListstring[]是被提及用户 ID;@ 全体时先调用 getAtAllTag() 获取专用标记。
atUsersInfoAtUserInfo[]否用户 ID 与群内展示名信息。
messageMessageItem否被引用的原消息。
const { data: message } = await openimsdk.createTextAtMessage({
  text: '@user_a 请确认',
  atUserIDList: ['user_a'],
  atUsersInfo: [{ atUserID: 'user_a', groupNickname: 'Alex' }],
});

接口调用成功后返回待发送的 MessageItem 对象。该类型消息仅支持投递至群聊会话;创建方法仅在本地构建对象,不会改变会话的 @ 状态,亦不会触发新消息推送事件。

提及全体成员

在实现“@所有人”功能时,请勿在前端代码中硬编码字符串,应先调用 getAtAllTag() 接口获取服务端约定的全体成员标记,再将其写入正文与 atUserIDList:

const { data: atAllTag } = await openimsdk.getAtAllTag();
const { data: message } = await openimsdk.createTextAtMessage({
  text: `${atAllTag} 请查看群公告`,
  atUserIDList: [atAllTag],
});

getAtAllTag() 返回当前 SDK 约定的全体标记字符串;该调用为轻量本地方法,不发起网络请求,亦不触发任何事件。