IMClient 类(Web IMLib)
类继承图
继承关系:Object → IMClient。初始化方法为 SDK 唯一入口;实例由初始化接口返回,不直接 new。
类说明
IMClient 是 Web IMLib 的入口类:持有连接与事件总线,串联连接、消息、会话、用户、好友、群组、聊天室与文件上传共 62 个语义操作。方法名与 IDL 语义 op 同名,仅调用风格与常量名随平台变化。
| 项 | 值 |
|---|---|
| 程序包 | @ni-paas/im-web |
| 完整声明 | @ni-paas/im-web |
| 语言 / 运行时 | JavaScript (ESM) |
| 初始化入口 | createClient |
| 异步模型 | Promise<RcResult<T>> |
| 事件 API | addEventListener(event, handler) / removeEventListener |
| 命名约定 | camelCase,方法名与语义 op 同名 |
| 方法总数 | 103 个语义操作,本平台导出 103 个 |
| 平台状态 | 已交付 |
概要
方法按能力域分组。点击方法名跳转到详细说明;"签名"列逐字来自平台绑定的 methodMap。
连接与监听(7)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
init | constructor(options) / init(options) | 初始化 SDK(构造客户端实例) |
connect | connect(token) | 使用用户 token 建立长连接:握手→hello→离线补发→sync_done |
disconnect | disconnect() | 主动断开 |
getConnectionStatus | getConnectionStatus() | 返回 ConnectionStatus 枚举值 |
getCurrentUserId | getCurrentUserId() | 当前登录 userId |
addEventListener | addEventListener(event, handler) | 注册事件监听 |
removeEventListener | removeEventListener(event, handler) | 移除事件监听 |
消息(26)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
sendMessage | sendMessage(conversationType, targetId, content, options?) | 发送任意类型消息 |
sendTextMessage | sendTextMessage(conversationType, targetId, text, options?) | 发送文本消息 |
sendImageMessage | sendImageMessage(conversationType, targetId, content, options?) | 发送图片消息 |
sendFileMessage | sendFileMessage(conversationType, targetId, content, options?) | 发送文件消息 |
sendVoiceMessage | sendVoiceMessage(conversationType, targetId, content, options?) | 发送语音消息 |
sendLocationMessage | sendLocationMessage(conversationType, targetId, content, options?) | 发送位置消息 |
sendTypingStatus | sendTypingStatus(conversationType, targetId, typing) | 发送正在输入状态 |
recallMessage | recallMessage(messageId) | 撤回消息(仅发送者、撤回时限内) |
sendReadReceipt | sendReadReceipt(conversationType, targetId, messageIds) | 上报已读回执 |
getMessageReadCount | getMessageReadCount(messageId) | 查询消息已读人数 |
getMessageReadUsers | getMessageReadUsers(messageId, options?) | 查询已读用户明细(分页) |
getMessageReadDetail | getMessageReadDetail(messageId, options?) | 查询单条消息的已读详情:已读/未读名单 + 具体读取时间(分页) |
searchMessages | searchMessages({keyword, limit?}) | 在当前用户全部会话中搜索文本消息(倒序) |
updateMessageExpansion | updateMessageExpansion(messageId, expansion) | 更新已发送消息的扩展 KV(合并语义) |
removeMessageExpansion | removeMessageExpansion(messageId, keys) | 删除消息扩展 KV(按 key) |
addMessageReaction | addMessageReaction(params) | 为指定消息添加回应(reactionId 由业务定义,1-16 字符) |
removeMessageReaction | removeMessageReaction(params) | 移除自己对指定消息的回应 |
batchGetMessageReactionSummaries | batchGetMessageReactionSummaries(params) | 批量查询消息回应摘要(1-100 个 messageId) |
getMessageReactions | getMessageReactions(params) | 分页查询指定消息的回应列表(count 1-50,默认 20) |
getMessageReactionUsers | getMessageReactionUsers(params) | 分页查询某个回应的参与用户(count 1-50,默认 20) |
startStreamMessage | startStreamMessage(params) | 开始一条流式消息(IDL rev17) |
appendStreamMessage | appendStreamMessage(streamId, delta, options?) | 追加一个流式增量(IDL rev17) |
completeStreamMessage | completeStreamMessage(streamId) | 结束流式消息(IDL rev17) |
getStreamMessage | getStreamMessage(streamId) | 查询流式消息快照(IDL rev17) |
getMessageExpansion | getMessageExpansion(messageId: string): Promise<RcResult<MessageExpansion>> | 读取已发送消息的扩展 KV(IDL rev19) |
combineMessages | combineMessages(messages: Message[], options?: CombineMessagesOptions): Promise<RcResult<CombineContent>> | 本地构造合并转发内容(IDL rev19,transport=local,不做网络 IO):把 Message[] 转换为 `{type:'co… |
功能指南:发送消息、接收消息、消息管理、已读回执、输入状态、消息进阶
会话(22)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
getConversationList | getConversationList() | 会话列表:置顶优先、按 updatedAt 倒序 |
getConversation | getConversation(conversationType, targetId) | 单会话详情 |
getHistoryMessages | getHistoryMessages(conversationType, targetId, options?) | 历史消息分页(beforeSeq 向前翻页) |
clearUnreadCount | clearUnreadCount(conversationType, targetId) | 清空会话未读(等价 read 帧 + 本地清零) |
setConversationToTop | setConversationToTop(conversationType, targetId, isTop) | 会话置顶/取消 |
saveTextMessageDraft | saveTextMessageDraft(conversationType, targetId, draft) | 保存草稿(空串=清除) |
getTextMessageDraft | getTextMessageDraft(conversationType, targetId) | 读取草稿 |
clearTextMessageDraft | clearTextMessageDraft(conversationType, targetId) | 清除草稿 |
setConversationNotificationLevel | setConversationNotificationLevel(conversationType, targetId, level) | 会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰 |
createConversationTag | createConversationTag(tagName, options) | 创建会话标签(tagName ≤16) |
updateConversationTag | updateConversationTag(tagId, tagName) | 重命名会话标签 |
deleteConversationTag | deleteConversationTag(tagId) | 删除会话标签(同时清除标签内会话引用) |
getConversationTags | getConversationTags() | 获取全部会话标签(含会话数量) |
addConversationsToTag | addConversationsToTag(tagId, conversations) | 把会话加入标签(≤100/次,幂等) |
removeConversationsFromTag | removeConversationsFromTag(tagId, conversations) | 把会话移出标签(≤100/次,幂等) |
getConversationsFromTagByPage | getConversationsFromTagByPage(tagId, options) | 分页获取标签内会话(含置顶/未读数/最后消息时间) |
getTagsFromConversation | getTagsFromConversation(conversationType, targetId) | 查询某个会话所属的标签列表 |
getUnreadCountByTag | getUnreadCountByTag(tagId) | 标签内未读汇总(消息总数 + 有未读的会话数) |
setConversationToTopInTag | setConversationToTopInTag(tagId, conversationType, targetId, top) | 标签内置顶/取消置顶会话(同步会话会话级置顶状态) |
deleteConversation | deleteConversation(conversationType, targetId) | 删除会话记录(列表项/未读/草稿/置顶),历史消息保留 |
getConversationTypeNotification | getConversationTypeNotification(conversationType) | 查询按会话类型默认免打扰级别(0 全部 / 1 仅 @ / 2 免打扰) |
setConversationTypeNotification | setConversationTypeNotification(conversationType, level) | 设置按会话类型默认免打扰级别(0 全部 / 1 仅 @ / 2 免打扰) |
功能指南:历史消息、会话列表、未读数、草稿、置顶与免打扰、会话标签与分组、会话删除与类型免打扰
用户(10)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
getUserProfile | getUserProfile(userId) | 查询用户资料 |
updateMyUserProfile | updateMyUserProfile({name?, avatarUrl?}) | 修改本人资料(name/avatarUrl) |
getOnlineStatus | getOnlineStatus(userId) | 查询单个用户在线状态 |
getOnlineStatusBatch | getOnlineStatusBatch(userIds) | 批量在线状态(<=100) |
subscribePresence | subscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>> | 订阅用户在线状态(IDL rev20) |
unsubscribePresence | unsubscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>> | 取消订阅用户在线状态(IDL rev20) |
getPresenceSubscriptions | getPresenceSubscriptions(): Promise<RcResult<{userId: string, subscribed: string[]}>> | 查询当前用户的在线状态订阅列表(IDL rev20) |
registerPushToken | registerPushToken(options: RegisterPushTokenOptions): Promise<RcResult<PushToken>> | 注册设备推送 token(IDL rev21 C23 收口) |
unregisterPushToken | unregisterPushToken(tokenId: string): Promise<RcResult<UnregisterPushTokenResult>> | 注销本人设备推送 token(IDL rev21 C23) |
getPushTokens | getPushTokens(): Promise<RcResult<PushTokenListResult>> | 查询本人设备推送 token(IDL rev21 C23) |
功能指南:用户资料、在线状态、在线状态订阅与推送令牌
好友与黑名单(11)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
searchUsers | searchUsers(keyword, options?) | 搜索用户(userId/name,大小写不敏感,排除自己) |
sendFriendRequest | sendFriendRequest(toUserId, message?) | 发起好友申请 |
getFriendRequests | getFriendRequests(options?) | 好友申请列表(incoming/outgoing,pending/all) |
acceptFriendRequest | acceptFriendRequest(requestId) | 同意申请,双向建立好友关系 |
rejectFriendRequest | rejectFriendRequest(requestId) | 拒绝申请 |
getFriends | getFriends() | 好友列表(含备注/在线/拉黑标记) |
deleteFriend | deleteFriend(friendId) | 双向删除好友 |
setFriendRemark | setFriendRemark(friendId, remark) | 设置好友备注(<=64 字,空串清除) |
getBlacklist | getBlacklist() | 黑名单列表 |
addToBlacklist | addToBlacklist(userId) | 加入黑名单(幂等) |
removeFromBlacklist | removeFromBlacklist(userId) | 移出黑名单 |
群组(20)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
createGroup | createGroup({groupId?, name, owner?, members?, groupType?}) | 创建群(groupType 缺省 normal) |
getGroupsInfo | getGroupsInfo(groupIds) | 批量查询群信息(<=20) |
getGroupMembers | getGroupMembers(groupId) | 群成员列表(含角色/禁言) |
addGroupMembers | addGroupMembers(groupId, userIds) | 拉人入群(群主/管理员) |
removeGroupMembers | removeGroupMembers(groupId, userIds) | 移除成员(群主/管理员) |
quitGroup | quitGroup(groupId) | 退出群 |
updateGroupName | updateGroupName(groupId, name) | 修改群名(群主/管理员) |
updateGroupNotice | updateGroupNotice(groupId, notice) | 设置群公告(群主/管理员,<=500 字,空串清除) |
transferGroupOwner | transferGroupOwner(groupId, newOwner) | 转让群主(新群主须为成员) |
addGroupAdmin | addGroupAdmin(groupId, userId) | 设置管理员(群主,幂等) |
removeGroupAdmin | removeGroupAdmin(groupId, userId) | 取消管理员(群主) |
muteGroupMember | muteGroupMember(groupId, userId, mutedUntil) | 禁言/解禁(群主/管理员) |
createSupergroupChannel | createSupergroupChannel(params: CreateSupergroupChannelParams): Promise<RcResult<SupergroupChannel>> | 创建超级群频道(IDL rev21 C17) |
listSupergroupChannels | listSupergroupChannels(groupId: string): Promise<RcResult<SupergroupChannelListResult>> | 超级群频道列表(IDL rev21 C17) |
joinSupergroupChannel | joinSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<JoinSupergroupC… | 加入超级群频道(IDL rev21 C17) |
leaveSupergroupChannel | leaveSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<LeaveSupergrou… | 离开超级群频道(IDL rev21 C17) |
bindUserGroupToChannel | bindUserGroupToChannel(channelId: string, userGroupId: string, options?: SupergroupChannelOptions): Promise<Rc… | 把用户组绑定到频道(IDL rev21 C17) |
createUserGroup | createUserGroup(params: CreateUserGroupParams): Promise<RcResult<UserGroup>> | 创建超级群用户组(IDL rev21 C17) |
listUserGroups | listUserGroups(groupId: string): Promise<RcResult<UserGroupListResult>> | 超级群用户组列表(IDL rev21 C17) |
getUserGroupsByUser | getUserGroupsByUser(userId: string, options?: SupergroupChannelOptions): Promise<RcResult<UserGroupListResult>… | 查询某用户所在的所有用户组(IDL rev21 C17) |
聊天室(5)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
createChatroom | createChatroom({chatroomId?, name, owner?}) | 创建聊天室(客户端能力) |
joinChatroom | joinChatroom(chatroomId) | 加入聊天室:发送 chatroom_join,收到 chatroom_joined |
leaveChatroom | leaveChatroom(chatroomId) | 离开聊天室 |
getChatroomInfo | getChatroomInfo(chatroomId) | 聊天室信息(含在线数) |
getChatroomMembers | getChatroomMembers(chatroomId, options?) | 聊天室在线成员列表 |
系统通知(1)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
getSystemMessages | getSystemMessages(options?) | 系统通知历史(会话 conversationType=SYSTEM,targetId='system') |
功能指南:系统通知
文件上传(1)
| 方法 | 签名(本平台绑定) | 说明 |
|---|---|---|
uploadFile | uploadFile(data, name, mime?) | 上传文件(<=20MB),返回可用于图片/文件/语音消息的 url |
功能指南:文件上传
详细成员说明
连接与监听(7)
constructor(options) / init(options)初始化 SDK(构造客户端实例)。幂等:同 appkey 重复初始化返回同一实例。 可能错误码:1001 参数错误。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {appkey:string, serverUrl?:string, timeoutMs?:uint32, transport?:any} | 可选参数对象 |
IMClient 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
import { createClient } from '@ni-paas/im-web';
const client = createClient({
appkey: '<appkey>',
serverUrl: 'http://127.0.0.1:8080',
});connect(token)使用用户 token 建立长连接:握手→hello→离线补发→sync_done;成功后触发 CONNECTED。失败按协议重连策略重试。 可能错误码:1002 Token 无效或已过期、1016 账号已被封禁、1017 应用已停用、2001 服务端内部错误、2002 依赖服务不可用、3002 请求超时、3003 网络错误。 可能触发事件:CONNECTING、CONNECTED。
| 参数 | 类型 | 说明 |
|---|---|---|
token | string | 见类型定义 |
{userId:string, sessionId?:string} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.connect('<user-token>');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);disconnect()主动断开;停止重连、清理心跳与待决请求。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.disconnect();getConnectionStatus()返回 ConnectionStatus 枚举值。 可能错误码:无特定错误码(通用错误见 ErrorCode)。
ConnectionStatus 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const value = client.getConnectionStatus();
console.log(value);getCurrentUserId()当前登录 userId;未登录返回空串。 可能错误码:无特定错误码(通用错误见 ErrorCode)。
string 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const value = client.getCurrentUserId();
console.log(value);addEventListener(event, handler)注册事件监听;同一 handler 重复注册只生效一次。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 事件名,取值见 EventType |
handler | function | 事件处理函数(注册与移除需传同一引用) |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
const handler = (payload) => {
console.log(payload);
};
client.addEventListener(Events.MESSAGES, handler);removeEventListener(event, handler)移除事件监听。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
event | string | 事件名,取值见 EventType |
handler | function | 事件处理函数(注册与移除需传同一引用) |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.removeEventListener(Events.MESSAGES, handler);消息(26)
sendMessage(conversationType, targetId, content, options?)发送任意类型消息。优先走长连接;连接不可用(SUSPEND/DISCONNECTED)时按 SDK_NO_CONNECTION 失败并保留本地待发队列(可选实现)。rev23:options.channelId 用于超级群频道消息(conversationType=10),仅频道成员接收;消息模型带 channelId。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在、1006 未加入群组、1007 消息体过大(上限 5KB)、1008 发送过于频繁、1009 你已被禁言、1010 内容包含敏感词、1011 已被对方拉黑或你已拉黑对方 等 17 个。 可能触发事件:MESSAGES、CONVERSATION。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
content | Content | 消息内容体,字段见 MessageContent |
options | {clientMsgId?:string, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendMessage(ConversationType.PRIVATE, 'user_001', { type: 'text', text: 'Hello, NI PaaS!' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendTextMessage(conversationType, targetId, text, options?)发送文本消息;内部等价 sendMessage(content={type:'text',text,mentionedInfo?,quote?})。 可能错误码:1001 参数错误、1007 消息体过大(上限 5KB)、1009 你已被禁言、1010 内容包含敏感词、1011 已被对方拉黑或你已拉黑对方、3001 长连接未就绪、3002 请求超时。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
text | string | 文本消息内容(非空,序列化后 ≤ 5KB) |
options | {clientMsgId?:string, mentionedInfo?:MentionedInfo, quote?:Quote, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendTextMessage(ConversationType.PRIVATE, 'user_001', 'Hello, NI PaaS!');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendImageMessage(conversationType, targetId, content, options?)发送图片消息;url 由 uploadFile 或业务方上传得到。 可能错误码:1001 参数错误、1007 消息体过大(上限 5KB)、1009 你已被禁言、1011 已被对方拉黑或你已拉黑对方、3001 长连接未就绪。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
content | {url:string,width?:uint32,height?:uint32,size?:uint64} | 消息内容体,字段见 MessageContent |
options | {clientMsgId?:string, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendImageMessage(ConversationType.PRIVATE, 'user_001', { type: 'text', text: 'Hello, NI PaaS!' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendFileMessage(conversationType, targetId, content, options?)发送文件消息。 可能错误码:1001 参数错误、1007 消息体过大(上限 5KB)、1009 你已被禁言、1011 已被对方拉黑或你已拉黑对方、3001 长连接未就绪。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
content | {url:string,name:string,size?:uint64,mime?:string} | 消息内容体,字段见 MessageContent |
options | {clientMsgId?:string, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendFileMessage(ConversationType.PRIVATE, 'user_001', { type: 'text', text: 'Hello, NI PaaS!' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendVoiceMessage(conversationType, targetId, content, options?)发送语音消息;duration 秒 1..300。 可能错误码:1001 参数错误、1007 消息体过大(上限 5KB)、1009 你已被禁言、1011 已被对方拉黑或你已拉黑对方、3001 长连接未就绪。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
content | {url:string,duration:uint32} | 消息内容体,字段见 MessageContent |
options | {clientMsgId?:string, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendVoiceMessage(ConversationType.PRIVATE, 'user_001', { type: 'text', text: 'Hello, NI PaaS!' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendLocationMessage(conversationType, targetId, content, options?)发送位置消息;lat/lng 范围校验。 可能错误码:1001 参数错误、1007 消息体过大(上限 5KB)、1009 你已被禁言、1011 已被对方拉黑或你已拉黑对方、3001 长连接未就绪。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
content | {latitude:double,longitude:double,address?:string} | 消息内容体,字段见 MessageContent |
options | {clientMsgId?:string, channelId?:string} | 可选参数对象(可选) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendLocationMessage(ConversationType.PRIVATE, 'user_001', { type: 'text', text: 'Hello, NI PaaS!' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendTypingStatus(conversationType, targetId, typing)发送正在输入状态;不持久化;对端触发 TYPING 事件。 可能错误码:1004 用户不存在、1005 群组不存在、1006 未加入群组、1008 发送过于频繁、3001 长连接未就绪。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
typing | bool | true=正在输入,false=停止输入 |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.sendTypingStatus(ConversationType.PRIVATE, 'user_001', true);recallMessage(messageId)撤回消息(仅发送者、撤回时限内)。成功后本地与对端收到 MESSAGE_RECALLED。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1022 超过撤回时限、1023 消息已撤回、3001 长连接未就绪。 可能触发事件:MESSAGE_RECALLED、CONVERSATION。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
Message 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.recallMessage('msg_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendReadReceipt(conversationType, targetId, messageIds)上报已读回执;服务端记录唯一读者并推送给消息发送者。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、3001 长连接未就绪。 可能触发事件:READ_RECEIPT。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageIds | string[] | 消息 ID 列表 |
{messageIds:string[], readCounts?:map<string,uint32>, totalMembers?:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendReadReceipt(ConversationType.PRIVATE, 'user_001', ['msg_001']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageReadCount(messageId)查询消息已读人数。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
{messageId:string, readCount:uint32, totalMembers:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageReadCount('msg_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageReadUsers(messageId, options?)查询已读用户明细(分页)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
options | {offset?:uint32, limit?:uint32} | 可选参数对象(可选) |
{messageId:string, readCount:uint32, totalMembers:uint32, readers:UserProfile[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageReadUsers('msg_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageReadDetail(messageId, options?)查询单条消息的已读详情:已读/未读名单 + 具体读取时间(分页;filter=all|read|unread,默认 all)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
options | {offset?:uint32, limit?:uint32, filter?:string} | 可选参数对象(可选) |
{messageId:string, readCount:uint32, unreadCount:uint32, totalMembers:uint32, filter:string, offset:uint32, limit:uint32, total:uint32, hasMore:boolean, items:MessageReadDetailItem[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageReadDetail('msg_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);searchMessages({keyword, limit?})在当前用户全部会话中搜索文本消息(倒序)。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {keyword:string, limit?:uint32} | 可选参数对象 |
{messages:Message[], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.searchMessages({ keyword: 'ni' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);updateMessageExpansion(messageId, expansion)更新已发送消息的扩展 KV(合并语义)。仅单聊/群聊/超级群支持,且消息须在发送时开启可扩展;单次 ≤20 对、单条 ≤300 对,key 1-32 字符 [A-Za-z0-9+=_-]、value ≤4096。 可能错误码:1001 参数错误、1004 用户不存在、1026 消息不可扩展(发送时未开启可扩展,或会话类型不支持)、1027 消息扩展超出限制(单次 20 对 / 单条 300 对 / 键值长度)。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
expansion | Record<string,string> | 见类型定义 |
{messageId:string, expansion:Record<string,string>} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.updateMessageExpansion('msg_001', undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);removeMessageExpansion(messageId, keys)删除消息扩展 KV(按 key)。语义与融云 removeMessageExpansion 对齐:消息须可扩展,删除不存在的 key 不报错。 可能错误码:1001 参数错误、1004 用户不存在、1026 消息不可扩展(发送时未开启可扩展,或会话类型不支持)。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
keys | string[] | 见类型定义 |
{messageId:string, removed:string[], expansion:Record<string,string>} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.removeMessageExpansion('msg_001', undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);addMessageReaction(params)为指定消息添加回应(reactionId 由业务定义,1-16 字符;同一用户对同一消息同一 reactionId 重复添加视为幂等)。单条消息最多 50 种回应、每种回应最多 100 个用户。 可能错误码:1001 参数错误、1004 用户不存在、1028 回应标识非法(1-16 字符)、1029 单条消息回应种类超出上限(50)、1030 单个回应参与用户超出上限(100)。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageId | string | 消息 ID(服务端生成的 messageId) |
reactionId | string | 见类型定义 |
options | {pushConfig?:object} | 可选参数对象(可选) |
{messageId:string, reactionId:string, userId:string, reactionTime:uint64} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.addMessageReaction(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);removeMessageReaction(params)移除自己对指定消息的回应;reactionId 须与添加时一致,未添加过时返回成功(removed=false)。 可能错误码:1001 参数错误、1004 用户不存在、1028 回应标识非法(1-16 字符)。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageId | string | 消息 ID(服务端生成的 messageId) |
reactionId | string | 见类型定义 |
{messageId:string, reactionId:string, removed:boolean} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.removeMessageReaction(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);batchGetMessageReactionSummaries(params)批量查询消息回应摘要(1-100 个 messageId)。返回按 messageId 分组:每个回应含总数、当前用户是否已回应、最近参与用户(最多 10 个);不存在回应的消息返回空数组。 可能错误码:1001 参数错误、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageIds | string[] | 消息 ID 列表 |
Record<string, ReactionSummary[]>(ReactionSummary={reactionId:string,totalCount:uint32,hasCurrentUserReacted:boolean,reactionTime:uint64,users:{userId:string,reactionTime:uint64}[]}) 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.batchGetMessageReactionSummaries(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageReactions(params)分页查询指定消息的回应列表(count 1-50,默认 20;pageToken 不透明,空串表示第一页)。 可能错误码:1001 参数错误、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageId | string | 消息 ID(服务端生成的 messageId) |
options | {count?:uint32, pageToken?:string} | 可选参数对象(可选) |
{reactions:ReactionSummary[], pageToken?:string, totalCount:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageReactions(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageReactionUsers(params)分页查询某个回应的参与用户(count 1-50,默认 20;pageToken 不透明)。 可能错误码:1001 参数错误、1004 用户不存在、1028 回应标识非法(1-16 字符)。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
messageId | string | 消息 ID(服务端生成的 messageId) |
reactionId | string | 见类型定义 |
options | {count?:uint32, pageToken?:string} | 可选参数对象(可选) |
{users:{userId:string,reactionTime:uint64}[], pageToken?:string, totalCount:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageReactionUsers(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);startStreamMessage(params)开始一条流式消息(IDL rev17;客户端 REST `POST /api/apps/{appkey}/messages/stream/start`)。发送者取自用户 token;`content.text` 作为初始文本。返回 StreamMessage(streamId/messageId/status='streaming'/createdAt/text/segments),SDK 本地保留一个可增量渲染的流式占位消息。支持单聊(1)、群聊(2)、系统通知(4);聊天室(3)暂不支持(1001)。 可能错误码:1001 参数错误、1004 用户不存在、1005 群组不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
params | {conversationType:ConversationType, targetId:string, content?:Content} | 见类型定义 |
StreamMessage 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.startStreamMessage(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);appendStreamMessage(streamId, delta, options?)追加一个流式增量(IDL rev17;客户端 REST `POST /api/apps/{appkey}/messages/stream/append`),返回累计文本/分段/状态的 StreamMessage;服务端同时向会话全部在线参与者广播 `stream_changed`(complete=false)。`seq` 重复时覆盖该段(乱序安全)。仅流发送者可调用(其他人 1003);流不存在 1001、已结束 1001。 可能错误码:1001 参数错误、1003 无权限。 可能触发事件:STREAM_MESSAGE_CHANGED。
| 参数 | 类型 | 说明 |
|---|---|---|
streamId | string | 见类型定义 |
delta | string | 见类型定义 |
options | {seq?:uint32} | 可选参数对象(可选) |
StreamMessage 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.appendStreamMessage(undefined, undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);completeStreamMessage(streamId)结束流式消息(IDL rev17;客户端 REST `POST /api/apps/{appkey}/messages/stream/end`):累计文本按 start 预分配的 messageId 落库为一条普通文本消息(恰一次),随后广播 `stream_changed`(complete=true)。返回 {streamId,messageId,text,status,complete,message?}。仅流发送者可调用(1003);空文本或已结束 1001。 可能错误码:1001 参数错误、1003 无权限。 可能触发事件:STREAM_MESSAGE_CHANGED、MESSAGES。
| 参数 | 类型 | 说明 |
|---|---|---|
streamId | string | 见类型定义 |
{streamId:string, messageId:string, text:string, status:streaming|ended, complete:bool, message?:Message} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.completeStreamMessage(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getStreamMessage(streamId)查询流式消息快照(IDL rev17;客户端 REST `GET /api/apps/{appkey}/messages/stream/{streamId}`),与 append 响应同形(StreamMessage)。仅会话参与者可见(单聊双方、群成员、聊天室在线成员;其他人 1003);未知流 1001。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
streamId | string | 见类型定义 |
StreamMessage 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getStreamMessage(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getMessageExpansion(messageId: string): Promise<RcResult<MessageExpansion>>读取已发送消息的扩展 KV(IDL rev19;客户端 REST `GET /api/apps/{appkey}/messages/{messageId}/expansion`),返回 `{messageId, expansion}`;无扩展/已全部删除时 expansion 为空 map。仅会话参与者可读(非参与者 1003);未知消息 1001;单聊对端用户不存在 1004、群不存在 1005、聊天室消息 1012。只读、幂等、不触发事件(写入仍由 updateMessageExpansion / removeMessageExpansion 完成)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在、1012 聊天室不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
messageId | string | 消息 ID(服务端生成的 messageId) |
{messageId:string, expansion:Record<string,string>} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getMessageExpansion('msg_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);combineMessages(messages: Message[], options?: CombineMessagesOptions): Promise<RcResult<CombineContent>>本地构造合并转发内容(IDL rev19,transport=local,不做网络 IO):把 Message[] 转换为 `{type:'combine', title, items:[{senderId,senderName?,contentType,text?,timestamp?}]}`(`CombineContent`),随后直接 `sendMessage(conversationType, targetId, content)`。items 必须 1..=100(本地 1001);title <=64 字(缺省 `1001 参数错误。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
messages | Message[] | 见类型定义 |
options | {title?:string, senderNames?:Record<string,string>, textMaxChars?:uint32} | 可选参数对象(可选) |
CombineContent 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.combineMessages(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);会话(22)
getConversationList()会话列表:置顶优先、按 updatedAt 倒序;含未读/提及/草稿/免打扰。 可能错误码:无特定错误码(通用错误见 ErrorCode)。
Conversation[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getConversationList();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getConversation(conversationType, targetId)单会话详情。 可能错误码:1001 参数错误。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
Conversation 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getConversation(ConversationType.PRIVATE, 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getHistoryMessages(conversationType, targetId, options?)历史消息分页(beforeSeq 向前翻页);limit 默认 20 上限 100。rev23:channelId 过滤超级群频道消息(仅返回该频道消息)。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
options | {limit?:uint32, beforeSeq?:uint64, channelId?:string} | 可选参数对象(可选) |
{messages:Message[], hasMore:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getHistoryMessages(ConversationType.PRIVATE, 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);clearUnreadCount(conversationType, targetId)清空会话未读(等价 read 帧 + 本地清零)。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 可能触发事件:CONVERSATION。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.clearUnreadCount(ConversationType.PRIVATE, 'user_001');setConversationToTop(conversationType, targetId, isTop)会话置顶/取消。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
isTop | bool | true=置顶,false=取消置顶 |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.setConversationToTop(ConversationType.PRIVATE, 'user_001', true);saveTextMessageDraft(conversationType, targetId, draft)保存草稿(空串=清除)。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
draft | string | 草稿文本 |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.saveTextMessageDraft(ConversationType.PRIVATE, 'user_001', '明天见');getTextMessageDraft(conversationType, targetId)读取草稿;无草稿返回空串。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
string 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getTextMessageDraft(ConversationType.PRIVATE, 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);clearTextMessageDraft(conversationType, targetId)清除草稿。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.clearTextMessageDraft(ConversationType.PRIVATE, 'user_001');setConversationNotificationLevel(conversationType, targetId, level)会话提醒级别:0 全部 / 1 仅提及 / 2 免打扰。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
level | NotificationLevel | 提醒级别,取值见 NotificationLevel |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.setConversationNotificationLevel(ConversationType.PRIVATE, 'user_001', 2);createConversationTag(tagName, options)创建会话标签(tagName ≤16;单用户 ≤20 个,超出抛 1031)。 可能错误码:1001 参数错误、1031 单用户会话标签数超过上限(20)。
| 参数 | 类型 | 说明 |
|---|---|---|
tagName | string | 见类型定义 |
options | {tagId?:string} | 可选参数对象(可选) |
ConversationTag 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.createConversationTag(undefined, {});
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);updateConversationTag(tagId, tagName)重命名会话标签。 可能错误码:1001 参数错误、1032 标签不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
tagName | string | 见类型定义 |
ConversationTag 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.updateConversationTag(undefined, undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);deleteConversationTag(tagId)删除会话标签(同时清除标签内会话引用)。 可能错误码:1032 标签不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
void 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.deleteConversationTag(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getConversationTags()获取全部会话标签(含会话数量)。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
ConversationTag[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getConversationTags();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);addConversationsToTag(tagId, conversations)把会话加入标签(≤100/次,幂等;≤1000/标签,超出抛 1033)。 可能错误码:1001 参数错误、1032 标签不存在、1033 标签内会话数超过上限(1000)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
conversations | ConversationRef[] | 见类型定义 |
{added:int, existing:int, conversationCount:int} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.addConversationsToTag(undefined, undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);removeConversationsFromTag(tagId, conversations)把会话移出标签(≤100/次,幂等)。 可能错误码:1001 参数错误、1032 标签不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
conversations | ConversationRef[] | 见类型定义 |
{removed:int, conversationCount:int} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.removeConversationsFromTag(undefined, undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getConversationsFromTagByPage(tagId, options)分页获取标签内会话(含置顶/未读数/最后消息时间)。 可能错误码:1032 标签不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
options | {offset?:uint32, limit?:uint32} | 可选参数对象(可选) |
{total:int, items:ConversationTagConversation[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getConversationsFromTagByPage(undefined, {});
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getTagsFromConversation(conversationType, targetId)查询某个会话所属的标签列表。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
ConversationTag[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getTagsFromConversation(ConversationType.PRIVATE, 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getUnreadCountByTag(tagId)标签内未读汇总(消息总数 + 有未读的会话数)。 可能错误码:1032 标签不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
{unreadCount:int, unreadConversations:int, conversationCount:int} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getUnreadCountByTag(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);setConversationToTopInTag(tagId, conversationType, targetId, top)标签内置顶/取消置顶会话(同步会话会话级置顶状态)。 可能错误码:1001 参数错误、1034 会话不存在(标签内置顶等操作要求会话已在标签内)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tagId | string | 见类型定义 |
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
top | bool | 见类型定义 |
void 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.setConversationToTopInTag(undefined, ConversationType.PRIVATE, 'user_001', undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);deleteConversation(conversationType, targetId)删除会话记录(列表项/未读/草稿/置顶),历史消息保留;同时从标签移除;幂等。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
targetId | string | 目标 ID:单聊为对方 userId,群组为 groupId,聊天室为 chatroomId |
{removed:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.deleteConversation(ConversationType.PRIVATE, 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getConversationTypeNotification(conversationType)查询按会话类型默认免打扰级别(0 全部 / 1 仅 @ / 2 免打扰)。 可能错误码:1001 参数错误。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
{conversationType:int, level:int} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getConversationTypeNotification(ConversationType.PRIVATE);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);setConversationTypeNotification(conversationType, level)设置按会话类型默认免打扰级别(0 全部 / 1 仅 @ / 2 免打扰)。 可能错误码:1001 参数错误。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
conversationType | ConversationType | 会话类型,取值见 ConversationType |
level | int | 提醒级别,取值见 NotificationLevel |
{conversationType:int, level:int} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.setConversationTypeNotification(ConversationType.PRIVATE, 2);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);用户(10)
getUserProfile(userId)查询用户资料。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 用户 ID |
UserProfile 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getUserProfile('user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);updateMyUserProfile({name?, avatarUrl?})修改本人资料(name/avatarUrl)。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
profile | {name?:string, avatarUrl?:string} | 待更新的资料字段(name / avatarUrl) |
UserProfile 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.updateMyUserProfile({ });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getOnlineStatus(userId)查询单个用户在线状态。 可能错误码:1001 参数错误、1004 用户不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 用户 ID |
{userId:string, online:bool, sessionCount:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getOnlineStatus('user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getOnlineStatusBatch(userIds)批量在线状态(<=100)。 可能错误码:1001 参数错误。
| 参数 | 类型 | 说明 |
|---|---|---|
userIds | string[] | 用户 ID 列表 |
{items:[{userId:string,online:bool,sessionCount:uint32}]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getOnlineStatusBatch(['user_001', 'user_002']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);subscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>>订阅用户在线状态(IDL rev20;客户端 REST `POST /api/apps/{appkey}/users/{userId}/presence/subscriptions`,userId 取自当前登录用户)。被订阅用户上线/离线/被踢/注销时通过长连接收到 `presence_changed`。订阅自己 1001;目标用户不存在/属于其它 app 1004;订阅总数上限 500(超限 1001);幂等(重复订阅不重复入列)。成功返回变更后的完整订阅列表 `{subscribed:[...]}`。好友关系本身已默认订阅对方在线状态,无需额外调用。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
userIds | string[] | 用户 ID 列表 |
{subscribed:string[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.subscribePresence(['user_001', 'user_002']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);unsubscribePresence(userIds: string[]): Promise<RcResult<{subscribed: string[]}>>取消订阅用户在线状态(IDL rev20;客户端 REST `POST .../presence/subscriptions` 的 `unsubscribe` 分支)。取消未订阅的用户幂等成功(不报错);订阅自己 1001;目标用户不存在 1004。成功返回变更后的完整订阅列表 `{subscribed:[...]}`。仅停止接收该用户的实时在线状态帧,好友关系不受影响。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
userIds | string[] | 用户 ID 列表 |
{subscribed:string[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.unsubscribePresence(['user_001', 'user_002']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getPresenceSubscriptions(): Promise<RcResult<{userId: string, subscribed: string[]}>>查询当前用户的在线状态订阅列表(IDL rev20;客户端 REST `GET /api/apps/{appkey}/users/{userId}/presence/subscriptions`)→ `{userId,subscribed:[...]}`。只读、幂等、不产生事件。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
{userId:string, subscribed:string[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getPresenceSubscriptions();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);registerPushToken(options: RegisterPushTokenOptions): Promise<RcResult<PushToken>>注册设备推送 token(IDL rev21 C23 收口;客户端 REST `POST /api/apps/{appkey}/push/tokens`,服务端 rev20 已实现,本 op 补 SDK 语义面)→ PushToken。幂等键 `(userId, platform, token)`:重复注册返回既有 tokenId 并重新置 active=true;`token` 8..=512 字符、`platform` ∈ ios|android|web|huawei|xiaomi|oppo|vivo|fcm、未知平台/长度非法 1001、每用户 20 个活跃 token 上限(超限 1001)、注销/封禁用户 1016;同一 (platform, token) 被其它用户注册时旧记录置 active=false(设备换绑)。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1016 账号已被封禁。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {platform:string, token:string, deviceId?:string, appVersion?:string} | 可选参数对象 |
PushToken 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.registerPushToken({});
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);unregisterPushToken(tokenId: string): Promise<RcResult<UnregisterPushTokenResult>>注销本人设备推送 token(IDL rev21 C23;客户端 REST `DELETE /api/apps/{appkey}/push/tokens/{tokenId}`):软删除 active=false 并保留历史供审计 → `{tokenId,userId,platform,deleted,active:false,alreadyInactive}`。非本人或不存在 1001(不泄露他人 token);重复注销幂等成功(alreadyInactive=true)。 可能错误码:1001 参数错误、1002 Token 无效或已过期。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
tokenId | string | 见类型定义 |
{tokenId:string, userId:string, platform:string, deleted:bool, active:bool, alreadyInactive:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.unregisterPushToken('value');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getPushTokens(): Promise<RcResult<PushTokenListResult>>查询本人设备推送 token(IDL rev21 C23;客户端 REST `GET /api/apps/{appkey}/push/tokens`)→ `{userId,tokens:[PushToken],total,activeTotal,platforms}`;含 active=false 历史,按 createdAt 倒序。只读、幂等、不产生事件。 可能错误码:1001 参数错误、1002 Token 无效或已过期。 该操作幂等:重复调用不会产生额外副作用。
{userId:string, tokens:PushToken[], total:uint32, activeTotal:uint32, platforms:string[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getPushTokens();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);好友与黑名单(11)
searchUsers(keyword, options?)搜索用户(userId/name,大小写不敏感,排除自己)。 可能错误码:1001 参数错误。
| 参数 | 类型 | 说明 |
|---|---|---|
keyword | string | 搜索关键字 |
options | {limit?:uint32} | 可选参数对象(可选) |
{users:[{userId:string,name:string,isFriend:bool,blacklisted:bool}], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.searchUsers('ni');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);sendFriendRequest(toUserId, message?)发起好友申请;已是好友/已有 pending → 1003;被拉黑 → 1011。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1011 已被对方拉黑或你已拉黑对方。 可能触发事件:FRIEND_EVENT。
| 参数 | 类型 | 说明 |
|---|---|---|
toUserId | string | 接收方 userId |
message | string | 附言 / 消息摘要(可选) |
FriendRequest 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.sendFriendRequest('user_002');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getFriendRequests(options?)好友申请列表(incoming/outgoing,pending/all)。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {type?:'incoming'|'outgoing', status?:'pending'|'all'} | 可选参数对象(可选) |
FriendRequest[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getFriendRequests();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);acceptFriendRequest(requestId)同意申请,双向建立好友关系。 可能错误码:1001 参数错误、1003 无权限。 可能触发事件:FRIEND_EVENT。
| 参数 | 类型 | 说明 |
|---|---|---|
requestId | string | 好友请求 ID(requestId) |
FriendRequest 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.acceptFriendRequest('request_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);rejectFriendRequest(requestId)拒绝申请。 可能错误码:1001 参数错误、1003 无权限。 可能触发事件:FRIEND_EVENT。
| 参数 | 类型 | 说明 |
|---|---|---|
requestId | string | 好友请求 ID(requestId) |
FriendRequest 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.rejectFriendRequest('request_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getFriends()好友列表(含备注/在线/拉黑标记)。 可能错误码:无特定错误码(通用错误见 ErrorCode)。
[{userId:string,name?:string,avatarUrl?:string,remark?:string,online?:bool,blacklisted?:bool}] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getFriends();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);deleteFriend(friendId)双向删除好友。 可能错误码:1001 参数错误、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
friendId | string | 好友 userId |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.deleteFriend('user_002');setFriendRemark(friendId, remark)设置好友备注(<=64 字,空串清除)。 可能错误码:1001 参数错误、1003 无权限。
| 参数 | 类型 | 说明 |
|---|---|---|
friendId | string | 好友 userId |
remark | string | 好友备注名 |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.setFriendRemark('user_002', '同事');getBlacklist()黑名单列表。 可能错误码:无特定错误码(通用错误见 ErrorCode)。
[{userId:string,name?:string}] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getBlacklist();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);addToBlacklist(userId)加入黑名单(幂等;不能拉黑自己→1001)。 可能错误码:1001 参数错误、1004 用户不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 用户 ID |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.addToBlacklist('user_001');removeFromBlacklist(userId)移出黑名单。 可能错误码:无特定错误码(通用错误见 ErrorCode)。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 用户 ID |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.removeFromBlacklist('user_001');群组(20)
createGroup({groupId?, name, owner?, members?, groupType?})创建群(groupType 缺省 normal;joinPolicy 缺省 open;maxMembers 对 super 有效)。groupId 可由调用方指定(唯一)或服务端生成。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1015 成员数量超出上限、1021 服务未开通。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {groupId?:string, name:string, owner?:string, members?:string[], groupType?:GroupType, joinPolicy?:JoinPolicy, maxMembers?:int} | 可选参数对象 |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.createGroup({ name: 'sample.png' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getGroupsInfo(groupIds)批量查询群信息(<=20)。 可能错误码:1001 参数错误。
| 参数 | 类型 | 说明 |
|---|---|---|
groupIds | string[] | 群组 ID 列表 |
Group[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getGroupsInfo(['group_001']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getGroupMembers(groupId)群成员列表(含角色/禁言)。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在、1006 未加入群组。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
GroupMember[] 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getGroupMembers('group_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);addGroupMembers(groupId, userIds)拉人入群(群主/管理员;普通成员按配置)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在、1015 成员数量超出上限。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
userIds | string[] | 用户 ID 列表 |
{added:string[], group:Group} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.addGroupMembers('group_001', ['user_001', 'user_002']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);removeGroupMembers(groupId, userIds)移除成员(群主/管理员;权限检查)。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在、1006 未加入群组。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
userIds | string[] | 用户 ID 列表 |
{removed:string[]} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.removeGroupMembers('group_001', ['user_001', 'user_002']);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);quitGroup(groupId)退出群;群主需先转让。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在、1006 未加入群组。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.quitGroup('group_001');updateGroupName(groupId, name)修改群名(群主/管理员)。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
name | string | 名称(群名称 / 文件名等) |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.updateGroupName('group_001', 'sample.png');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);updateGroupNotice(groupId, notice)设置群公告(群主/管理员,<=500 字,空串清除)。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
notice | string | 群公告 |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.updateGroupNotice('group_001', '欢迎加入群聊');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);transferGroupOwner(groupId, newOwner)转让群主(新群主须为成员)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
newOwner | string | 新群主 userId |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.transferGroupOwner('group_001', 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);addGroupAdmin(groupId, userId)设置管理员(群主,幂等)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
userId | string | 用户 ID |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.addGroupAdmin('group_001', 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);removeGroupAdmin(groupId, userId)取消管理员(群主)。 可能错误码:1001 参数错误、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
userId | string | 用户 ID |
Group 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.removeGroupAdmin('group_001', 'user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);muteGroupMember(groupId, userId, mutedUntil)禁言/解禁(群主/管理员;不能禁言群主;管理员不能禁言管理员)。 可能错误码:1001 参数错误、1003 无权限、1004 用户不存在、1005 群组不存在、1006 未加入群组。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
userId | string | 用户 ID |
mutedUntil | uint64 | 禁言截止时间(epoch ms) |
{groupId:string,userId:string,mutedUntil:uint64,group:Group} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.muteGroupMember('group_001', 'user_001', Date.now() + 3_600_000);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);createSupergroupChannel(params: CreateSupergroupChannelParams): Promise<RcResult<SupergroupChannel>>创建超级群频道(IDL rev21 C17;客户端 REST `POST /api/apps/{appkey}/supergroup/channels`)→ SupergroupChannel。channelId 服务端生成(`ch_1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在、1015 成员数量超出上限。
| 参数 | 类型 | 说明 |
|---|---|---|
params | {groupId:string, name:string, type:ChannelType, joinPolicy?:JoinPolicy} | 见类型定义 |
SupergroupChannel 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.createSupergroupChannel(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);listSupergroupChannels(groupId: string): Promise<RcResult<SupergroupChannelListResult>>超级群频道列表(IDL rev21 C17;客户端 REST `GET /api/apps/{appkey}/supergroup/channels?groupId=`)→ `{groupId,channels:[SupergroupChannel],total}`。仅群成员可读(否则 1003),群不存在 1005,缺 groupId 1001。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
{groupId:string, channels:SupergroupChannel[], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.listSupergroupChannels('group_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);joinSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<JoinSupergroupChannelResult>>加入超级群频道(IDL rev21 C17;客户端 REST `POST .../supergroup/channels/{channelId}/join`,幂等)→ `{groupId,channelId,userId,joined:true,alreadyJoined}`。public 频道群成员可直接加入;private 频道需已受邀或为群主/管理员(否则 1003)。频道不存在 1005;channelId 跨群同名时可通过第二参数 `{groupId}` 消歧(未消歧 1001);非群成员 1003。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
channelId | string | 见类型定义 |
options | {groupId?:string} | 可选参数对象(可选) |
{groupId:string, channelId:string, userId:string, joined:bool, alreadyJoined:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.joinSupergroupChannel('value');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);leaveSupergroupChannel(channelId: string, options?: SupergroupChannelOptions): Promise<RcResult<LeaveSupergroupChannelResult>>离开超级群频道(IDL rev21 C17;客户端 REST `POST .../supergroup/channels/{channelId}/leave`,幂等)→ `{groupId,channelId,userId,left:true,wasMember}`;不在频道内也返回成功(wasMember=false)。频道不存在 1005、非群成员 1003。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
channelId | string | 见类型定义 |
options | {groupId?:string} | 可选参数对象(可选) |
{groupId:string, channelId:string, userId:string, left:bool, wasMember:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.leaveSupergroupChannel('value');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);bindUserGroupToChannel(channelId: string, userGroupId: string, options?: SupergroupChannelOptions): Promise<RcResult<BindUserGroupToChannelResult>>把用户组绑定到频道(IDL rev21 C17;客户端 REST `POST .../supergroup/channels/{channelId}/usergroups`,幂等)→ `{groupId,channelId,userGroupId,bound:true,reverseIndexed}`。**双向维护** SupergroupChannel.userGroupIds 与 UserGroup.channelIds(rev21 修复 rev7 仅写频道侧导致的反向索引缺失),因此 `listUserGroups`/`getUserGroupsByUser` 的 channelIds 反查可用。仅群主/管理员(否则 1003);频道/用户组不存在 1005。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
channelId | string | 见类型定义 |
userGroupId | string | 见类型定义 |
options | {groupId?:string} | 可选参数对象(可选) |
{groupId:string, channelId:string, userGroupId:string, bound:bool, reverseIndexed:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.bindUserGroupToChannel('value', 'value');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);createUserGroup(params: CreateUserGroupParams): Promise<RcResult<UserGroup>>创建超级群用户组(IDL rev21 C17;客户端 REST `POST /api/apps/{appkey}/supergroup/usergroups`)→ UserGroup。userGroupId 服务端生成(`ug_1001 参数错误、1002 Token 无效或已过期、1003 无权限、1004 用户不存在、1015 成员数量超出上限。
| 参数 | 类型 | 说明 |
|---|---|---|
params | {groupId:string, name:string, members?:string[]} | 见类型定义 |
UserGroup 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.createUserGroup(undefined);
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);listUserGroups(groupId: string): Promise<RcResult<UserGroupListResult>>超级群用户组列表(IDL rev21 C17;客户端 REST `GET /api/apps/{appkey}/supergroup/usergroups?groupId=`)→ `{groupId,userGroups:[UserGroup],total}`;UserGroup.channelIds 为频道反向索引(rev21 修复后可用)。仅群成员可读(否则 1003),群不存在 1005,缺 groupId 1001。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限、1005 群组不存在。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
groupId | string | 群组 ID |
{groupId:string, userGroups:UserGroup[], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.listUserGroups('group_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getUserGroupsByUser(userId: string, options?: SupergroupChannelOptions): Promise<RcResult<UserGroupListResult>>查询某用户所在的所有用户组(IDL rev21 C17;客户端 REST `GET .../supergroup/usergroups/by-user/{userId}`)→ `{userId,userGroups:[UserGroup],total}`。仅本人可查(userId ≠ 当前登录用户 1003);`options.groupId` 可限定单个群;只返回「本人确实在该群」的用户组(群已删除的不返回,不虚构)。 可能错误码:1001 参数错误、1002 Token 无效或已过期、1003 无权限。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
userId | string | 用户 ID |
options | {groupId?:string} | 可选参数对象(可选) |
{userId:string, userGroups:UserGroup[], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getUserGroupsByUser('user_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);聊天室(5)
createChatroom({chatroomId?, name, owner?})创建聊天室(客户端能力;服务端 Open API 亦可创建)。chatroomId 可指定或服务端生成。 可能错误码:1001 参数错误、1003 无权限、1015 成员数量超出上限、1021 服务未开通。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {chatroomId?:string, name:string, owner?:string} | 可选参数对象 |
Chatroom 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.createChatroom({ name: 'sample.png' });
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);joinChatroom(chatroomId)加入聊天室:发送 chatroom_join,收到 chatroom_joined;房内广播 member_changed。 可能错误码:1001 参数错误、1012 聊天室不存在、1013 聊天室已销毁、3001 长连接未就绪。 可能触发事件:CHATROOM_EVENT。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 聊天室 ID |
Chatroom 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.joinChatroom('chatroom_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);leaveChatroom(chatroomId)离开聊天室。 可能错误码:1001 参数错误、1012 聊天室不存在、3001 长连接未就绪。 可能触发事件:CHATROOM_EVENT。 该操作幂等:重复调用不会产生额外副作用。
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 聊天室 ID |
void / null 无业务返回值;失败时通过返回信封 code 或回调错误对象表达。
client.leaveChatroom('chatroom_001');getChatroomInfo(chatroomId)聊天室信息(含在线数)。 可能错误码:1001 参数错误、1012 聊天室不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 聊天室 ID |
Chatroom 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getChatroomInfo('chatroom_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);getChatroomMembers(chatroomId, options?)聊天室在线成员列表。 可能错误码:1001 参数错误、1012 聊天室不存在。
| 参数 | 类型 | 说明 |
|---|---|---|
chatroomId | string | 聊天室 ID |
options | {offset?:uint32,limit?:uint32} | 可选参数对象(可选) |
{members:ChatroomMember[], total:uint32} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getChatroomMembers('chatroom_001');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);系统通知(1)
getSystemMessages(options?)系统通知历史(会话 conversationType=SYSTEM,targetId='system')。 可能错误码:1001 参数错误。
| 参数 | 类型 | 说明 |
|---|---|---|
options | {limit?:uint32,beforeSeq?:uint64} | 可选参数对象(可选) |
{messages:Message[], hasMore:bool} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.getSystemMessages();
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);文件上传(1)
uploadFile(data, name, mime?)上传文件(<=20MB),返回可用于图片/文件/语音消息的 url。 可能错误码:1001 参数错误、1003 无权限、1007 消息体过大(上限 5KB)。
| 参数 | 类型 | 说明 |
|---|---|---|
data | bytes|blob | 文件二进制内容 |
name | string | 名称(群名称 / 文件名等) |
mime | string | 文件 MIME 类型(可选) |
{url:string,name:string,size:uint64,mime:string,fullUrl?:string} 成功时返回上述类型;失败时返回信封 code(RcResult 泛型信封)或回调错误对象。
const res = await client.uploadFile(new Uint8Array([1, 2, 3]), 'sample.png');
if (res.code !== 0) {
console.error(res.code, res.msg);
}
console.log(res.data);相关链接
- 本包:@ni-paas/im-web;类列表:类
- 数据结构:Chatroom(数据结构)、ChatroomMember(数据结构)、Conversation(数据结构)、Events(监听器)、Friend(数据结构)、FriendRequest(数据结构)、Group(数据结构)、GroupMember(数据结构)、全部
- 枚举:ChatroomEventKind(聊天室事件类型)、ConnectionStatus(连接状态)、ContentType(消息内容类型)、ConversationType(会话类型)、Direction(消息方向)、ErrorCode(错误码)、EventType(事件类型)、FriendEventKind(好友事件类型)、全部
- 错误码:ErrorCode;事件:Events
- 已过时 API:已过时 API;索引:索引