环信小程序SDK简介

环信小程序 SDK 为小程序开发提供一套完整的技术解决方案,在微信小程序的开发环境下,集成 IM 相关的功能更加便捷、高效。让您的小程序快速获得安全稳定的 IM 能力,集成简单,使用方便,帮助您快速拓展业务,赢得先机。

扫描下方小程序二维码,或者微信搜索环信即时通讯云即可快速体验环信小程序 Demo 在线版本

注意:

  • 小程序 Demo 只包含部分 IM 功能,详细参考功能说明
  • 小程序 Demo 源码可在官网下载页 获取

环信微信小程序 WebIM 在微信生态系统进行优化,功能与微信对接更为流畅:

  • 支持账户注册登录
  • 支持 IM 基本功能收发文本、图片、语音、视频、音频、文件、透传、扩展消息等
  • 支持 群组聊天室功能
  • 支持个人设置

集成前准备

搭建小程序开发环境

小程序自己有一个专门的微信开发者工具最新版本下载地址。 按照提示一步步安装好就行,然后用微信扫描二维码登陆。 至此小程序的开发环境差不多完成。

配置服务器域名

登录微信公众平台,进入“开发 > 开发设置”页面,配置以下服务器地址:

  • request 合法域名, uploadFile 合法域名
  • socket合法域名

wss://im-api.easemob.com

将SDK添加到自己的小程序

下载SDK

可以通过以下两种方式获取SDK:

引入SDK

  • 开始一个全新的项目
    1. 将 SDK 目录下(src/sdk/)的文件全部导入到自己的项目中。
    2. 直接使用 import/require 方式获取引用, 如果使用 mpvue 保持引文件方式的统一。
  • 基于 Demo 二次开发

拉取代码,导入开发者工具即可运行起来。

调用示例

//使用示例
import SDK from "../sdk/connection";

实例调用方式

采用单例模式,所有业务使用唯一实例

//实例化SDK对象
const WebIM = window.WebIM = SDK;
WebIM.conn = new WebIM.connection({
    isMultiLoginSessions: false, //是否可以登录多个网页,并在所有网页上接收消息
    https: false, //是否使用HTTPS 
    url: 'wss://im-api.easemob.com/ws/', //XMPP server
    apiUrl: 'https://a1.easemob.com',
    isAutoLogin: false, //自动登录
    heartBeatWait: 4500, //心跳间隔
    autoReconnectNumMax: 2, //自动重连次数
    autoReconnectInterval: 2, //每个重新连接之间的间隔秒, 自动重连次数大于1时有效。
});

上一章:Web IM 集成

下一页:基础功能