更新记录

1.0.0（2025-06-20）

新版发布。

平台兼容性

uni-app

uni-app x

腾讯云即时通信 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 等级
                logListener:{
                    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. 添加SDK 监听回调事件

//添加SDK 监听回调事件
TXIM.addIMSDKListener({
    onConnecting: () => {
        console.log("onConnecting");
    },
    onConnectSuccess: () => {
        console.log("onConnectSuccess");
    },
    onConnectFailed: (code, error) => {
        console.log("onConnectFailed: code=" + code + ", error=" + error);
    }
});

4. 移除 SDK 事件监听回调事件

移除 SDK 事件监听回调事件
TXIM.removeIMSDKListener();

5. 登录

//登录
let userID = "xxx";
let userSig = "xxx";
TXIM.login(userID, userSig, {
    onSuccess: () => {
        console.log("login onSuccess");
    },
    onError: (code, desc) => {
        console.log("login onError: code=" + code + ", desc=" + desc);
    }
});

6. 登出

//登出
TXIM.logout({
    onSuccess: () => {
        console.log("logout onSuccess");
    },
    onError: (code, desc) => {
        console.log("logout onError: code=" + code + ", desc=" + desc);
    }
});

7. 获取登录状态, 如果用户已经处于已登录和登录中状态，请勿再频繁调用登录接口登录。

// 获取登录状态, 如果用户已经处于已登录和登录中状态，请勿再频繁调用登录接口登录。  
// return number 未知状态(0) 已登录(1) 登录中(2) 无登录(3)
let status = TXIM.getLoginStatus();
console.log(status);

8. 获取登录用户

// 获取登录用户   
// return string 登录用户userID
let userID = TXIM.getLoginUser();
console.log(userID);

简单消息收发接口

1. 添加 基本消息（文本消息和自定义消息）回调事件

//添加 基本消息（文本消息和自定义消息）回调事件
TXIM.addSimpleMsgListener({
    onRecvC2CTextMessage: (msgID, sender, text) => {
        console.log(msgID);
        console.log(JSON.stringify(sender));
        console.log(text);
    },
    onRecvGroupTextMessage: (msgID, groupID, sender, text) => {
        console.log(msgID);
        console.log(groupID);
        console.log(JSON.stringify(sender));
        console.log(text);
    }
});

2. 移除 基本消息（文本消息和自定义消息）回调事件

//移除 基本消息（文本消息和自定义消息）回调事件
TXIM.removeSimpleMsgListener();

3. 发送单聊普通文本消息

//发送单聊普通文本消息
let text = "text content 哈哈";//发送文本
let userID = "xxx";//用户ID
TXIM.sendC2CTextMessage(text, userID, {
    onSuccess: () => {
        console.log("sendC2CTextMessage onSuccess");
    },
    onError: (code, desc) => {
        console.log("sendC2CTextMessage onError: code=" + code + ", desc=" + desc);
    }
});

4. 发送群聊普通文本消息

//发送群聊普通文本消息
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("sendGroupTextMessage onSuccess");
    },
    onError: (code, desc) => {
        console.log("sendGroupTextMessage onError: code=" + code + ", desc=" + desc);
    }
});
console.log(msgID);

群组相关接口

1. 添加群组事件

///添加群组事件
TXIM.addGroupListener({
    onGroupCreated: (groupId) => {
        console.log("onGroupCreated groupId=" + groupId);
    },
    onGroupDismissed: (groupID, opUser) => {
        console.log("onGroupDismissed groupId=" + groupId);
    },
    onGroupRecycled: (groupID, opUser) => {
        console.log("onGroupRecycled groupId=" + groupId);
    }
});

2. 移除群组事件

//移除群组事件
TXIM.removeGroupListener();

3. 创建群组

//创建群
let groupType = "AVChatRoom";//群类型
let groupID = "123";//群ID
let groupName = "直播群";//群名称
TXIM.createGroup(groupType, groupID, groupName, {
    onSuccess: (groupID) => {
        console.log("createGroup onSuccess groupID=" + groupID);
    },
    onError: (code, desc) => {
        console.log("createGroup onError: code=" + code + ", desc=" + desc);
    }
});

4. 加入群组

//加入群组
let groupID = "123";//群ID
let message = "";//加群消息
TXIM.joinGroup(groupID, message, {
    onSuccess: () => {
        console.log("joinGroup onSuccess");
    },
    onError: (code, desc) => {
        console.log("joinGroup onError: code=" + code + ", desc=" + desc);
    }
});

5. 退出群组

//退出群组
let groupID = "123";//群ID
TXIM.quitGroup(groupID, {
    onSuccess: () => {
        console.log("quitGroup onSuccess");
    },
    onError: (code, desc) => {
        console.log("quitGroup onError: code=" + code + ", desc=" + desc);
    }
});

6. 解散群组

//解散群组
let groupID = "123";//群ID
TXIM.dismissGroup(groupID, {
    onSuccess: () => {
        console.log("dismissGroup onSuccess");
    },
    onError: (code, desc) => {
        console.log("dismissGroup onError: code=" + code + ", desc=" + desc);
    }
});