IM功能

mtl支持版本6.0.11及以上

插件名称：IM聊天

添加插件所需参数

字段 类型 必填 说明
APP_ID string 是 应用ID
ETP_ID string 是 租户ID
server string 是 长链接地址
restServer string 是 短链接地址
resourceUploadServer string 否 资源上传服务地址
resourceDownloadServer string 否 资源下载服务地址
serverPort number 是 服务器端口
serverSSLPort number 是 SSL端口
serverHttps string 否 默认http。https, http
serverEnableSSL boolean 否 是否开启SSL端口，默认true

注意：该插件依赖于地图插件<高德地图(带界面)>

登陆

loginIM

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
userId string 是 用户ID
paswword string 是 密码
imToken sting 是 token
expiration string 是 token过期时间

**示例 **<数据格式>

mtl.im.loginIM({
  userId: '',
  paswword: '',
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

退出

logoutIM

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数
-无-
**示例 **<数据格式>

mtl.im.logoutIM({
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

打开聊天页面

openChat

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 聊天ID
chatType string 是 单聊或群聊。chat、groupchat
messagePid string 否 搜索时需要此参数
bundle obj 是 头像跳转和设置跳转的数据类
{
avatar:'xxxx', //跳转时需要传chatId
setting: 'xxxx' //跳转时需要传chatId和chatType
}

**示例 **<数据格式>

mtl.im.openChat({
  chatId:'xxx',
  chatType: 'chat';
  success: function(res) {
    // 成功回调
        ...
    const data = res.data,
    const action = res.action,// setting设置页面、forward转发、avatar头像
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

获取消息未读书

getUnreadMsgCount

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数
-无-
**示例 **<数据格式>

mtl.im.getUnreadMsgCount({
  success: function(res) {
    // 成功回调
        const count = res.count
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

获取消息列表

getRecentMessage

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数
-无-
**示例 **<数据格式>

mtl.im.getRecentMessage({
  success: function(res) {// 数组列表
    // 成功回调
        const list = res.list
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

获取更新消息

getReceiveMessage

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数
-无-
**示例 **<数据格式>

mtl.im.getReceiveMessage({
  success: function(res) {// 消息对象
    // 成功回调
    const data = res.data;
    const count = data.count;
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

搜索人员、群组和消息

doSearch

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 默认值 说明
text string 是
搜索内容
searchType int 是 3 搜索类型。1: 消息搜索；2:群组搜索；3:消息+群组搜索；
类型为3时，超过三条数据只返回三条数据， loadMore:true
chatId string 否
消息ID。 (在此消息内搜索聊天内容)

**示例 **<数据格式>

mtl.im.doSearch({
  text: "123",
  searchType: 3,
  success: function(res) {// 消息对象
    // 成功回调
    const data = res.data;
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

创建群聊

createChatGroup

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
groupName string 是 群组名称
userIds obj 是 群组人员(用户ID列表)
groupPhoto string 否 群头像 base64格式

**示例 **<数据格式>

mtl.im.createChatGroup({
  groupName：'ssss',
  userIds:['userids','userids1'],
  success: function(res) {
    // 成功回调
        const chatid = res.data.chatId
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

获取全部群成员

getGroupMembers

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 默认值 说明
chatId string 是
群组ID
limit int 否 0 指定个数(默认全部)

示例** <数据格式>**

mtl.im.getGroupMembers({
  chatId：'ssss',
  limit:10,
  success: function(res) {
    // 成功回调。 
    const data = res.data
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

修改群名称

renameChatGroupName

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID
groupName string 是 群组名称

示例** <数据格式>**

mtl.im.renameChatGroupName({
  chatId：'ssss',
  groupName:'123',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

设置群公告

modifyChatGroupAnnounce

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID
announce string 是 公告内容

示例** <数据格式>**

mtl.im.modifyChatGroupAnnounce({
  chatId：'ssss',
  announce:'123',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

添加群成员

inviteRosterIntoChatGroup

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID
userIds obj 是 人员(用户ID列表)

示例** <数据格式>**

mtl.im.inviteRosterIntoChatGroup({
  chatId：'ssss',
  userIds:['123','234'],
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

删除群成员

kickGroupMember

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID
userIds obj 是 人员(用户ID列表)

示例** <数据格式>**

mtl.im.kickGroupMember({
  chatId：'ssss',
  userIds:['123','234'],
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

删除并退出群聊

leaveChatGroup

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID

**示例 **<数据格式>

mtl.im.leaveChatGroup({
  chatId：'ssss',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

转让群组

changeChatGroupAdmin

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID
userId string 是 人员(用户ID)

示例** <数据格式>**

mtl.im.changeChatGroupAdmin({
  chatId：'ssss',
  userId:'123',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

解散群组

dismissChatGroup

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 群组ID

**示例 **<数据格式>

mtl.im.dismissChatGroup({
  chatId：'ssss',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

消息置顶

updateStickTop

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 聊天ID
chatType string 是 单聊或群聊。chat、groupchat
stickTop boolean 是 是否置顶

**示例 **<数据格式>

mtl.im.updateStickTop({
  chatId：'ssss',
  chatType：'chat',
  stickTop：true,
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

消息免打扰

updateNoDisturb

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 聊天ID
chatType string 是 单聊或群聊。chat、groupchat
noDisturb boolean 是 是否免打扰

示例** <数据格式>**

mtl.im.updateNoDisturb({
  chatId：'ssss',
  chatType：'chat',
  noDisturb：true,
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

删除消息

deleteMessage

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 聊天ID
chatType string 是 单聊或群聊。chat、groupchat

示例** <数据格式>**

mtl.im.deleteMessage({
  chatId：'ssss',
  chatType：'chat',
  success: function(res) {
    // 成功回调。 
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

转发消息

forwardMessage

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 聊天ID
chatType string 是 单聊或群聊。chat、groupchat
messagePid string 是 消息ID

**示例 **<数据格式>

mtl.im.forwardMessage({
  chatId:'',
  chatType:'caht',
  pid:'',
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

获取用户、群组信息

getContactInfo

支持平台

微信 友空间 安卓 iOS
✘ ✘ ✔︎ ✔︎

参数

字段 类型 必填 说明
chatId string 是 用户、群组ID
chatType string 是 单聊或群聊。chat、groupchat

**示例 **<数据格式>

mtl.im.getContactInfo({
  chatId:'',
  chatType:'',
  success: function(res) {
    // 成功回调
        ...
    const group = res.data
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});
是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24