https://docs-im.easemob.com/ 2026-04-12T17:14:30+00:00 https://docs-im.easemob.com/ https://docs-im.easemob.com/lib/tpl/bootstrap3_ori/images/favicon.ico text/html 2022-06-14T10:00:34+00:00 https://docs-im.easemob.com/im/other/integrationcases/1v1video?rev=1655200834&do=diff 1对1音视频集成介绍 本文档已不再维护。 ---------- 一对一音视频用于实现1对1语音通话和1对1视频通话，典型场景包括社交交友，远程心理咨询、远程医疗、视频面试、一对一在线教育、远程视频辅助等。 text/html 2022-02-15T10:05:33+00:00 https://docs-im.easemob.com/im/other/integrationcases/appchat?rev=1644919533&do=diff 跨 APP 聊天 ---------- 注意： 该文档已更新，详见：集成类问题：如何实现跨 app 聊天。 如果您需要两个 APP 之间可以互相通信，只要将 AppKey 写成同一个就可以实现跨 APP 聊天。同时，您需要在环信管理后台上传对应 APP 的推送证书（可以是多个），这样可以确保您的两个 APP 都能收到推送。 text/html 2021-02-24T07:01:50+00:00 https://docs-im.easemob.com/im/other/integrationcases/appimnotifi?rev=1614150110&do=diff 安卓端保障新消息及时通知的常见实践 当app在后台运行时，环信IM SDK默认通过一个后台服务保持一条连接环信服务器的长连接。但Android为了解决系统待机性能差的问题，随着Android版本的升级逐渐禁止了app级别的后台服务的运行。所以在一些版本比较高的Android系统上会有APP进入后台后接收不到消息的情况。 text/html 2019-01-03T03:10:30+00:00 https://docs-im.easemob.com/im/other/integrationcases/end2end?rev=1546485030&do=diff 端到端加密方案 目的 用户可以在现有SDK及环信后台服务基础上实现端到端加密（End2End Encryption）。 目前环信暂不支持CA认证中心的服务，提供集成方案仅供参考。 方案概述 使用CA认证中心的方式来实现端到端加密服务。用户在某台设备第一次登录的时候会产生用户密钥相关信息，发送到CA认证中心进行保存。CA存储密钥相关信息包含以下内容： text/html 2020-02-07T07:48:52+00:00 https://docs-im.easemob.com/im/other/integrationcases/groupchat?rev=1581061732&do=diff 群成员信息保存方案 ---------- 方法一：群成员信息保存在环信服务器 * 环信服务器维护：groupid、owner、memeber、maxUser。 * APP服务器保存除以上属性外的其他数据 由手机端创建群：通过SDK提供的方法创建某群，创建成功后把所有数据（群ID、群头像、群名称、标签等信息）放到APP服务器留存，当用户通过条件（附近的群、条件筛选等）得到群列表，查看群信息时，通过 groupid 到自己服务器获取群的用户数据（群名称、类别、头像等信息），从环信服务器获取群的群成员信息。… text/html 2018-09-25T10:38:09+00:00 https://docs-im.easemob.com/im/other/integrationcases/groupchatat?rev=1537871889&do=diff 群组@功能 ---------- 群组中，@某人的和群组普通消息没有区别，只是针对被@的用户在 UI 上显示会有不同。可以通过环信的扩展消息来实现。 * 发送方将想要@的人的环信 ID 通过扩展字段放到扩展消息中，并把消息发到群里。 text/html 2019-06-12T12:48:02+00:00 https://docs-im.easemob.com/im/other/integrationcases/h?rev=1560343682&do=diff 主持模式 前言：本文将简要分享语音聊天室中主持玩法的的应用场景，并讲述基于环信语聊解决方案，实现主持玩法的步骤。 注：环信语聊解决方案是基于环信 SDK 3.6.0 及以上实现，开发者如需实现，需将 SDK 更新到支持版本。 text/html 2019-07-01T10:20:04+00:00 https://docs-im.easemob.com/im/other/integrationcases/host?rev=1561976404&do=diff 主持模式 前言：本文将简要分享语音聊天室中主持玩法的的应用场景，并讲述基于环信语聊解决方案，实现主持玩法的步骤。 注：环信语聊解决方案是基于环信 SDK 3.6.0 及以上实现，开发者如需实现，需将 SDK 更新到支持版本。 text/html 2024-06-05T09:17:04+00:00 https://docs-im.easemob.com/im/other/integrationcases/im-demo?rev=1717579024&do=diff IM即时通讯DEMO源码 Demo源码 我们在 Github 已经提供了一套完整的 Demo，大家可以在 Github 地上获取。 IM即时通讯各端demo源码： * Android * iOS * Web-Vue2 * Web-Vue3 * Web-React * 微信小程序 * uniapp（注：其余小程序均由uniapp生成） text/html 2019-07-02T04:34:56+00:00 https://docs-im.easemob.com/im/other/integrationcases/inputstatus?rev=1562042096&do=diff 输入状态提示 ---------- 输入状态提示：当A用户正在输入文字的时候，聊天的对方可以收到用户A正在输入的提示。 [输入状态提示] 监听用户A输入状态，一旦有文字输入，就每隔几秒通过透传消息将输入状态发送到聊天接受方B，B客户端收到输入状态透传后，提示用户A正在输入。 text/html 2022-06-14T10:00:56+00:00 https://docs-im.easemob.com/im/other/integrationcases/interactive-broadcast?rev=1655200856&do=diff 多人音视频互动直播集成介绍 本文档已不再维护。 ---------- 多人音视频互动直播的典型场景包括多人视频相亲、线上KTV、狼人杀直播、教育小班课、双师课等。 多人音视频互动直播场景的详细介绍，请详见环信音视频云文档： text/html 2023-04-26T07:00:04+00:00 https://docs-im.easemob.com/im/other/integrationcases/iosimnotifi?rev=1682492404&do=diff iOS端保障新消息及时通知的常见实践 iOS 系统因为不允许 app 在后台运行，所以在音视频场景下，会出现推送提醒不明显，从而错过对方发起的通话请求的情况。 解决这一问题的常见实践包括： text/html 2023-04-17T03:04:44+00:00 https://docs-im.easemob.com/im/other/integrationcases/live-chatroom?rev=1681700684&do=diff 直播聊天室集成介绍 ---------- 前言：本文将介绍环信直播聊天室的主要功能列表。并讲解基于环信直播聊天室，实现一个典型视频直播产品的步骤。 场景概述 视频直播已经是一种成熟的产品形态，在不同行业中有多种应用场景。在泛娱乐行业，游戏直播、秀场直播、演唱会直播等已经走进广大用户的日常生活；在电商行业，网红带货直播已经成为增长的新动能；在教育行业，1对多的教育直播也正在改变着整个行业的格局。视频直播占用着越来越多的用户使用时间。随着线上线下服务的进一步融合，视频直播也将会有迎来越来越多的使用场景。… text/html 2018-09-25T10:42:38+00:00 https://docs-im.easemob.com/im/other/integrationcases/locationshare?rev=1537872158&do=diff 实时位置共享 ---------- 实时位置共享： 向聊天参与者实时发送自己的位置信息。 [实时位置共享] 当A用户开启位置共享，需要实时监听自己的位置变化，同时在坐标变化时向B用户发送一条带有自己坐标的透传信息。 text/html 2020-11-26T08:22:48+00:00 https://docs-im.easemob.com/im/other/integrationcases/logfiles?rev=1606378968&do=diff 获取设备本地日志文件 ---------- 前言：在排查移动端集成或者使用问题的时候，会遇到需要查看设备本地SDK的log来确认问题，在此提供移动端获取本地log的方法 Android 日志路径： 3.x：/sdcard/Android/data/(包名)/(appkey)/core_log/easemob.log text/html 2022-06-14T10:00:45+00:00 https://docs-im.easemob.com/im/other/integrationcases/meeting?rev=1655200845&do=diff 多人音视频会议集成介绍 本文档已不再维护。 ---------- 多人音视频会议的典型场景包括企业多人视频会议、移动协同办公、远程医疗会诊、会诊模式的视频客服等。 多人音视频会议场景的详细介绍，请详见环信音视频云文档： text/html 2022-06-14T10:03:48+00:00 https://docs-im.easemob.com/im/other/integrationcases/messageloss?rev=1655201028&do=diff 排查 IM 消息丢失 该文档已更新，详见 如何排查环信即时通讯消息丢失。 ---------- 有时会有用户反馈IM丢消息。在这种情况下，我们建议先进行以下步骤自查。如果没发现问题，可以提交工单由环信技术支持同事协助排查。 text/html 2022-03-01T00:30:44+00:00 https://docs-im.easemob.com/im/other/integrationcases/movedata?rev=1646094644&do=diff 平滑迁移 ---------- 环信多年来一直在致力于提供稳定，安全的即时通讯服务，在开发者中积累了良好的口碑。如果您希望接入环信的IM服务，但正在使用自研或友商提供的即时通讯服务，这篇文档正是针对这一场景，介绍了一套迁移方案，这套方案已经成功为多家客户实现了平滑迁移。 text/html 2018-12-25T08:06:28+00:00 https://docs-im.easemob.com/im/other/integrationcases/nickname?rev=1545725188&do=diff 昵称和头像的显示与更新 ---------- [昵称和头像的获取和显示流程] 方法一：从APP服务器获取昵称和头像 * 昵称和头像的获取：当收到一条消息（群消息）时，得到发送者的用户ID，然后查找手机本地数据库是否有此用户ID的昵称和头像，如没有则调用APP服务器接口通过用户ID查询出昵称和头像，然后保存到本地数据库和缓存，下次此用户发来信息即可直接查询缓存或者本地数据库，不需要再次向APP服务器发起请求。… text/html 2020-06-22T16:01:11+00:00 https://docs-im.easemob.com/im/other/integrationcases/one2one?rev=1592841671&do=diff 1对1音视频集成介绍 一对一音视频用于实现1对1语音通话和1对1视频通话，典型场景包括社交交友，远程心理咨询、远程医疗、视频面试、一对一在线教育、远程视频辅助等。 一对一场景的详细介绍，请详见环信音视频云文档： text/html 2022-06-24T09:10:48+00:00 https://docs-im.easemob.com/im/other/integrationcases/revokemessages?rev=1656061848&do=diff 消息撤回 本文提及的方案已更新，详见 撤回消息 Android、撤回消息 iOS、撤回消息 Web。 ---------- 消息撤回可实现的场景例如，当A用户发消息给B用户后，可以在一段时间内将消息撤回。 [消息回撤过程] A用户发消息给B用户，当需要撤回的时候，将要撤回消息的id通过扩展消息发送给B，B检测到撤回的透传消息后，将对应 messageid 的消息从数据库删除。 text/html 2019-09-19T07:17:14+00:00 https://docs-im.easemob.com/im/other/integrationcases/robmic?rev=1568877434&do=diff 抢麦模式 前言：本文将简要分享语音聊天室中抢麦玩法的的应用场景，并讲述基于环信语聊解决方案，实现抢麦玩法的步骤。 注：环信语聊解决方案是基于环信 SDK 3.6.0 及以上实现，开发者如需实现，需将 SDK 更新到支持版本。 text/html 2020-02-05T14:56:45+00:00 https://docs-im.easemob.com/im/other/integrationcases/scene?rev=1580914605&do=diff 临场模式 前言：本文简要分享语音聊天室中临场模式的使用场景，并概述基于环信音视频会议实现临场模式切换的主要步骤。 注：环信语聊临场模式解决方案是基于环信 SDK3.6.1 及以上实现，开发者需要更新到此版本以上。临场模式环信以常见的杀人游戏白天、黑夜示例两种临时模式的切换，示例并非完整展示游戏的过程。仅提供切换方法和思路，以便开发者学习使用。 text/html 2023-05-15T09:46:40+00:00 https://docs-im.easemob.com/im/other/integrationcases/snapchat?rev=1684144000&do=diff 阅后即焚 ---------- 阅后即焚：用户A发送消息，当用户B接收并查看消息后，消息将同时从用户A和用户B的设备上删除。 [阅后即焚消息传递过程] 用户A发送消息给用户B，当用户B查看消息后，发送已读回执给用户A，并删除掉查看后的消息，用户A收到消息回执，同时删除消息。 text/html 2022-06-14T10:01:08+00:00 https://docs-im.easemob.com/im/other/integrationcases/tc?rev=1655200868&do=diff 语音连麦聊天室集成介绍 本文档已不再维护。 ---------- 语音连麦聊天室的典型场景包括语音电台、语音游戏、私人聊天房、多人语聊房、KTV 语聊房等。 语音连麦聊天室场景的详细介绍，请详见环信音视频云文档： text/html 2021-02-19T10:37:34+00:00 https://docs-im.easemob.com/im/other/integrationcases/userisonline?rev=1613731054&do=diff 如何判断用户是否在线 ---------- 1.在使用环信1v1音视频通话的场景下，比如A呼叫B，B在离线的情况下，A可以通过回调监听到B是离线的，使用方法如下： iOS端：详见 离线发推送 Android端： 详见 离线发推送 2.在使用环信基础聊天业务的场景下，需要知道一些用户是否在线，从而对自己的业务需求做处理。环信针对此种情况提供单个用户以及批量用户是否在线状态的查询： 详见… text/html 2022-07-22T02:33:17+00:00 https://docs-im.easemob.com/im/other/integrationcases/usersandfriends?rev=1658457197&do=diff 已上线应用的用户体系导入到环信 ---------- 集成概述 环信和用户体系的集成主要发生在2个地方，服务器端集成和客户端集成。参考 用户体系集成 REST API。 用户体系导入环信 环信只是即时通讯的消息通道。环信本身不提供用户体系，环信既不保存任何 APP 业务数据，也不保存任何 APP 的用户信息。比如说，你的 APP 是一个婚恋交友 APP，那么你的 APP 用户的头像、昵称、身高、体重、三围、电话号码等信息是保存在你自己的 APP 业务服务器上，这些信息不需要告诉环信。… text/html 2022-06-14T10:01:54+00:00 https://docs-im.easemob.com/im/other/integrationcases/usersystemintegration?rev=1655200914&do=diff 用户体系集成 本文档已不再维护，新版文档见：用户体系集成。 ---------- 前言:在集成环信时大家都会遇到集成用户体系的问题，环信服务器既不保存任何APP业务数据，也不保存任何APP的用户信息，用户体系的集成主要是在注册登录和好友关系。本文将简要分享下用户体系集成的步骤。 text/html 2022-06-14T10:01:26+00:00 https://docs-im.easemob.com/im/other/integrationcases/wechatintegration?rev=1655200886&do=diff IM+音视频在微信小程序和公众号的集成方法 本文档已不再维护。 ---------- （一）微信小程序 环信的IM+音视频支持微信小程序端的植入。但是由于微信对1对1实时音视频通话有限制，需要使用环信多人音视频会议来实现。具体创建方法如下： 1)发起方创建一个会议； 2)发起方加入会议； 3)发起方发送一条消息给接收方（邀请消息），消息里包含会议Id和会议密码信息； 4)接收方收到邀请消息后，也加入会议； 5)结束通话时，直接退出会议，另一方收到对方退出会议事件，也退出会议。 具体方法参考以下链接：http://docs-im.easemob.com/im/applet/multiuserconference. 注意：音视频部分如果小程序是重要场景，那么其他端例如App、Web端的音视频构建方法均需要与小程序端一致，即采用多人音视频会议方法实现1对1，其他不受影响。… text/html 2020-07-03T07:19:21+00:00 https://docs-im.easemob.com/im/other/integrationcases/whiteboard?rev=1593760761&do=diff 互动白板 ---------- 产品介绍 白板（Easemob-WhiteBoard）服务端基于socket.io，页面基于svg.js开发，所以兼容性参考上述两项即可。SDK提供了创建白板、加入白板、销毁白板三个API。加入到白板中的用户都可以在实时共享的画布上运用提供工具进行元素的绘制、拖动等操作，同时支持通过上传图片文档等作为白板页面的背景。 创建白板后会返回一个白板地址链接，客户端通过直接使用页面、ifram 或者 webview等方式集成。一个白板中含有多个白板页面，加入白板中的用户都可以在实时共享的画布上运用提供工具进行元素的绘制、拖动等操作，支持通过上传图片作为白板的背景。用户可以上传PDF文档、Word、PPT文档进行实时展示和讲解。白板功能是实时音视频通话场景的互动补充，可以满足广泛的业务场景，例如：教育板书、会议内容展示、笔记记录。…