更新记录
1.0.4(2026-09-20)
1、完善插件三端全部会话相关接口。 2、增加查询状态或设置自己状态接口。
1.0.3(2026-09-15)
1、修复iOS消息创建接口问题。 2、增加iOS部分会话相关接口。 3、优化代码。
1.0.2(2026-09-09)
1、升级插件依赖的IMSDK到9.0.7652版本。 2、增加部分会话相关接口。 2、增加部分高级消息收发相关接口。
查看更多平台兼容性
uni-app(4.64)
| Vue2 | Vue3 | Chrome | Safari | app-vue | app-nvue | Android | iOS | 鸿蒙 |
|---|---|---|---|---|---|---|---|---|
| √ | √ | × | × | √ | √ | 5.0 | 12 | √ |
| 微信小程序 | 支付宝小程序 | 抖音小程序 | 百度小程序 | 快手小程序 | 京东小程序 | 鸿蒙元服务 | QQ小程序 | 飞书小程序 | 小红书小程序 | 快应用-华为 | 快应用-联盟 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| × | × | × | × | × | × | × | × | × | × | × | × |
uni-app x(4.87)
| Chrome | Safari | Android | iOS | 鸿蒙 | 微信小程序 |
|---|---|---|---|---|---|
| × | × | 5.0 | 12 | √ | × |
腾讯云即时通信 IM UTS插件接口文档
UTS插件对象
<script>
//UTS插件对象
import * as TXIM from "@/uni_modules/Lizii-TXIM";
export default {
}
</script>
初始化登录接口
1. 初始化(必须)
<script>
//UTS插件对象
import * as TXIM from "@/uni_modules/Lizii-TXIM";
export default {
onLoad() {
//初始化SDK
let sdkAppID = 1400000006;//应用 ID
let config = {
logLevel:3,//log 文件的等级,NONE(0) DEBUG(3) INFO(4) WARN(5) ERROR(6), 默认 DEBUG 等级
onLog: (logLevel, logContent) => {
console.log(logLevel);
console.log(logContent);
}//log 监听回调
};//配置选项可选
let ret = TXIM.initSDK(sdkAppID, config);
console.log("初始化 ret=" + ret);
}
}
</script>
2. 反初始化
// 反初始化 SDK
TXIM.unInitSDK();
3. 添加 IM 监听
//添加 IM 监听
TXIM.addIMSDKListener({
onConnecting: () => {
console.log("onConnecting");
},
onConnectSuccess: () => {
console.log("onConnectSuccess");
},
onConnectFailed: (code, error) => {
console.log("onConnectFailed: code=" + code + ", error=" + error);
},
onKickedOffline: () => {
console.log("onKickedOffline");
},
onUserSigExpired: () => {
console.log("onUserSigExpired");
},
onSelfInfoUpdated: (info) => {
console.log("onSelfInfoUpdated");
console.log(info);
}
});
4. 移除 IM 监听
移除 IM 监听
TXIM.removeIMSDKListener();
5. 获取版本号
// 获取版本号
// return string 版本号
let version = TXIM.getVersion();
console.log(version);
6. 获取服务器当前时间, UTC 时间戳,单位 s。
// 获取服务器当前时间, UTC 时间戳,单位 s。
// return number 服务器当前时间
let serverTime = TXIM.getServerTime();
console.log(serverTime);
7. 登录
//登录
let userID = "xxx";
let userSig = "xxx";
TXIM.login(userID, userSig, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
8. 登出
//登出
TXIM.logout({
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
9. 获取登录状态, 如果用户已经处于已登录和登录中状态,请勿再频繁调用登录接口登录。
// 获取登录状态, 如果用户已经处于已登录和登录中状态,请勿再频繁调用登录接口登录。
// return number 未知状态(0) 已登录(1) 登录中(2) 无登录(3)
let status = TXIM.getLoginStatus();
console.log(status);
10. 获取登录用户
// 获取登录用户
// return string 登录用户userID
let userID = TXIM.getLoginUser();
console.log(userID);
简单消息收发接口
1. 设置基本消息(文本消息和自定义消息)的事件监听器,请不要同 addAdvancedMsgListener 混用
//添加基本消息(文本消息和自定义消息)回调事件
TXIM.addSimpleMsgListener({
onRecvC2CTextMessage: (msgID, sender, text) => {
console.log(msgID);
console.log(JSON.stringify(sender));
console.log(text);
},
onRecvC2CCustomMessage: (msgID, sender, customData) => {
console.log(msgID);
console.log(JSON.stringify(sender));
console.log(customData);
},
onRecvGroupTextMessage: (msgID, groupID, sender, text) => {
console.log(msgID);
console.log(groupID);
console.log(JSON.stringify(sender));
console.log(text);
},
onRecvGroupCustomMessage: (msgID, groupID, sender, customData) => {
console.log(msgID);
console.log(groupID);
console.log(JSON.stringify(sender));
console.log(customData);
}
});
2. 移除基本消息(文本消息和自定义消息)的事件监听器
//移除 基本消息(文本消息和自定义消息)回调事件
TXIM.removeSimpleMsgListener();
3. 发送单聊普通文本消息(最大支持 12KB)
//发送单聊普通文本消息(最大支持 12KB)
let text = "text content 哈哈";//发送文本
let userID = "xxx";//用户ID
let msgID = TXIM.sendC2CTextMessage(text, userID, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
console.log(msgID);
4. 发送单聊自定义(信令)消息(最大支持 12KB)
//发送单聊自定义(信令)消息(最大支持 12KB)
let customData = JSON.stringify({
name:"张三",
age:20
});//自定义消息
let userID = "xxx";//用户ID
let msgID = TXIM.sendC2CCustomMessage(customData, userID, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
console.log(msgID);
5. 发送群聊普通文本消息(最大支持 12KB)
//发送群聊普通文本消息(最大支持 12KB)
let text = "text content 哈哈";//发送文本
let groupID = "xxx";//群组ID
let priority = 1;//发送消息优先级 默认(0) 高优先级(1) 常规优先级(2) 低优先级(3)
let msgID = TXIM.sendGroupTextMessage(text, groupID, priority, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
console.log(msgID);
6. 发送群聊自定义(信令)消息(最大支持 12KB)
//发送群聊自定义(信令)消息(最大支持 12KB)
let customData = JSON.stringify({
name:"张三",
age:20
});//自定义消息
let groupID = "xxx";//群组ID
let priority = 1;//发送消息优先级 默认(0) 高优先级(1) 常规优先级(2) 低优先级(3)
let msgID = TXIM.sendGroupCustomMessage(customData, groupID, priority, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
console.log(msgID);
会话列表相关接口
1. 添加会话监听器
//添加会话监听器
TXIM.addConversationListener({
onNewConversation: (conversationList) => {
console.log(conversationList);
},
onConversationChanged: (conversationList) => {
console.log(conversationList);
},
onConversationDeleted: (conversationIDList) => {
console.log(conversationIDList);
},
onTotalUnreadMessageCountChanged: (totalUnreadCount) => {
console.log(totalUnreadCount);
}
});
2. 移除会话监听器
//移除会话监听器
TXIM.removeConversationListener();
3. 获取会话列表
//获取会话列表
let nextSeq = 0;//分页拉取的游标,第一次默认取传 0,后续分页拉传上一次分页拉取成功回调里的 nextSeq
let count = 100;//分页拉取的个数,一次分页拉取不宜太多,会影响拉取的速度,建议每次拉取 100 个会话
TXIM.getConversationList(nextSeq, count, {
onSuccess: (result) => {
if (result.conversationList != null) {
conversationList = result.conversationList;
}
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
4. 获取会话高级接口,可以指定会话类型、标记类型、分组名等
//获取会话高级接口,可以指定会话类型、标记类型、分组名等
let nextSeq = 0;//分页拉取的游标,第一次默认取传 0,后续分页拉传上一次分页拉取成功回调里的 nextSeq
let count = 100;//分页拉取的个数,一次分页拉取不宜太多,会影响拉取的速度,建议每次拉取 100 个会话
TXIM.getConversationListByFilter({
conversationType: 1,//不过滤此项(0) 单聊(1) 群聊(2)
//conversationGroup:"123",//会话分组名称(填空代表不过滤此项)
markType:0,//标记类型, 0 代表不过滤此项 , 1(会话标星) | 2(会话标记未读) | 4(会话折叠) | 8(会话隐藏)
hasUnreadCount:false,//设置为 true 代表过滤含未读数的会话;设置为 false 代表过滤不含未读数的会话
hasGroupAtInfo:false//设置为 true 代表过滤含群 @ 消息的会话;设置为 false 代表过滤不含群 @ 消息的会话
}, nextSeq, count, {
onSuccess: (result) => {
if (result.conversationList != null) {
conversationList = result.conversationList;
}
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
5. 获取指定单个会话
//获取指定单个会话
let conversationID = "c2c_123";//会话ID
TXIM.getConversation(conversationID, {
onSuccess: (conversation) => {
console.log(conversation);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
6. 获取指定多个会话
//获取指定单个会话, 注:由于不支持重载,此接口对应调用原生Android和iOS的getConversationList接口
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
TXIM.getConversations(conversationIDList, {
onSuccess: (conversationList) => {
console.log(conversationList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
7. 删除会话
//删除会话
let conversationID = "c2c_123";//会话ID
TXIM.deleteConversation(conversationID, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
8. 删除会话列表
//删除会话列表
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
let clearMessage = true;//是否删除会话中的消息;设置为 false 时,保留会话消息;设置为 true 时,本地和服务器的消息会一起删除,并且不可恢复
TXIM.deleteConversationList(conversationIDList, clearMessage, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
9. 设置会话草稿
//设置会话草稿
let conversationID = "c2c_125";//会话唯一ID
let draftText = "hh";//草稿内容, 为 null 则表示取消草稿
TXIM.setConversationDraft(conversationID, draftText, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
10. 设置会话自定义数据
//设置会话自定义数据
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
let customData = "custom";//自定义数据,最大支持 256 bytes
TXIM.setConversationCustomData(conversationIDList, customData, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
11. 置顶会话
//置顶会话
let conversationID = "c2c_125";//会话唯一ID
let isPinned = true;//是否置顶
TXIM.pinConversation(conversationID, isPinned, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
12. 标记会话 (从 6.5 版本开始支持,需要您购买旗舰版套餐)
//标记会话 (从 6.5 版本开始支持,需要您购买旗舰版套餐)
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
let markType = 1 | 2;//会话标记类型, 1(会话标星) | 2(会话标记未读) | 4(会话折叠) | 8(会话隐藏)
let enableMark = true;//true:设置标记 false:取消标记
TXIM.markConversation(conversationIDList, markType, enableMark, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
13. 获取会话总未读数
//读取全部未读消息数
TXIM.getTotalUnreadMessageCount({
onSuccess: (unreadMessageCount) => {
console.log(unreadMessageCount);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
14. 获取按会话 filter 过滤的未读总数
//获取按会话 filter 过滤的未读总数
TXIM.getUnreadMessageCountByFilter({
conversationType: 1,//不过滤此项(0) 单聊(1) 群聊(2)
//conversationGroup:"123",//会话分组名称(填空代表不过滤此项)
markType:0,//标记类型, 0 代表不过滤此项 , 1(会话标星) | 2(会话标记未读) | 4(会话折叠) | 8(会话隐藏)
hasUnreadCount:false,//设置为 true 代表过滤含未读数的会话;设置为 false 代表过滤不含未读数的会话
hasGroupAtInfo:false//设置为 true 代表过滤含群 @ 消息的会话;设置为 false 代表过滤不含群 @ 消息的会话
}, {
onSuccess: (unreadMessageCount) => {
console.log(unreadMessageCount);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
15. 注册监听指定 filter 的会话未读总数变化
//注册监听指定 filter 的会话未读总数变化
TXIM.subscribeUnreadMessageCountByFilter({
conversationType: 1,//不过滤此项(0) 单聊(1) 群聊(2)
//conversationGroup:"123",//会话分组名称(填空代表不过滤此项)
markType:0,//标记类型, 0 代表不过滤此项 , 1(会话标星) | 2(会话标记未读) | 4(会话折叠) | 8(会话隐藏)
hasUnreadCount:false,//设置为 true 代表过滤含未读数的会话;设置为 false 代表过滤不含未读数的会话
hasGroupAtInfo:false//设置为 true 代表过滤含群 @ 消息的会话;设置为 false 代表过滤不含群 @ 消息的会话
});
16. 取消监听指定 filter 的会话未读总数变化
//取消监听指定 filter 的会话未读总数变化
TXIM.unsubscribeUnreadMessageCountByFilter({
conversationType: 1,//不过滤此项(0) 单聊(1) 群聊(2)
//conversationGroup:"123",//会话分组名称(填空代表不过滤此项)
markType:0,//标记类型, 0 代表不过滤此项 , 1(会话标星) | 2(会话标记未读) | 4(会话折叠) | 8(会话隐藏)
hasUnreadCount:false,//设置为 true 代表过滤含未读数的会话;设置为 false 代表过滤不含未读数的会话
hasGroupAtInfo:false//设置为 true 代表过滤含群 @ 消息的会话;设置为 false 代表过滤不含群 @ 消息的会话
});
17. 清理会话的未读消息计数
//清理会话的未读消息计数
let conversationID = "c2c_125";//会话唯一ID
let cleanTimestamp = 0;//清理时间戳,单位为秒,仅对单聊会话生效,指定清理哪一个 timestamp 之前的未读消息计数;当传入为 0 时,对应会话所有的未读消息将被清理,会话的未读数会清 0
let cleanSequence = 0;//清理 sequence,仅对群聊会话生效,指定清理哪一个 sequence 之前的未读消息计数;当传入为 0 时,对应会话所有的未读消息将被清理,会话的未读数会清 0
TXIM.cleanConversationUnreadMessageCount(conversationID, cleanTimestamp, cleanSequence, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
18. 创建会话分组
//创建会话分组, 会话分组最大支持 20 个,不再使用的分组请及时删除。
let groupName = "分组1";//分组名(必填参数,长度要 > 0,最大支持 32 bytes)
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
TXIM.createConversationGroup(groupName, conversationIDList, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
19. 获取会话分组列表
//获取会话分组列表, 该接口获取的是本地缓存的会话分组,建议在 onSyncServerFinish 之后调用。
TXIM.getConversationGroupList({
onSuccess: (groupList) => {
console.log(groupList);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
20. 删除会话分组
//删除会话分组
let groupName = "分组1";//分组名
TXIM.deleteConversationGroup(groupName, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
21. 重命名会话分组
//重命名会话分组
let oldName = "分组1";//旧分组名
let newName = "分组2";//新分组名
TXIM.renameConversationGroup(oldName, newName, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
22. 添加会话到一个会话分组
//添加会话到一个会话分组
let groupName = "分组1";//分组名(必填参数,长度要 > 0,最大支持 32 bytes)
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
TXIM.addConversationsToGroup(groupName, conversationIDList, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
23. 从一个会话分组中删除会话
//从一个会话分组中删除会话
let groupName = "分组1";//分组名(必填参数,长度要 > 0,最大支持 32 bytes)
let conversationIDList = ["c2c_123", "c2c_124"];//会话ID列表
TXIM.deleteConversationsFromGroup(groupName, conversationIDList, {
onSuccess: (conversationOperationResultList) => {
console.log(conversationOperationResultList.items);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
高级消息收发接口
1. 添加高级消息事件
//添加高级消息回调事件
TXIM.addAdvancedMsgListener({
onRecvNewMessage: (message) => {
console.log("onRecvNewMessage " + JSON.stringify(message));
}
});
2. 移除高级消息事件
//移除高级消息回调事件
TXIM.removeAdvancedMsgListener();
3. 创建文本消息
//创建消息
let message = TXIM.createTextMessage("发送消息");
console.log(message);
4. 创建自定义消息
//创建自定义消息
let data = {
name:"张三",
age:20
};
let message = TXIM.createCustomMessage(JSON.stringify(data));
console.log(message);
5. 创建图片消息
//创建图片消息
let imagePath = TXIM.convert2AbsFullPath("/static/logo.png");//图片路径
let message = TXIM.createImageMessage(imagePath);
console.log(message);
6. 创建语音消息
//创建语音消息
let path = TXIM.convert2AbsFullPath("/static/audio.m4a");//音频文件路径
let duration = 4;//语音时长,单位 s
let message = TXIM.createSoundMessage(path, duration);
console.log(message);
7. 创建视频消息
//创建视频消息
let videoPath = TXIM.convert2AbsFullPath("/static/video.mp4");//视频文件路径
let type = "mp4";//视频类型,如 mp4 mov 等
let duration = 44;//视频时长,单位 s
let snapshotPath = TXIM.convert2AbsFullPath("/static/video_shot.jpg");//视频封面图片路
let message = TXIM.createVideoMessage(videoPath, type, duration, snapshotPath);
console.log(message);
8. 创建文件消息
//创建文件消息
let path = TXIM.convert2AbsFullPath("/static/file1.txt");//文件路径
let fileName = "file1.txt";//文件名
let message = TXIM.createFileMessage(path, fileName);
console.log(message);
9. 创建地理位置消息
//创建地理位置消息
let desc = "杭州市余杭区南湖景秀湾";//地理位置描述信息
let longitude = 119.91376;//经度
let latitude = 30.266054;//纬度
let message = TXIM.createLocationMessage(desc, longitude, latitude);
console.log(message);
10. 创建表情消息
//创建表情消息
let index = 1;//表情索引
let data = "haha";//自定义数据
let message = TXIM.createFaceMessage(index, data);
console.log(message);
11. 发送消息,消息对象可以由 createXXXMessage 接口创建得来
//发送消息
let message = TXIM.createTextMessage("发送消息");//待发送的消息对象,需要通过对应的 createXXXMessage 接口进行创建
let receiver = "125";//消息接收者的 userID, 如果是发送 C2C 单聊消息,只需要指定 receiver 即可
let groupID = null;//目标群组 ID,如果是发送群聊消息,只需要指定 groupID 即可
//V2TIM_PRIORITY_DEFAULT = 0, ///< 默认
//V2TIM_PRIORITY_HIGH = 1, ///< 高优先级,一般用于礼物等重要消息
//V2TIM_PRIORITY_NORMAL = 2, ///< 常规优先级,一般用于普通消息
//V2TIM_PRIORITY_LOW = 3, ///< 低优先级,一般用于点赞消息
let priority = 0;//number 消息优先级,仅针对群聊消息有效。请把重要消息设置为高优先级(比如红包、礼物消息),高频且不重要的消息设置为低优先级(比如点赞消息)
let onlineUserOnly = false;//是否只有在线用户才能收到,如果设置为 YES ,接收方历史消息拉取不到,常被用于实现”对方正在输入”或群组里的非重要提示等弱提示功能,该字段不支持 AVChatRoom。
let offlinePushInfo = null;//离线推送时携带的标题和内容。
let msgID = TXIM.sendMessage(message, receiver, groupID, priority, onlineUserOnly, null, {
: (progress) => {
//文件上传进度回调
console.log(": progress=" + progress);
},
onSuccess: () => {
//成功回调
console.log("onSuccess");
},
onError: (code, desc) => {
//失败回调
console.log("onError: code=" + code + ", desc=" + desc);
}
});
console.log(msgID);//返回消息ID
12. 获取历史消息高级接口
//获取历史消息
TXIM.getHistoryMessageList({
getType:3,//拉取消息类型,可以设置拉取本地、云端更老或者更新的消息
userID:userID,//用户ID
count:20//取消息的个数,不宜太多,会影响消息拉取的速度,这里建议一次拉取 20 个
}, {
onSuccess: (result) => {
if (result.items != null) {
messageList = result.items;
}
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
群组相关接口
1. 添***组事件
//添***组回调事件
TXIM.addGroupListener({
onGroupCreated: (groupID) => {
console.log("onGroupCreated groupID=" + groupID);
},
onGroupDismissed: (groupID, opUser) => {
console.log("onGroupDismissed groupID=" + groupID);
console.log(JSON.stringify(opUser));
},
onGroupRecycled: (groupID, opUser) => {
console.log("onGroupRecycled groupID=" + groupID);
console.log(JSON.stringify(opUser));
},
onMemberEnter: (groupID, memberList) => {
console.log("onMemberEnter groupID=" + groupID);
console.log(JSON.stringify(memberList));
},
onMemberLeave: (groupID, member) => {
console.log("onMemberLeave groupID=" + groupID);
console.log(JSON.stringify(member))
}
});
2. 移除群组事件
//移除群组事件
TXIM.removeGroupListener();
3. 创建群组
//创建群
let groupType = "AVChatRoom";//群类型
let groupID = "123";//群ID
let groupName = "直播群";//群名称
TXIM.createGroup(groupType, groupID, groupName, {
onSuccess: (groupID) => {
console.log("onSuccess groupID=" + groupID);
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
4. 加***组
//加***组
let groupID = "123";//群ID
let message = "";//***消息
TXIM.joinGroup(groupID, message, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
5. 退出群组
//退出群组
let groupID = "123";//群ID
TXIM.quitGroup(groupID, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
6. 解散群组
//解散群组
let groupID = "123";//群ID
TXIM.dismissGroup(groupID, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
用户资料相关接口
1. 获取用户资料
//获取用户资料
let userID = TXIM.getLoginUser()!;//获取登录用户的userID
let userIDList: string[] = [userID];//用户userID列表
TXIM.getUsersInfo(userIDList, {
onSuccess: (infoList) => {
console.log("onSuccess :" + JSON.stringify(infoList));
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
2. 修改个人资料
//修改个人资料
let faceUrl = "https://1600124399-cn.rich.my-imcloud.com/download/457f704c8de0a8fa0064134423b9ed9c.png";
TXIM.setSelfInfo({
nickName: "Android原生插件",
faceUrl:faceUrl
}, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
3. 查询用户状态
//查询用户状态, 如果您想查询自己的自定义状态,您只需要传入自己的 userID 即可, 查询其他用户状态为 IM 旗舰版功能
let userID = TXIM.getLoginUser()!;//获取登录用户的userID
let userIDList: string[] = [userID];//用户userID列表
TXIM.getUserStatus(userIDList, {
onSuccess: (statusList) => {
console.log("onSuccess :" + JSON.stringify(statusList));
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});
4. 设置自己的状态
//设置自己的状态
TXIM.setSelfStatus({
customStatus: "正在听歌"//用户的自定义状态, 最大 100 字节
}, {
onSuccess: () => {
console.log("onSuccess");
},
onError: (code, desc) => {
console.log("onError: code=" + code + ", desc=" + desc);
}
});

收藏人数:
购买源码授权版(
试用
赞赏(0)
下载 3313
赞赏 2
下载 12622368
赞赏 1950
赞赏
京公网安备:11010802035340号