API参考
基础函数
初始化IM
IMSDK.initSDK({
sdkServer: sdkServer,
dataDir: dbPath,
logLevel: LogLevel.Info,
logFilePath: logPath,
})
-
参数:
参数 类型 说明 sdkServer string SDK服务器地址 dataDir string 数据存储路径 logLevel LogLevel 日志等级 logFilePath string 日志文件存储路径 -
返回值: SDK,全局唯一实例
- 示例代码
import IMSDK, { LogLevel } from "crimsdk";
const isInit = IMSDK.initSDK({
sdkServer: sdkServer,
dataDir: dbPath,
logLevel: LogLevel.Info,
logFilePath: logPath,
});
- 补充说明:
配置参数仅首次调用接口时有效
反初始化IM
IMSDK.unInitSDK()
- 返回值: void
- 示例代码
IMSDK.unInitSDK();
获取SDK版本号
IMSDK.getSdkVersion()
- 返回值: SDK版本号(String)
- 示例代码
const version = IMSDK.getSdkVersion();
console.log(version);
登录
登录
IMSDK.login({
userID: string;
appId?: string;
appSecret?: string;
token?: string;
}, operationID?: string)
-
参数:
参数 类型 说明 userID string 从业务服务器取到的用户ID appId string APP ID 可在管理后台,【项目管理】获取,使用token登录时不传 appSecret string APP Secret 可在管理后台,【项目管理】获取,MD5后的值,使用token登录时不传 token string token生成器返回的token,使用appid登录时不传 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.login({
userID: 'xxxx',
appId: 'appId',
appSecret: 'md5(appSecret)',
token: 'token'
})
- 补充说明:
(appId, appSecret)和token参数二选一
相关回调请参考:
获取登录状态
IMSDK.getLoginStatus(operationID?: string)
- 返回值: LoginStatus
- 示例代码
const loginStatus = IMSDK.getLoginStatus();
获取当前已登录用户的userID
IMSDK.getLoginUserID()
- 返回值: string
- 示例代码
const userID = IMSDK.getLoginUserID();
登出
IMSDK.logout(operationID?: string)
- 返回值: Promise
- 示例代码
IMSDK.logout();
SDK 连接服务器失败
IMSDK.on(IMEvents.OnConnectFailed, () => {})
SDK 已经成功连接到服务器
IMSDK.on(IMEvents.OnConnectSuccess, () => {})
SDK 正在连接到服务器
IMSDK.on(IMEvents.OnConnecting, () => {})
当前用户被踢下线
IMSDK.on(IMEvents.OnKickedOffline, () => {})
- 详情: 自己被踢下线,此时 UI 可以提示用户
token过期通知
IMSDK.on(IMEvents.OnUserTokenExpired, () => {})
登录所用Token无效通知
IMSDK.on(IMEvents.OnUserTokenInvalid, () => {})
用户
查询用户信息
IMSDK.getUsersInfo(arr: string[], operationID?: string)
-
详情: 根据userID批量查询用户信息
-
参数:
参数 类型 说明 arr array 需要查询的userID列表 -
返回值: Promise<ResponseData<FriendUserItem[]>>
- 示例代码
const {data: userInfoList} = await IMSDK.getUsersInfo(["userID1","userID2"]);
const user1 = userInfoList[0];
修改当前登录用户信息
IMSDK.setSelfInfo(info: Partial<SelfUserInfo>, operationID?: string)
-
参数:
参数 类型 说明 info Partial<SelfUserInfo> 用户信息结构体 -
返回值: Promise
- 示例代码
await IMSDK.setSelfInfo({
nickname: '修改后的昵称'
});
相关回调请参考:
获取当前登录用户信息
IMSDK.getSelfUserInfo(operationID?: string)
- 返回值: Promise<ResponseData<SelfUserInfo>>
- 示例代码
const {data: selfUserInfo} = await IMSDK.getSelfUserInfo();
console.log(selfUserInfo);
订阅指定用户的在线状态
IMSDK.subscribeUsersStatus(userIDList: string[], operationID?: string)
-
参数:
参数 类型 说明 userIDList array 用户ID列表 -
返回值: Promise<ResponseData<UserOnlineState[]>>
- 示例代码
const {data: userOnlineStateList} = await IMSDK.subscribeUsersStatus(["userID1","userID2"]);
取消订阅用户的在线状态
IMSDK.unsubscribeUsersStatus(userIDList: string[], operationID?: string)
-
参数:
参数 类型 说明 userIDList array 用户ID列表 -
返回值: Promise<ResponseData<UserOnlineState[]>>
- 示例代码
const {data: userOnlineStateList} = await IMSDK.unsubscribeUsersStatus(["userID1","userID2"]);
获取所有已订阅用户的在线状态
IMSDK.getSubscribeUsersStatus(operationID?: string)
- 返回值: Promise<ResponseData<UserOnlineState[]>>
- 示例代码
const {data: userOnlineStateList} = await IMSDK.getSubscribeUsersStatus();
获取指定用户的在线状态
IMSDK.getUserStatus(userIDList: string[], operationID?: string)
-
参数:
参数 类型 说明 userIDList array 用户ID列表 -
返回值: Promise<ResponseData<UserOnlineState[]>>
- 示例代码
const {data: userOnlineStateList} = await IMSDK.getUserStatus(["userID1","userID2"]);
个人信息变更通知
IMSDK.on(IMEvents.OnSelfInfoUpdated, ({ data }) => {
console.log(data);
});
- 参数:
参数 类型 说明 data SelfUserInfo 用户状态
用户状态改变
IMSDK.on(IMEvents.OnUserStatusChanged, ({ data }) => {
console.log(data);
});
- 参数:
参数 类型 说明 data UserOnlineState 用户状态
会话
获取会话列表
IMSDK.getAllConversationList()
- 返回值: Promise<ResponseData<ConversationInfo[]>>
- 示例代码
const { data } = await IMSDK.getAllConversationList();
分页获取会话列表
IMSDK.getConversationListSplit({
offset: number;
count: number;
})
-
参数:
参数 类型 说明 offset number 起始偏移量 count number 拉取会话的数量 -
返回值: Promise<ResponseData<ConversationInfo[]>>
- 示例代码
const {data: conversationList} = await IMSDK.getConversationListSplit({
offset: 0,
count: 20,
})
获取单个会话
IMSDK.getOneConversation({
sourceID: string;
sessionType: ConversationType;
})
-
详情: 获取一个会话,如果不存在会自动创建
-
参数:
参数 类型 说明 sourceID number 单聊为用户ID,群聊为群ID sessionType ConversationType 会话的类型 -
返回值: Promise<ResponseData<ConversationInfo>>
- 示例代码
const { data: conversationInfo } = await IMSDK.getOneConversation({
sourceID: 'userID',
sessionType: 1,
})
获取多个会话列表
IMSDK.getMultipleConversation(ids: string[])
-
参数:
参数 类型 说明 ids array 会话ID列表 -
返回值: Promise<ResponseData<ConversationInfo[]>>
- 示例代码
const {data: conversationList} = await IMSDK.getMultipleConversation(["conversationID1","conversationID2"])
本地删除一个会话
IMSDK.deleteConversationAndDeleteAllMsg(id: string)
-
参数:
参数 类型 说明 id string 会话ID -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.deleteConversationAndDeleteAllMsg('conversationID')
清空一个会话
IMSDK.clearConversationAndDeleteAllMsg(id: string)
-
参数:
参数 类型 说明 id string 会话ID -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.clearConversationAndDeleteAllMsg("conversationID")
设置会话的草稿
IMSDK.setConversationDraft({
conversationID: string;
draftText: string;
})
-
参数:
参数 类型 说明 conversationID string 会话ID draftText string 草稿文本,如果为""则为删除草稿 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.setConversationDraft({
conversationID: 'conversationID',
draftText: 'draft',
})
置顶会话
IMSDK.pinConversation({
conversationID: string;
isPinned: boolean;
})
-
参数:
参数 类型 说明 conversationID string 会话ID isPinned boolean true为置顶,false为取消置顶 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.pinConversation({
conversationID: 'conversationID',
isPinned: true,
})
获取总的消息未读数
IMSDK.getTotalUnreadMsgCount()
- 返回值: Promise<ResponseData<number>>
- 示例代码
const { data: unreadMsgCount } = await IMSDK.getTotalUnreadMsgCount();
标记所有会话已读
IMSDK.markAllConversationMsgAsRead()
- 返回值: Promise<ResponseData>
- 示例代码
await IMSDK.markAllConversationMsgAsRead()
相关回调请参考:
标记会话已读
IMSDK.markConversationMsgAsRead(conversationID: string)
-
参数:
参数 类型 说明 conversationID string 会话ID -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.markConversationMsgAsRead('conversationID')
相关回调请参考:
设置会话免打扰状态
IMSDK.setConversationRecvMsgOpt({
conversationID: string;
opt: MessageReceiveOptType;
})
-
参数:
参数 类型 说明 conversationID string 会话ID opt MessageReceiveOptType 消息接收设置 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.setConversationRecvMsgOpt({
conversationID: "conversationID",
opt: 2,
});
相关回调请参考:
设置私聊
IMSDK.setConversationPrivateChat({
conversationID: string;
isPrivate: boolean;
})
-
参数:
参数 类型 说明 conversationID string 会话ID isPrivate boolean 是否为私聊 burnDuration Number 阅后即焚时间间隔(秒) -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.setConversationPrivateChat({
conversationID: "conversationID",
isPrivate: true,
burnDuration: 30,
})
- 补充说明:
可做“阅后即焚”功能
相关回调请参考:
重置at标准位
IMSDK.resetConversationGrpAtType(conversationID: string)
-
参数:
参数 类型 说明 conversationID string 会话ID -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.resetConversationGrpAtType('conversationID')
隐藏指定会话
IMSDK.hideConversation(conversationID: string)
-
参数:
参数 类型 说明 conversationID string 会话ID -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.hideConversation('conversationID')
- 补充说明:
不删除聊天记录;如果有新消息到达,会话会再次出现。
隐藏所有会话
IMSDK.hideAllConversations()
- 返回值: Promise<ResponseData>
- 示例代码
await IMSDK.hideAllConversations()
- 补充说明:
不删除聊天记录;如果有新消息到达,会话会再次出现。
同步服务器会话开始
IMSDK.on(IMEvents.OnSyncServerStart,(reinstalled) => {})
- 参数:
参数 类型 说明 reinstalled number 是否为重新安装后的同步
同步服务器会话完成
IMSDK.on(IMEvents.OnSyncServerFinish,(reinstalled) => {})
- 参数:
参数 类型 说明 reinstalled number 是否为重新安装后的同步
同步服务器会话失败
IMSDK.on(IMEvents.OnSyncServerFailed,(reinstalled) => {})
- 参数:
参数 类型 说明 reinstalled number 是否为重新安装后的同步
同步服务器数据进度通知
IMSDK.on(IMEvents.OnSyncServerProgress,(progress) => {})
- 参数:
参数 类型 说明 progress number 同步进度0~100
有新的会话
IMSDK.on(IMEvents.OnNewConversation, ({ data }) => {})
- 参数:
参数 类型 说明 data ConversationInfo[] 会话列表
某些会话的关键信息发生变化
IMSDK.on(IMEvents.OnConversationChanged, ({ data }) => {})
- 参数:
参数 类型 说明 data ConversationInfo[] 会话列表
会话未读总数变更通知
IMSDK.on(IMEvents.OnTotalUnreadMsgCountChanged,({data}) => {})
- 参数:
参数 类型 说明 data number 未读总数
好友
添加好友
IMSDK.addFriend({
toUserID: string;
reqMsg: string;
}, operationID?: string)
-
参数:
参数 类型 说明 toUserID string 对方userID reqMsg string 请求消息 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.addFriend({
toUserID: "userID",
reqMsg: "str",
})
相关回调请参考:
获取收到的好友申请
IMSDK.getFriendReqListAsRecipient({
offset: number;
count: number;
})
-
参数:
参数 类型 说明 offset number 起始偏移量 count number 拉取数量 -
返回值: Promise<ResponseData<FriendReq[]>>
- 示例代码
const {data: reqList} = await IMSDK.getFriendReqListAsRecipient({offset: 0, count: 20})
发出的好友申请
IMSDK.getFriendReqListAsApplicant({
offset: number;
count: number;
})
-
参数:
参数 类型 说明 offset number 起始偏移量 count number 拉取数量 -
返回值: Promise<ResponseData<FriendReq[]>>
- 示例代码
const {data: reqList} = await IMSDK.getFriendReqListAsApplicant({offset: 0, count: 20})
同意某人的好友申请
IMSDK.acceptFriendReq({
toUserID: string;
handleMsg: string;
}, operationID?: string)
-
参数:
参数 类型 说明 toUserID string 对方userID handleMsg string 消息 -
返回值: Promise<ResponseData>
相关回调请参考:
拒绝好友申请
IMSDK.refuseFriendReq({
toUserID: string;
handleMsg: string;
}, operationID?: string)
-
参数:
参数 类型 说明 toUserID string 对方userID handleMsg string 消息 -
返回值: Promise<ResponseData>
相关回调请参考:
加入黑名单
IMSDK.addBlack(userID: string, operationID?: string)
-
参数:
参数 类型 说明 userID string 对方userID -
返回值: Promise<ResponseData>
相关回调请参考:
获取黑名单
IMSDK.getBlackList(operationID?: string)
- 返回值: Promise<ResponseData<BlackUserItem[]>>
移除黑名单
IMSDK.removeBlack(userID: string, operationID?: string)
-
参数:
参数 类型 说明 userID string 对方userID -
返回值: Promise<ResponseData>
相关回调请参考:
获取指定好友列表的相关信息
IMSDK.getSpecifiedFriendsInfo(userIDs: string[], filte rBlack: boolean)
-
参数:
参数 类型 说明 userIDs array 需要查询的userID列表 filterBlack boolean 是否过滤黑名单中的好友 -
返回值: Promise<ResponseData<FriendUserItem[]>>
获取好友列表
IMSDK.getFriendList(filterBlack)
-
参数:
参数 类型 说明 filterBlack boolean 是否过滤黑名单中的好友 -
返回值: Promise<ResponseData<FriendUserItem[]>>
获取分页好友列表
IMSDK.getFriendListPage({
offset,
count,
filterBlack
})
-
参数:
参数 类型 说明 offset number 偏移量 count number 获取数量 filterBlack boolean 是否过滤黑名单中的好友 -
返回值: Promise<ResponseData<FriendUserItem[]>>
检查是否好友关系
IMSDK.checkFriend(userIDList: string[], operationID?: string)
-
参数:
参数 类型 说明 userIDList array 需要查询的userID列表 -
返回值: Promise<ResponseData<SimpleResultInfo[]>>
更新好友信息
IMSDK.updateFriends({
friendUserIDs: Array<string>;
ex: string;
remark: string;
isPinned: boolean;
})
-
参数:
参数 类型 说明 friendUserIDs array 好友userID列表 remark string 要设置的备注,为空字符串时会取消备注 isPinned boolean 是否置顶 -
返回值: Promise<ResponseData>
删除好友
IMSDK.deleteFriend(userID: string, operationID?: string)
-
参数:
参数 类型 说明 userID string 好友userID -
返回值: Promise<ResponseData>
本地搜索好友
IMSDK.searchFriends({
keywordList: string[];
isSearchUserID: boolean;
isSearchNickname: boolean;
isSearchRemark: boolean;
}, operationID?: string)
-
参数:
参数 类型 说明 keywordList array 关键词列表,目前仅支持单个关键词 isSearchUserID boolean 是否以关键词搜索userID isSearchNickname boolean 是否以关键词搜索昵称,默认false isSearchRemark boolean 是否以关键词搜索备注,默认false -
返回值: Promise<ResponseData<SearchedFriendsInfo[]>>
相关回调请参考:
黑名单新增通知
IMSDK.on(IMEvents.OnBlackAdded, ({data})=>{});
- 参数:
参数 类型 说明 data BlackUserItem 黑名单信息
黑名单删除通知
IMSDK.on(IMEvents.onBlackDeleted, ({data})=>{});
- 参数:
参数 类型 说明 data BlackUserItem 黑名单信息
好友申请通知
IMSDK.on(IMEvents.onFriendReqAdded, ({data})=>{});
- 参数:
参数 类型 说明 data FriendReq 好友申请信息
好友申请被拒绝
IMSDK.on(IMEvents.onFriendReqRejected, ({data})=>{});
- 参数:
参数 类型 说明 data FriendReq 好友申请信息
好友申请被接受
IMSDK.on(IMEvents.onFriendReqAccepted, ({data})=>{});
- 参数:
参数 类型 说明 data FriendReq 好友申请信息
好友申请被删除
IMSDK.on(IMEvents.onFriendReqDeleted, ({data})=>{});
- 参数:
参数 类型 说明 data FriendReq 好友申请信息
好友新增通知
IMSDK.on(IMEvents.onFriendAdded, ({data})=>{});
- 参数:
参数 类型 说明 data FriendUserItem 好友信息
好友删除通知
IMSDK.on(IMEvents.onFriendDeleted, ({data})=>{});
- 参数:
参数 类型 说明 data FriendUserItem 好友信息
好友资料变更通知
IMSDK.on(IMEvents.onFriendInfoChanged, ({data})=>{});
- 参数:
参数 类型 说明 data FriendUserItem 好友信息
群组
创建群
IMSDK.createGrp({
memberUserIDs: string[];
groupInfo: Partial<GroupInfo>;
adminUserIDs?: string[];
ownerUserID?: string;
}, operationID?: string)
-
参数:
参数 类型 说明 memberUserIDs array 群成员userID列表 groupInfo Partial<GroupInfo> 群组信息 adminUserIDs array 群管理userID列表 ownerUserID string 群所有者userID -
返回值: Promise<ResponseData<GroupInfo[]>>
- 示例代码
const { data: groupItem } = await IMSDK.createGrp({
groupInfo: {
groupName: "群名称"
},
memberUserIDs: [''],
});
相关回调请参考:
申请加入群组
IMSDK.joinGrp({
groupID: string;
reqMsg: string;
joinSource: JoinType;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID reqMsg string 入群申请信息 joinSource JoinType 进群方式 -
返回值: Promise<ResponseData>
相关回调请参考:
退群
IMSDK.quitGrp(groupID: string, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID -
返回值: Promise<ResponseData>
- 补充说明:
群主可以解散群,群主身份转让后才可以退出群组
相关回调请参考:
获取已加入的群列表
IMSDK.getJoinedGrpList(operationID?: string)
- 返回值: Promise<ResponseData<GroupInfo[]>>
获取指定群资料
IMSDK.getSpecifiedGrpsInfo(groupIDs: string[], operationID?: string)
-
参数:
参数 类型 说明 groupIDs array 群ID列表 -
返回值: Promise<ResponseData<GroupInfo[]>>
更新群资料
IMSDK.setGrpInfo(
groupInfo: Partial<GroupInfo> & { groupID: string },
operationID?: string
)
-
参数:
参数 类型 说明 groupInfo Partial<GroupInfo> & { groupID: string } 群组信息 -
返回值: Promise<ResponseData>
- 示例代码
await IMSDK.setGrpInfo({
groupID: "groupID",
groupName: "新群名",
})
相关回调请参考:
获取群成员列表
IMSDK.getGrpMemberList({
groupID: string;
filter: GroupMemberFilter;
offset: number;
count: number;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID filter GroupMemberFilter 群成员过滤器 offset number 起始偏移量 count number 分页大小 -
返回值: Promise<ResponseData<GroupMemberInfo[]>>
- 补充说明:
获取群内指定的群成员信息,仅本群成员可调用。
获取群内指定群成员信息
IMSDK.getSpecifiedGrpMembersInfo({
groupID: string;
userIDList: string[];
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID userIDList array 群成员userID列表 -
返回值: Promise<ResponseData<GroupMemberInfo[]>>
- 补充说明:
获取群内指定的群成员信息,仅本群成员可调用。
踢出群
IMSDK.kickGrpMember({
groupID: string;
reason: string;
userIDList: string[];
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID reason string 踢出原因 userIDList array 被踢出的群成员userID列表 -
返回值: Promise<ResponseData>
相关回调请参考:
转让群主
IMSDK.transferGrpOwner({
groupID: string;
newOwnerUserID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID newOwnerUserID string 新群主userID -
返回值: Promise<ResponseData>
- 补充说明:
只有群主能操作
相关回调请参考:
邀请入群
IMSDK.inviteUserToGrp({
groupID: string;
reason: string;
userIDList: string[];
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID reason string 邀请原因 userIDList array 被邀请的群成员userID列表 -
返回值: Promise<ResponseData>
相关回调请参考:
获取收到的群成员申请进群列表
IMSDK.getGrpReqListAsRecipient({
offset: number;
count: number;
})
-
参数:
参数 类型 说明 offset number 起始偏移量 count number 拉取数量 -
返回值: Promise<ResponseData<GroupReqInfo[]>>
获取发出的入群申请列表
IMSDK.getGrpReqListAsApplicant({
offset: number;
count: number;
})
-
参数:
参数 类型 说明 offset number 起始偏移量 count number 拉取数量 -
返回值: Promise<ResponseData<GroupReqInfo[]>>
同意某人进入某群
IMSDK.acceptGrpReq({
groupID: string;
fromUserID: string;
handleMsg: string;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID fromUserID string 申请者userID handleMsg string 处理原因 -
返回值: Promise<ResponseData>
- 补充说明:
管理员或者群主操作
相关回调请参考:
拒绝某人进入某群
IMSDK.refuseGrpReq({
groupID: string;
fromUserID: string;
handleMsg: string;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID fromUserID string 申请者userID handleMsg string 拒绝的原因 -
返回值: Promise<ResponseData>
- 补充说明:
管理员或者群主操作
相关回调请参考:
解散群
IMSDK.dismissGrp(groupID: string, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID -
返回值: Promise<ResponseData>
- 补充说明:
只有群主能操作
相关回调请参考:
禁言某群成员
IMSDK.changeGrpMemberMute({
groupID: string;
userID: string;
mutedSeconds: number;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID userID string 被禁言的群成员userID mutedSeconds number 禁言时长,单位为秒。0表示取消禁言。 -
返回值: Promise<ResponseData>
- 补充说明:
群主可以禁言管理员和普通成员,管理员可以禁言普通成员。
设置群禁言状态
IMSDK.changeGrpMute({
groupID: string;
isMute: boolean;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID isMute boolean 是否禁言 -
返回值: Promise<ResponseData>
- 补充说明:
群主或管理员可以设置群禁言状态,禁言后仅群主和管理员可以发言。
相关回调请参考:
搜索群
IMSDK.searchGrps({
keywordList: string[];
isSearchGroupID: boolean;
isSearchGroupName: boolean;
}, operationID?: string)
-
参数:
参数 类型 说明 keywordList array 搜索关键字列表 isSearchGroupID boolean 是否搜索群ID isSearchGroupName boolean 是否搜索群名称 -
返回值: Promise<ResponseData<GroupInfo>>
设置群成员信息
IMSDK.setGrpMemberInfo({
groupID: string;
userID: string;
nickname?: string;
faceURL?: string;
roleLevel?: GroupMemberRole;
ex?: string;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID userID string 群成员userID nickname string 群成员昵称 faceURL string 群成员头像URL roleLevel GroupMemberRole 群成员身份 ex string 群成员扩展字段 -
返回值: Promise<ResponseData>
- 补充说明:
群主可以修改管理员和普通成员信息,管理员可以修改普通成员信息
相关回调请参考:
根据加入时间分页获取组成员列表
IMSDK.getGrpMemberListByJoinTimeFilter({
groupID: string;
filterUserIDList: string[];
offset: number;
count: number;
joinTimeBegin: number;
joinTimeEnd: number;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID filterUserIDList array 排除的群成员 userID 列表 offset number 分页偏移 count number 分页大小 joinTimeBegin number 加入时间开始,为 0 时不限制 joinTimeEnd number 加入时间结束,为 0 时不限制 -
返回值: Promise<ResponseData<GroupMemberInfo[]>>
- 示例代码
await IMSDK.getGrpMemberListByJoinTimeFilter({
groupID: 'groupID',
offset: 0,
count: 10,
joinTimeBegin: 0,
joinTimeEnd: 0,
filterUserIDList: ['userID'],
})
获取管理者和拥有者
IMSDK.getGrpMemberOwnerAndAdmin(groupID: string, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID -
返回值: Promise<ResponseData<GroupMemberInfo[]>>
搜索群成员
IMSDK.searchGrpMembers({
groupID: string;
keywordList: string[];
isSearchUserID: boolean;
isSearchMemberNickname: boolean;
offset: number;
count: number;
}, operationID?: string)
-
参数:
参数 类型 说明 groupID string 群ID keywordList array 搜索关键字列表 isSearchUserID boolean 是否搜索群成员userID isSearchMemberNickname boolean 是否搜索群成员昵称 offset number 分页偏移 count number 分页大小 -
返回值: Promise<ResponseData<GroupMemberInfo[]>>
- 补充说明:
群成员才有权限搜索
有新成员加入群
IMSDK.on(IMEvents.OnGrpMemberAdded, ({data})=>{})
- 参数:
参数 类型 说明 data GroupMemberInfo 群成员信息
有成员离开群
IMSDK.on(IMEvents.OnGrpMemberDeleted, ({data})=>{})
- 参数:
参数 类型 说明 data GroupMemberInfo 群成员信息
某成员信息发生变更
IMSDK.on(IMEvents.OnGrpMemberInfoChanged, ({data})=>{})
- 参数:
参数 类型 说明 data GroupMemberInfo 群成员信息
群组有增加通知
IMSDK.on(IMEvents.OnJoinedGrpAdded, ({data})=>{})
- 参数:
参数 类型 说明 data GroupInfo 群信息
群组有减少通知
IMSDK.on(IMEvents.OnJoinedGrpDeleted, ({data})=>{})
- 参数:
参数 类型 说明 data GroupInfo 群信息
群信息修改通知
IMSDK.on(IMEvents.OnGrpInfoChanged, ({data})=>{})
- 参数:
参数 类型 说明 data GroupInfo 群信息
群申请被接受通知
IMSDK.on(IMEvents.OnGrpReqAccepted, ({data})=>{})
- 参数:
参数 类型 说明 data GroupReqInfo 申请入群信息
有人申请加群通知
IMSDK.on(IMEvents.OnGrpReqAdded, ({data})=>{})
- 参数:
参数 类型 说明 data GroupReqInfo 申请入群信息
群申请有删除通知
IMSDK.on(IMEvents.OnGrpReqDeleted, ({data})=>{})
- 参数:
参数 类型 说明 data GroupReqInfo 申请入群信息
群申请有拒绝通知
IMSDK.on(IMEvents.OnGrpReqRejected, ({data})=>{})
- 参数:
参数 类型 说明 data GroupReqInfo 申请入群信息
群解散通知
IMSDK.on(IMEvents.OnGrpDismissed, ({data})=>{})
- 参数:
参数 类型 说明 data GroupInfo 群信息
消息
创建文本消息
IMSDK.createTextMsg(text: string, operationID?: string)
-
参数:
参数 类型 说明 text string 消息内容 -
返回值: MessageInfo
创建@文本消息
IMSDK.createTextAtMsg({
text: string;
atUserIDList: string[];
atUsersInfo: AtUsersInfoItem[];
message?: MessageItem;
}, operationID?: string)
-
参数:
参数 类型 说明 text string 消息内容 atUserIDList string[] 被@的userID列表 atUsersInfo AtInfo[] 被@的用户信息列表 message MessageInfo 引用消息的时候使用 -
返回值: MessageInfo
创建图片消息
IMSDK.createImageMsgByFile({
sourcePicture: PicBaseInfo;
bigPicture: PicBaseInfo;
snapshotPicture: PicBaseInfo;
sourcePath: string;
file: File;
}, operationID?: string)
-
参数:
参数 类型 说明 sourcePicture PicBaseInfo 原图信息 bigPicture PicBaseInfo 大图信息 snapshotPicture PicBaseInfo 缩略图信息 sourcePath string 图片在本机的绝对路径,如果没有传空字符即可 file File 文件对象 -
返回值: MessageInfo
- 示例代码
let file; //这是一个图片File对象
const picBaseInfo = {
uuid: "uuid",
type: file.type,
size: file.size,
width: 1920, //图像宽高可以加载img再读取
height: 1080,
}
const {data: message} = await IMSDK.createImageMsgByFile({
sourcePicture: picBaseInfo;
bigPicture: picBaseInfo;
snapshotPicture: picBaseInfo;
sourcePath: "";
file: file
})
创建音频消息
IMSDK.createSoundMsgByFile({
uuid: string;
soundPath: string;
sourceUrl: string;
dataSize: number;
duration: number;
soundType: string;
file: File;
}, operationID?: string)
-
参数:
参数 类型 说明 uuid string 资源唯一标识 soundPath string 音频在本地的绝对路径,如果没有传空字符即可 sourceUrl string 传空字符串 dataSize number 音频文件大小 duration number 音频时长(秒) soundType string 文件类型 file File 音频文件对象 -
返回值: MessageInfo
- 示例代码
let file; //音频文件对象
const {data: message} = await IMSDK.createSoundMessageByFile({
soundPath: file.path,
duration: 6,
uuid: 'uuid',
sourceUrl: '',
dataSize: file.size,
soundType: file.type,
file: file,
})
创建视频消息
IMSDK.createVideoMsgByFile({
videoPath: string;
duration: number;
videoType: string;
snapshotPath: string;
videoUUID: string;
videoUrl: string;
videoSize: number;
snapshotUUID: string;
snapshotSize: number;
snapshotUrl: string;
snapshotWidth: number;
snapshotHeight: number;
snapShotType: string;
videoFile: File;
snapshotFile: File;
}, operationID?: string)
-
参数:
参数 类型 说明 videoPath string 视频在本地的绝对路径,如果没有传空字符即可 duration number 视频时长(秒) videoType string 文件类型 snapshotPath string 传空字符 videoUUID string 视频文件唯一标识 videoUrl string 传空字符 videoSize number 视频文件大小 snapshotUUID string 视频封面唯一标识 snapshotSize number 视频封面文件大小 snapshotUrl string 传空字符 snapshotWidth number 视频封面宽度 snapshotHeight number 视频封面高度 snapShotType string 视频封面文件类型 videoFile File 视频文件对象 snapshotFile File 视频封面文件对象 -
返回值: MessageInfo
创建文件消息
IMSDK.createFileMsgByFile({
filePath: string;
fileName: string;
uuid: string;
sourceUrl: string;
fileSize: number;
fileType: string;
file: File;
}, operationID?: string)
-
参数:
参数 类型 说明 filePath string 文件在本地的绝对路径,如果没有传空字符即可 fileName string 文件名 uuid string 文件唯一标识 sourceUrl string 传空字符 fileSize number 文件大小 fileType string 文件类型 file File 文件对象 -
返回值: MessageInfo
- 示例代码
let file; //文件对象
const {data:message} = await IMSDK.createFileMessageByFile({
filePath: '',
fileName: file.name,
uuid: 'uuid',
sourceUrl: '',
fileSize: file.size,
fileType: file.type,
file: file,
})
创建合并消息
IMSDK.createMergerMsg({
messageList: MessageInfo[];
title: string;
summaryList: string[];
}, operationID?: string)
-
参数:
参数 类型 说明 messageList MessageInfo[] 消息列表 title string 消息标题 summaryList string[] 消息摘要列表 -
返回值: MessageInfo
创建转发消息
IMSDK.createForwardMsg(message:MessageInfo, operationID?: string)
-
参数:
参数 类型 说明 message MessageInfo 消息对象 -
返回值: MessageInfo
创建位置消息
IMSDK.createLocationMsg({
description: string;
longitude: number;
latitude: number;
}, operationID?: string)
-
参数:
参数 类型 说明 description string 位置描述 longitude number 经度 latitude number 纬度 -
返回值: MessageInfo
创建引用消息
IMSDK.createQuoteMsg({
text: string;
message: MessageInfo;
}, operationID?: string)
-
参数:
参数 类型 说明 text string 文本内容 message MessageInfo 被引用的消息 -
返回值: MessageInfo
创建名片消息
IMSDK.createCardMsg({
userID: string;
nickname: string;
faceURL: string;
ex?: string;
}, operationID?: string)
-
参数:
参数 类型 说明 userID string 用户ID nickname string 用户昵称 faceURL string 用户头像 ex string 扩展字段 -
返回值: MessageInfo
创建自定义消息
IMSDK.createCustomMsg({
data: string;
extension: string;
description: string;
}, operationID?: string)
-
参数:
参数 类型 说明 data string 文本内容 extension string 扩展内容 description string 描述内容 -
返回值: MessageInfo
创建动图消息
IMSDK.createFaceMsg({
index: number;
data: string;
}, operationID?: string)
- 返回值: MessageInfo
发送消息
IMSDK.sendMsg({
recvID: string;
groupID: string;
offlinePushInfo?: OfflinePushInfo;
message: MessageInfo;
}, operationID?: string)
-
参数:
参数 类型 说明 recvID string 单聊的用户ID,如果为群聊则为"" groupID string 群聊的群ID,如果为单聊则为"" offlinePushInfo OfflinePushInfo 离线推送信息 message MessageInfo 消息体 isOnlineOnly boolean 消息是否只发送给在线用户 -
返回值: MessageInfo
- 补充说明:
发送消息需要先构造消息实例,支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、@xxx等消息,构造完消息后调用SDK的发送接口即可完成消息的发送
相关回调请参考:
撤回一条消息
IMSDK.revokeMsg({
conversationID: string;
clientMsgID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 conversationID string 会话ID clientMsgID string 消息ID -
返回值: Promise<ResponseData>
- 补充说明:
支持撤回自己的消息,管理员与群主撤回群成员消息。
相关回调请参考:
单聊正在输入消息
IMSDK.typingStatusUpdate({
recvID: string;
msgTip: string;
}, operationID?: string)
-
参数:
参数 类型 说明 recvID string 对方用户ID msgTip string 自定义的提示信息 -
返回值: Promise<ResponseData>
相关回调请参考:
从本地删除一条消息
IMSDK.deleteMsgFromLocalStorage({
conversationID: string;
clientMsgID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 conversationID string 会话ID clientMsgID string 消息ID -
返回值: Promise<ResponseData>
删除一条消息
IMSDK.deleteMsg({
conversationID: string;
clientMsgID: string;
}, operationID?: string)
-
详情: 从本地和服务器上删除一条消息
-
参数:
参数 类型 说明 conversationID string 会话ID clientMsgID string 消息ID -
返回值: Promise<ResponseData>
从本地删除所有消息
IMSDK.deleteAllMsgFromLocal(operationID?: string)
- 返回值: Promise<ResponseData>
删除所有消息
IMSDK.deleteAllMsgFromLocalAndSvr(operationID?: string)
-
详情: 从本地和服务器上删除所有消息
-
返回值: Promise<ResponseData>
插入一条单聊消息到本地
IMSDK.insertSingleMsgToLocalStorage({
message: MessageInfo;
recvID: string;
sendID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 message MessageInfo 消息体 recvID string 接收用户ID sendID string 发送者ID -
返回值: Promise<ResponseData>
插入一条群聊消息到本地
IMSDK.insertGrpMsgToLocalStorage({
message: MessageInfo;
groupID: string;
sendID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 message MessageInfo 消息体 groupID string 群ID sendID string 发送者ID -
返回值: Promise<ResponseData>
查找本地消息
IMSDK.searchLocalMsgs({
conversationID: string;
keywordList: string[];
messageTypeList?: MessageContentType[];
searchTimePosition?: number;
searchTimePeriod?: number;
pageIndex?: number;
count?: number;
}, operationID?: string)
-
参数:
参数 类型 说明 conversationID string 会话ID,全局搜素时填空串 keywordList string[] 关键词列表,目前仅支持单个关键词 messageTypeList MessageContentType[] 消息类型列表 searchTimePosition number 起始时间,UTC时间,单位秒,0表示从当前时间开始 searchTimePeriod number 从起始时间往前的时间范围,UTC时间,单位秒,3600表示过去一小时,传0表示不限制时间范围 pageIndex number 开始页数,首次查询传1,全局搜索时无效 count number 每页消息数,全局搜索时无效 -
返回值: Promise<ResponseData<SearchResultInfo>>
上传文件
IMSDK.uploadFile({
name: string;
contentType: string;
uuid: string;
file: File;
}, operationID?: string)
-
参数:
参数 类型 说明 name string 文件名 contentType string 文件类型 uuid string 文件唯一标识 file File 文件对象 -
返回值: Promise<ResponseData<{url: string}>>
- 示例代码
let file; //文件对象
const {data: {url}} = await IMSDK.uploadFile({
name: file.name,
contentType: file.type,
uuid: 'uuid',
file: file,
});
console.log(url);
获取历史消息
IMSDK.getAdvancedHistoryMsgList({
lastMinSeq: number;
count: number;
startClientMsgID: string;
conversationID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 lastMinSeq number 上一次拉取回调给的值,首次拉取传0 count number 拉取消息的条数 startClientMsgID string 起始的消息ID,首次拉取可传空字符串 conversationID string 会话ID -
返回值: Promise<ResponseData<GetAdvancedHistoryMessageListInfo>>
- 示例代码
await IMSDK.getAdvancedHistoryMsgList({
lastMinSeq: 0,
count: 10,
startClientMsgID: '',
conversationID: 'conversationID',
})
反向获取历史消息
IMSDK.getAdvancedHistoryMsgListReverse({
lastMinSeq: number;
count: number;
startClientMsgID: string;
conversationID: string;
}, operationID?: string)
-
参数:
参数 类型 说明 lastMinSeq number 上一次拉取回调给的值,首次拉取传0 count number 拉取消息的条数 startClientMsgID string 起始的消息ID,首次拉取可传空字符串 conversationID string 会话ID -
返回值: Promise<ResponseData<GetAdvancedHistoryMessageListInfo[]>>
- 示例代码
await IMSDK.getAdvancedHistoryMsgListReverse({
lastMinSeq: 0,
count: 10,
startClientMsgID: '',
conversationID: 'conversationID',
})
收到新消息
IMSDK.on(IMEvents.OnRecvNewMsgs, ({data}) => {})
- 参数:
参数 类型 说明 data MessageInfo[] 新消息
单聊消息已读回执
IMSDK.on(IMEvents.OnRecv1v1ReadReceipt, ({data}) => {})
- 参数:
参数 类型 说明 data string ReceiptInfo[]的JSON形式
收到消息撤回
IMSDK.on(IMEvents.OnNewRecvMsgRevoked, ({data}) => {})
- 参数:
参数 类型 说明 data MessageRevokedInfo[] 撤回消息
收到消息删除
IMSDK.on(IMEvents.OnMsgDeleted, ({data}) => {})
- 参数:
参数 类型 说明 data MessageInfo 删除的消息