更新记录

1.0.1（2024-02-01）

无

1.0.0（2024-02-01）

无

平台兼容性

云函数类插件通用教程

使用云函数类插件的前提是：使用HBuilderX 2.9+

使用的页面引入

import yqbIm from '@/uni_modules/yqb-im/lib/main.js'

IM 对象

 {
    state: {
        conversation: {
            dataList: [],  会话数据列表
            hasMore: true  是否还有更多会话数据
        },
        currentConversationId: false,  正在对话的会话id
         会话分组
        groupingList: {
            0: { _id: 0, name: '全部消息', num: 0 },
            1: { _id: 1, name: '单聊', num: 0 },
            2: { _id: 2, name: '群聊', num: 0 },
            3: { _id: 3, name: '未读消息', num: 0 },
        },
        usersInfo: {},  存储所有出现过的用户信息，包括群好友信息
        groupInfo: {},  存储所有出现过的群信息
        isWidescreen: false,  是否为pc宽屏
        systemInfo: {} 系统信息
    },
    methods: {
        toChat,  前往会话页面
        conversation: {
            get,  前往会话页面
            revokeMsg,  撤回消息
            removeMsg,  删除消息
            loadMore,  会话列表
            hide,  隐藏会话
            setTop,  会话置顶
            userInfoChage,  用户数据更改
            setRemind,  设置免打扰
            clearChatLog,  清除聊天记录
            performTasks,  执行离线任务
        },
        group: {
            inviteMember,  邀请加入群聊
            removeMember,  删除群成员
            loadMember,  加载群成员信息
            dissolveGroupChat,  解散群聊
            createConversation,  创建群聊
            editGroupInfo,  修改群信息
        },
        grouping: {
            setGrouping,  设置会话分组
            get,  获取分组
            statistics,  统计每个分组下的会话数量
            create,  添加分组
            update,  更新/修改 分组信息
            delete  删除分组
        }
    }
}

发送文件需自行引入文件选择器

小程序端 需勾选 manifest.json->微信小程序配置->uniPush 且在微信后台配置 socket 合法域名

wss://wshzn.gepush.com wss://wshzn.getui.net

推送结构

{
  "user_id": [${user_id}],
  "payload": {
      type: "yqb-im",
      data: msgData,
      title, // "收到im消息，在线时显示的标题",
      content, // "在线时显示的副标题",
     },
  title: title, // "收到im消息，离线时显示的标题",
  content: title,//"离线时显示的内容"
}

payload.type 现有类型

yqb-im // 常规会话 
yqb-im-group-exit // 用户退群
yqb-im-revoke-msg // 消息撤回
yqb-im-user-info-change // 用户数据变化

前往会话页面

yqbIm.toChat

请求参数

使用示例

yqbIm.toChat(conversation_id)

yqbIm.toChat({
  conversation_id: ""
})

yqbIm.toChat({
  user_id: ""
})

yqbIm.toChat({
  group_id: ""
})

单聊

发起会话 / 获取会话对象

yqbIm.conversation.get

请求参数

使用示例

yqbIm.conversation.get(conversation_id)

yqbIm.conversation.get({
  conversation_id: ""
})

yqbIm.conversation.get({
  user_id: ""
})

yqbIm.conversation.get({
  group_id: ""
})

撤回消息

yqbIm.conversation.revokeMsg

请求参数

使用示例

await yqbIm.conversation.revokeMsg({
    _id: ""，
  conversation_id: "",
  user_id: "", 
  create_time: ""
})

删除消息

yqbIm.conversation.removeMsg

请求参数

使用示例

await yqbIm.conversation.removeMsg({
    _id: ""，
  conversation_id: "",
  user_id: "", 
  create_time: ""
})

获取会话列表

yqbIm.conversation.loadMore

请求参数

使用示例

yqbIm.conversation.loadMore()

群聊

邀请加入群聊

yqbIm.group.inviteMember

请求参数

使用示例

await yqbIm.group.inviteMember({
  user_ids: [],
  group_id: '' 
})

删除群成员

yqbIm.group.removeMember

请求参数

使用示例

await yqbIm.group.removeMember({
  user_id: [],
  group_id: '' 
})

加载群成员信息

yqbIm.group.loadMember

请求参数

使用示例

await yqbIm.group.loadMember({
  group_id: '',
  type: 0 ,
})

解散群聊

yqbIm.group.dissolveGroupChat

请求参数

使用示例

await yqbIm.group.dissolveGroupChat({
  group_id: '',
})

创建群聊

yqbIm.group.createConversation

请求参数

使用示例

await yqbIm.group.createConversation({
    userId:'',
  memberId: [],
})

unicloud 项目结构

// 项目结构

// 控制器
├── package.json
├── index.js 
├── config.js 
├── controller  // 控制器
|   ├── im
|       ├── conversation    
|       ├── group   
|       ├── msg
|       ├── statistics  // 消息统计
|   ├── init    // 云服务初始化类
|   ├── msg     // 消息对外接口
|   ├── user    // 用户数据同步
├── service // 逻辑层  
|   ├── msg // 消息收发处理接口

基础API

发送消息

/msg/sendMsg

请求参数

请求示例

{
  * "appId": "__UNI__B2E3757", // 推送指向 APP_ID
  "push": true, 
  // app:小秘书 approval:0A审批助手 attendance:考勤助手 calendar:日历助手 work:工作通知 order:订单通知 ... 
  // 可通过 系统用户创建接口创建 自定义系统用户   
  * "from_uid": "app",  
  "mapp ing" : {}, // 使用自定义系统用户时  mapping 必传
  "version": "100", // 版本号
  "type": "...", // 消息类型 - 【text,image,video,sound】固定有类型  模板消息填入模板类型
  "to_uid": "64d2f5368b0da41af05698d4",
  "title": "...",
  "content": "...",
  "body": {
      * "template":"...", //模板类型 模板消息必填项 /
      "version":"100", // 版本号
      "extend": { // 模板消息 内置数据
         ...
      }
}

创建用户

/msg/createSystemUser

请求参数

请求示例

{
  "name": "测试系统用户",
  "avatarFile": ...,
  "type": ...,
  "mapping": {
    ...
  }
}