环信IM即时通讯 - QQ 小程序集成介绍
文档简介:
前提条件:
注册环信账号:
开发者需要在环信管理后台 注册并创建应用,来获取唯一 appKey,SDK 初始化时需要配置 appKey。
实现步骤:
搭建 QQ 小程序开发环境。
首先需要下载并安装 开发者工具 (opens new window),然后按照 QQ 小程序的 接入流程 (opens new window)一步步创建一个小程序。
前提条件
注册环信账号
开发者需要在环信管理后台 注册并创建应用,来获取唯一 appKey,SDK 初始化时需要配置 appKey。
实现步骤
搭建 QQ 小程序开发环境
首先需要下载并安装 开发者工具 (opens new window),然后按照 QQ 小程序的 接入流程 (opens new window)一步步创建一个小程序
配置服务器域名
小程序在发布前,需要配置合法域名。
登录 QQ 小程序 开发者平台 (opens new window),进入 “开发 > 开发设置” 页面配置以下服务器地址。
提示
request合法域名:
- https://a1.easemob.com
- https://a2.easemob.com
- https://a3.easemob.com
- https://a4.easemob.com
- https://a5.easemob.com
提示
socket 合法域名:
- wss://im-api.easemob.com(2.0 IM SDK)
- wss://im-api-wechat.easemob.com(3.0 IM SDK)
注意
为满足不同客户的业务需求,环信在多地部署了数据中心。不同数据中心的 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 将不能连接上服务器。
集成 SDK
下载 SDK
可以通过以下两种方式获取 SDK:
- 通过官网 下载 SDK(opens new window)
- 从环信的 github 仓库 (opens new window)中获取 SDK 中的文件
引入 SDK
-
开始一个全新的项目
- 将下载的 SDK(src/sdk/)导入到自己的项目中。
- 引入 SDK:import IMSDK from "../sdk/Easemob-chat-miniProgram";
- 基于 Demo 二次开发
将下载的代码导入开发者工具即可运行起来。
调用示例
// 使用示例 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 端文档。