开发者需要在环信管理后台注册并创建应用,来获取唯一 appKey,SDK 初始化时需要配置 appKey。
小程序在发布前,需要配置合法域名。
登录QQ小程序开发者平台, 进入“开发 > 开发设置”页面配置以下服务器地址。
注意:
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 REST API 请求域名、WebSocket 访问域名不同。请根据您所在数据中心进行配置。
环信不同数据中心的 REST API 请求域名、WebSocket 访问域名:
数据中心 | REST API 请求地址 | WebSocket 访问域名 |
国内 1 区 | a1.easemob.com | im-api-wechat.easemob.com |
国内 2 区 | a31.easemob.com | im-api-wechat-31.easemob.com |
国内 VIP 区 | 请咨询商务经理 | 请咨询商务经理 |
客服专用 | 请咨询商务经理 | 请咨询商务经理 |
应用所在数据中心可以在环信用户管理后台>应用信息中查看:
QQ、微信小程序: 1.7.0 及以上版本,最多可以同时存在 5 个 WebSocket 连接,需开发者控制好连接数量,超出此限制 SDK 将不能连接上服务器。
将下载的代码导入开发者工具即可运行起来。
//使用示例
import SDK from "../sdk/connection"; // 2.0 SDK
import SDK from "../sdk/Easemob-chat-miniProgram"; // 3.0 SDK
实例化 SDK,并挂载在全局对象下
//实例化 SDK 对象
const WebIM = wx.WebIM = SDK;
WebIM.conn = new WebIM.connection({
appKey: 'your appKey',
https: true, //是否使用 HTTPS
url: 'wss://im-api-wechat.easemob.com/websocket', // socket server (3.0 SDK)
apiUrl: 'https://a1.easemob.com', // rest server
heartBeatWait: 30000, //心跳间隔
autoReconnectNumMax: 5, //自动重连次数
useOwnUploadFun: false // 是否使用自己的上传方式(如将图片文件等上传到自己的服务器,构建消息时只传 URL)
});
IM 基本功能和 Web 端一致,请参考 Web 端文档。