https://docs-im.easemob.com/ 2026-04-21T17:05:36+00:00 https://docs-im.easemob.com/ https://docs-im.easemob.com/lib/tpl/bootstrap3_ori/images/favicon.ico text/html 2018-12-12T07:26:46+00:00 https://docs-im.easemob.com/start/400webimintegration/10webimintro?rev=1544599606&do=diff Web IM 介绍 ---------- 注意： Web SDK 已更新至 V1.4.5 版本，从 V1.1.2 版本开始和 V1.1.1 差异较大，如果您是 Web SDK 的新用户，请参考本文档集成最新版本。如果您已集成 V1.1.1，并希望再次了解其集成方式，可参考 text/html 2018-12-12T07:26:58+00:00 https://docs-im.easemob.com/start/400webimintegration/20sdkintegration?rev=1544599618&do=diff 集成方式 ---------- 集成 可以通过以下三种方式引用web sdk，其中后两种为版本1.4.5新增的引用方式： * 将文件复制到本地，引用本地文件； * 添加<script>标签，引用线上文件； * 使用NPM。 text/html 2018-12-12T07:27:09+00:00 https://docs-im.easemob.com/start/400webimintegration/25intiate?rev=1544599629&do=diff Web SDK基础功能 初始化 创建连接 var conn = new WebIM.connection({ https: WebIM.config.https, url: WebIM.config.xmppURL, isAutoLogin: WebIM.config.isAutoLogin, isMultiLoginSessions: WebIM.config.isMultiLoginSessions }); 添加回调函数 text/html 2018-12-12T07:27:21+00:00 https://docs-im.easemob.com/start/400webimintegration/30singlechat?rev=1544599641&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'); } }); msg.body.chat… text/html 2018-12-12T07:28:02+00:00 https://docs-im.easemob.com/start/400webimintegration/40groupchat?rev=1544599682&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-12-12T07:28:17+00:00 https://docs-im.easemob.com/start/400webimintegration/41chatroom?rev=1544599697&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-09-05T09:54:59+00:00 https://docs-im.easemob.com/start/400webimintegration/50exit?rev=1536141299&do=diff 退出 ---------- 关闭连接。 //SDK关闭连接并处理连接状态为CLOSED conn.close(); ---------- 上一页：聊天室 下一页：工具类说明 text/html 2018-12-12T07:28:52+00:00 https://docs-im.easemob.com/start/400webimintegration/60toolrelated?rev=1544599732&do=diff 工具类说明 ---------- 文件上传下载判断 //是否能上传file WebIM.utils.isCanUploadFile; //是否能下载file WebIM.utils.isCanDownLoadFile ; //是否设置header WebIM.utils.hasSetRequestHeader; //是否设置mimetype WebIM.utils.hasOverrideMimeType; text/html 2018-09-05T09:54:59+00:00 https://docs-im.easemob.com/start/400webimintegration/80webimfaq?rev=1536141299&do=diff 常见问题 ---------- 1. Web IM SDK 调用无效。 请检查 easemob.im-1.0.3.js 等相关文件引入的路径是否正确。 2. 是否支持 token 登录，是否支持 HTTPS？ 支持。详情请查看 easemob.im-1.0.3.js 和 index.html 相关内容。 text/html 2018-12-12T07:29:21+00:00 https://docs-im.easemob.com/start/400webimintegration/90webimreleasenote?rev=1544599761&do=diff Web IM SDK 更新日志 ---------- 版本：v1.4.10 2017-02-16 新功能： * [sdk] webrtc新增语音呼叫 Bug修复： * [sdk] webrtc:Firefox在结束通话后的问题 * [sdk] webrtc:多次接通挂断之后,逻辑功能混乱 * [sdk] webrtc:正常挂断不应该提醒offline text/html 2022-02-21T09:27:05+00:00 https://docs-im.easemob.com/start/400webimintegration/api-doc?rev=1645435625&do=diff Web SDK API Doc * Web SDK 接口列表 ---------- 上一页：工具类说明 下一页：Web IM SDK 更新日志 text/html 2018-09-05T09:54:59+00:00 https://docs-im.easemob.com/start/400webimintegration/contact_management?rev=1536141299&do=diff 好友管理 查询好友列表 查询好友列表时，要注意 subscription (both, to, from) 为不同值的处理。此处默认 both 和 to 的为好友，开发者自定义处理，保持跟 APP 端处理一致即可。 conn.getRoster({ success: function ( roster ) { //获取好友列表，并进行好友列表渲染，roster格式为： /** [ { jid:'asemoemo#chatdemoui_test1@easemob.com', name:'test1', subscription: 'both' } ] */ for ( var i = 0, l = roster.length; i < l; i++ ) { var ros = roster[i]; //ros.subscription值为both/to为要显示的联系人，此处与APP需保持一致… text/html 2018-12-12T09:13:02+00:00 https://docs-im.easemob.com/start/400webimintegration/contactmanagement?rev=1544605982&do=diff 好友管理 参数解释 名称 字段名 数据类型 描述环信 ID username String 环信 ID 是环信用户的唯一标识，在 AppKey 的范围内唯一 查询好友列表 查询好友列表时，要注意 subscription (both, to, from) 为不同值的处理。此处默认 both 和 to 的为好友，开发者自定义处理，保持跟 APP 端处理一致即可。 text/html 2018-12-12T07:28:31+00:00 https://docs-im.easemob.com/start/400webimintegration/videocall?rev=1544599711&do=diff 实时通话 Web IM SDK 支持实时通话功能。用户可以与好友进行实时视频聊天。 注意：视频通话功能只支持https+Webkit浏览器。 集成步骤 集成步骤如下： 1. 在html中引入以下文件。其中，前三个为集成Web IM SDK必须引用的文件，后两个为集成即时视频功能需要引用的文件。 text/html 2018-09-05T09:54:59+00:00 https://docs-im.easemob.com/start/400webimintegration/websdk1.1.1?rev=1536141299&do=diff Web SDK V1.1.1 集成说明 ---------- 注意： 这是 Web SDK V1.1.1 版本的集成说明，仅供未升级 Web SDK 版本的老用户参考。如果您是 Web SDK 的新用户，请集成 Web SDK 的最新版本（V1.1.2及以上），并阅读最新版集成说明：