IM即时通讯

收发消息

接收消息

接收消息需要先设置消息回调监听,所有的 IM 回调消息都通过类似形式的通知,这里我们只举例接收新消息接口OnRecvNewMsgs,更多通知函数请参考消息模块

  • 回调接口:
// 收到新消息
IMSDK.on(IMEvents.OnRecvNewMsgs, ({ data }) => {
  // 收到消息后,根据消息类型contentType进行UI展示
});

相关 API 请参考:

发送消息

发送消息需要先构造消息实例,支持构造的消息类型有普通文本、图片、视频、文件、音频、地理位置、引用、转发、@xxx 等消息,构造完消息后调用 SDK 的发送接口即可完成消息的发送

创建文本消息

  • 调用接口:
const message = IMSDK.createTextMsg("这是一条文本消息");

相关 API 请参考:

创建多媒体消息

多媒体消息支持的媒体类型包括图片、视频、语音、文件。
我们提供了两种方式发送多媒体消息,一种是 SDK 上传文件,一种是发送方自行上传,这里我们以图片消息为例分别说明。

SDK上传文件

发送方调用发送消息接口后,SDK内部会负责把文件上传到IM系统OSS存放,接收方收到消息后自行下载。
  • 调用接口:
let file;   //这是一个图片File对象
const picBaseInfo = {
    uuid: "uuid",
    type: file.type,
    size: file.size,
    width: 1920, //图像宽高可以加载img再读取
    height: 1080,
}

const message = IMSDK.createImageMsgByFile({
    sourcePicture: picBaseInfo;
    bigPicture: picBaseInfo;
    snapshotPicture: picBaseInfo;
    sourcePath: "";
    file: file
})

相关 API 请参考:

创建位置消息

创建位置消息需要开发者采集到经纬度参数

  • 调用接口:
const message = IMSDK.createLocationMsg({
  description: "位置描述",
  longitude: 116.4074,
  latitude: 39.9042,
});

相关 API 请参考:

创建自定义消息

创建自定义消息的消息内容需要使用 json 字符串

  • 调用接口:
const message = IMSDK.createCustomMsg({
  data: "xxx",
  extension: "xxx",
  description: "xxx",
});

相关 API 请参考:

发送消息

用于所有 IM 消息的发送

  • 调用接口:
const newMessage = IMSDK.createTextMsg("这是一条文本消息");

const { data: successMessage } = await IMSDK.sendMsg({
  recvID: "xxx",
  groupID: "xxx",
  message: newMessage,
});

相关 API 请参考: