https://docs-im.easemob.com/ 2026-04-05T16:34:48+00:00 https://docs-im.easemob.com/ https://docs-im.easemob.com/lib/tpl/bootstrap3_ori/images/favicon.ico text/html 2018-11-06T11:49:32+00:00 https://docs-im.easemob.com/im/400webimintegration/10webimintro?rev=1541504972&do=diff Web IM 介绍 注意： Web SDK 已更新至 V1.4.12 版本，从 V1.1.2 版本开始和 V1.1.1 差异较大，如果您是 Web SDK 的新用户，请参考本文档集成最新版本。如果您已集成 V1.1.1，并希望再次了解其集成方式，可参考 text/html 2018-11-06T11:50:23+00:00 https://docs-im.easemob.com/im/400webimintegration/20sdkintegration?rev=1541505023&do=diff 集成方式 ---------- 集成 可以通过以下三种方式引用web sdk，其中后两种为从版本1.4.5开始新增的引用方式： * 将文件复制到本地，引用本地文件； * 添加<script>标签，引用线上文件； * 使用NPM。 text/html 2018-11-06T11:51:01+00:00 https://docs-im.easemob.com/im/400webimintegration/25intiate?rev=1541505061&do=diff Web SDK基础功能 初始化 创建连接 var conn = new WebIM.connection({ isMultiLoginSessions: WebIM.config.isMultiLoginSessions, https: typeof WebIM.config.https === 'boolean' ? WebIM.config.https : location.protocol === 'https:', url: WebIM.config.xmppURL, heartBeatWait: WebIM.config.heartBeatWait, autoReconnectNumMax: WebIM.config.autoReconnectNumMax, autoReconnectInterval: WebIM.config.autoReconnectInterval, apiUrl: WebIM.config.apiURL, isAutoLogin: true });… text/html 2018-11-06T11:51:32+00:00 https://docs-im.easemob.com/im/400webimintegration/30singlechat?rev=1541505092&do=diff 消息 发送消息 发送文本消息（单聊） 单聊发送文本消息示例如下。 // 单聊发送文本消息 var sendPrivateText = function () { var id = conn.getUniqueId(); // 生成本地消息id var msg = new WebIM.message('txt', id); // 创建文本消息 msg.set({ msg: 'message content', // 消息内容 to: 'username', // 接收消息对象（用户id） roomType: false, success: function (id, serverMsgId) { console.log('send private text Success'); }, fail: function(e… text/html 2018-11-06T11:52:14+00:00 https://docs-im.easemob.com/im/400webimintegration/40groupchat?rev=1541505134&do=diff 群组管理 ---------- 获取群组列表 调用listRooms函数获取当前登录用户加入的群组列表，示例如下。 // 列出所有群组 var listGroups = function () { var option = { success: function (rooms) { console.log(rooms); }, error: function () { console.log('List groups error'); } }; conn.listRooms(option); }; text/html 2018-09-05T09:55:00+00:00 https://docs-im.easemob.com/im/400webimintegration/40restgroupchat?rev=1536141300&do=diff 群组管理 注意： 从Web SDK V1.4.11开始，群组管理的接口都已更新了Rest版本，V1.4.10 (包括V1.4.10)以下版本仍然保留XMPP版本，如果需要继续使用XMPP版本的接口，请参考群组管理 ---------- 获取用户加入的群组列表 text/html 2018-11-06T11:52:34+00:00 https://docs-im.easemob.com/im/400webimintegration/41chatroom?rev=1541505154&do=diff 聊天室管理 获取聊天室列表 // 列出所有聊天室，支持分页查询 var listRooms = function () { var option = { apiUrl: 'https://a1.easemob.com', pagenum: 1, // 页数 pagesize: 20, // 每页个数 success: function (list) { console.log(list); }, error: function () { console.log('List chat room error'); } }; conn.getChatRooms(option); }… text/html 2018-11-06T11:53:18+00:00 https://docs-im.easemob.com/im/400webimintegration/60toolrelated?rev=1541505198&do=diff 工具类说明 ---------- 文件上传下载判断 //是否能上传file WebIM.utils.isCanUploadFile; //是否能下载file WebIM.utils.isCanDownLoadFile ; //是否设置header WebIM.utils.hasSetRequestHeader; //是否设置mimetype WebIM.utils.hasOverrideMimeType; text/html 2018-11-06T11:53:51+00:00 https://docs-im.easemob.com/im/400webimintegration/90webimreleasenote?rev=1541505231&do=diff Web IM SDK 更新日志 ---------- 版本：v1.4.13 2017-09-12 新功能： * [sdk] 新增jsdoc Bug修复： * [sdk] ios(8.1)webview 已读和已送到回执异常 * [sdk] 多设备登录异常 * [demo] 多设备登录异常 版本：v1.4.12 2017-07-17 text/html 2018-11-06T11:53:36+00:00 https://docs-im.easemob.com/im/400webimintegration/api-doc?rev=1541505216&do=diff Web SDK API Doc * Web SDK 接口列表 text/html 2018-11-06T11:51:52+00:00 https://docs-im.easemob.com/im/400webimintegration/contactmanagement?rev=1541505112&do=diff 好友管理 参数解释 名称 字段名 数据类型 描述环信 ID username String 环信 ID 是环信用户的唯一标识，在 AppKey 的范围内唯一 查询好友列表 查询好友列表时，要注意 subscription (both, to, from) 为不同值的处理。此处默认 both 和 to 的为好友，开发者自定义处理，保持跟 APP 端处理一致即可。 text/html 2018-11-06T11:52:55+00:00 https://docs-im.easemob.com/im/400webimintegration/videocall?rev=1541505175&do=diff 实时通话 Web IM SDK 支持实时通话功能。用户可以与好友进行实时视频聊天。 注意：视频通话功能只支持https+Webkit浏览器。 集成步骤 集成步骤如下： 1. 在html中引入以下文件。其中，前三个为集成Web IM SDK必须引用的文件，后两个为集成即时视频功能需要引用的文件。 text/html 2018-09-05T09:55:00+00:00 https://docs-im.easemob.com/im/400webimintegration/webim-h5?rev=1536141300&do=diff WebIM H5 Demo 介绍 WebIM H5 Demo 支持移动设备布局 (WebIM 1.x 只支持PC浏览器) GitHub 下载地址：<https://github.com/easemob/webim> 版本支持 WebIM H5 支持所有现代浏览器，支持手机微信和QQ。 目前暂不支持IE6-11，只支持Microsoft Edge。 text/html 2018-09-05T09:55:00+00:00 https://docs-im.easemob.com/im/400webimintegration/websdk1.1.1?rev=1536141300&do=diff Web SDK V1.1.1 集成说明 ---------- 注意： 这是 Web SDK V1.1.1 版本的集成说明，仅供未升级 Web SDK 版本的老用户参考。如果您是 Web SDK 的新用户，请集成 Web SDK 的最新版本（V1.1.2及以上），并阅读最新版集成说明：