http://docs.easemob.com/ 2026-04-12T21:05:45+00:00 http://docs.easemob.com/ http://docs.easemob.com/lib/tpl/haozki-2016-01-25/images/favicon.ico text/html 2017-09-22T07:12:35+00:00 http://docs.easemob.com/cs/300visitoraccess/2ndmessagechannel?rev=1506064355&do=diff 访客端双通道功能 移动客服系统与访客端之间支持环信即时通讯云和 REST API 两条通道进行消息收发。 * 环信即时通讯云消息通道为第一通道，消息经过 IM 服务器到达移动客服的 Gateway，默认情况下均使用该通道收发消息。 text/html 2019-03-29T08:10:21+00:00 http://docs.easemob.com/cs/300visitoraccess/10nativeapp?rev=1553847021&do=diff APP渠道集成 您已拥有一款手机APP，只需在环信客服云创建“APP关联”，并集成环信提供的SDK，即可轻松实现APP接入。 APP SDK集成 环信客服云为您提供了 Android SDK和iOS SDK，两个SDK均基于环信即时通讯云（IM） SDK 3.x，只需5分钟即可集成客服云通用功能。 text/html 2024-12-03T03:13:36+00:00 http://docs.easemob.com/cs/300visitoraccess/20webplugin?rev=1733195616&do=diff 网页渠道集成（旧版已停止维护，建议您尽快升级为新版） ☞新版H5渠道对接方式详见：网页渠道集成 text/html 2024-08-28T01:46:24+00:00 http://docs.easemob.com/cs/300visitoraccess/30wechat?rev=1724809584&do=diff 微信公众号集成 首次在微信公众号使用环信客服云时，需要先在环信客服云绑定微信公众号。 注意： 未通过微信认证的服务号或订阅号无法使用环信客服云的完整功能。使用环信客服云时，需停用微信多客服，并关闭多客服客户端上的自动回复功能。 text/html 2024-08-28T01:47:37+00:00 http://docs.easemob.com/cs/300visitoraccess/40weibo?rev=1724809657&do=diff 微博渠道集成 首次在微博渠道使用环信客服云时，需要先在环信客服云绑定微博账号。仅限于微博认证用户（橙V或蓝V）。 微博账号采用授权模式集成，支持文字、表情、图片等格式的消息收发。微博粉丝向您发送私信或@您的微博账号，都可以在客服云收到消息，您的回复会以私信的形式发送给微博粉丝。 text/html 2018-02-01T04:49:06+00:00 http://docs.easemob.com/cs/300visitoraccess/androidagentapi?rev=1517460546&do=diff 客服AndroidAgentSDK API ---------- 目录 * * * * * * * * * * 会话消息 当前会话列表 //获取进行中会话列表的消息 HDClient.getInstance().ongoingSessionManager().getSessionsFromServer(new HDDataCallBack<List<HDSession>>); text/html 2019-07-08T04:14:47+00:00 http://docs.easemob.com/cs/300visitoraccess/androidagentsdk?rev=1562559287&do=diff Android 客服工作台 SDK 开发工具 " Android Studio" 开源Demo源码：<https://github.com/easemob/kefu-agent-android/> 目录 * 入门指南 * * * * * * * * * * * * build.gradle 配置 添加依赖，在app的build.gradle 中dependencies中加入如下(添加后需同步gradle)： text/html 2018-10-31T07:34:07+00:00 http://docs.easemob.com/cs/300visitoraccess/androidsdk-eclipse?rev=1540971247&do=diff CEC Android SDK集成（Eclipse） 有些开发者还在用Eclipse或者在用jar的方式，自己写UI，那样就要用到下面的集成文档。 1. 下载SDK 从环信官网下载 Android客服访客端SDK。 下载后有三个目录： * kefu-android-demo 基于客服SDK开发的演示商城demo，可通过Android Studio直接打开 text/html 2024-08-28T01:49:45+00:00 http://docs.easemob.com/cs/300visitoraccess/androidsdk?rev=1724809785&do=diff CEC Android SDK集成 环信客服云（Customer Engagement Cloud, CEC）现已推出专属 Android SDK！您只需在客服云创建 APP 关联，并按照本文档的步骤集成 Android SDK，即可轻松实现 Android 版 APP 接入。 SDK介绍 text/html 2025-08-12T03:00:31+00:00 http://docs.easemob.com/cs/300visitoraccess/androidsdkapi?rev=1754967631&do=diff CEC Android SDK API * * * * * * * * * 消息 发送文本消息 //发送一条文本消息， content 为消息文字内容， toChatUsername为客服设置的IM服务号 Message message = Message.createTxtSendMessage(content, toChatUsername); ChatClient.getInstance().chatManager().sendMessage(message, new Callback() {}); text/html 2024-09-04T03:29:25+00:00 http://docs.easemob.com/cs/300visitoraccess/androidsdkvec?rev=1725420565&do=diff CEC Android SDK集成 环信客服云（Customer Engagement Cloud, CEC）现已推出专属 Android SDK！您只需在客服云创建 APP 关联，并按照本文档的步骤集成 Android SDK，即可轻松实现 Android 版 APP 接入。 SDK介绍 text/html 2024-11-14T03:07:40+00:00 http://docs.easemob.com/cs/300visitoraccess/androidui-1?rev=1731553660&do=diff Android 访客端demo集成（含UI库） * 为了方便您快速了解我们的访客端SDK所提供的各种能力，我们对外开放了访客端集成Demo的全部源码，里面包含了对话过程中的业务处理及上层UI库； * 通过这个Demo源码，可以帮助产品人员快速了解我们的访客端功能，可以帮助研发人员快速了解集成技术逻辑，帮助测试人员通过对比demo和您自己的app，更快定位问题； text/html 2022-04-06T09:11:33+00:00 http://docs.easemob.com/cs/300visitoraccess/androidui?rev=1649236293&do=diff Android 访客端demo集成说明（含UI设计） 代码下载 您可以通过以下两种方式获取到源代码： * 下载代码压缩包：客服云sdk 及 Demo 下载 <http://www.easemob.com/download/cs> * 下载源代码：github源码地址 <https://github.com/easemob/kefu-android-demo> 项目集成：详细内容参考demo text/html 2018-09-07T02:57:50+00:00 http://docs.easemob.com/cs/300visitoraccess/api?rev=1536289070&do=diff API 开放平台 ---------- 平台概述 环信通过API开放平台提供对外可调用的接口。 平台使用说明 * 调用平台的接口前需要根据clientID和secretID生成accessToken，clientID和secretID请联系环信获取。 * text/html 2017-09-22T07:12:35+00:00 http://docs.easemob.com/cs/300visitoraccess/appopenurl?rev=1506064355&do=diff APP客服工作台唤起 在某些情况下，开发者可能需要唤起客服的APP，这样可以快速的进入到APP客服系统进行操作。 Android 端客服工作台唤起方式 private void doStartApplicationWithPackageName(String packagename) { // 通过包名获取此APP详细信息，包括Activities、services、versioncode、name等等 PackageInfo packageinfo = null; try { packageinfo = getPackageManager().getPackageInfo(packagename, 0); } catch (PackageManager.NameNotFoundException e) { e.printStackTrace(); } if (packageinfo == null) { Toast.makeText(this, "应用未安装", Toast.LENGTH_SHORT).show(); return… text/html 2022-03-24T08:08:26+00:00 http://docs.easemob.com/cs/300visitoraccess/baidu_base_wood_fish?rev=1648109306&do=diff 百度基木鱼渠道接入 概述 环信客服云支持百度积木鱼渠道接入，基木鱼是百度推出的竞价推广免费建站工具，竞价员通过基木鱼可以简单、快速搭建出多种类型落地页，实现了竞价广告创意内容与落地页内容的强相关性，保证了竞价广告优质连贯的内容体验，基木鱼的使用可以促使访客留线索，实现多维线索收集。 text/html 2025-08-04T06:45:36+00:00 http://docs.easemob.com/cs/300visitoraccess/createappchannel?rev=1754289936&do=diff 创建APP关联 环信客服云的“APP关联”对应即时通讯云（IM）后台的应用，是客服与app/网页访客端客户之间收发消息的通道。在客服云创建关联后，可以在IM后台管理该关联对应的应用。 快速创建 text/html 2024-04-07T07:00:53+00:00 http://docs.easemob.com/cs/300visitoraccess/dingtalk?rev=1712473253&do=diff 钉钉渠道接入 概述 环信客服云支持钉钉渠道接入，绑定后您可以使用环信客服云统一接收与回复钉钉渠道进线的各类消息。钉钉渠道接入后，可以实现让钉钉里的用户可以通过钉钉工作台里的应用，作为咨询客服的入口，可以打开与客服的会话页面，与客服建立起会话链接，同时确保客服可以获取到访客在钉钉里的身份信息，包含用户身份和部门信息等。 text/html 2023-07-20T03:34:12+00:00 http://docs.easemob.com/cs/300visitoraccess/enterprisewechat?rev=1689824052&do=diff 企业微信集成 概述 环信客服云支持企业微信接入，绑定后您可以使用环信客服云统一接收与回复企业微信员工的消息。企业微信属于微信渠道，企业微信用户产生的会话消息将以微信渠道的形式在客服工作台进行展示和统计。 text/html 2024-05-29T09:09:28+00:00 http://docs.easemob.com/cs/300visitoraccess/extended-message-format?rev=1716973768&do=diff 扩展消息格式说明 APP用户端可通过消息中增加ext扩展字段的方式，实现更多个性化功能集成。 以下功能，客服云Android SDK和iOS SDK已默认支持，或通过调用API可以集成。下述通过ext扩展字段集成的方式仅供参考。 text/html 2025-01-08T09:12:38+00:00 http://docs.easemob.com/cs/300visitoraccess/harmonyossdkapi?rev=1736327558&do=diff 鸿蒙访客端SDK API文档 初始化SDK //在主页面调用，以免重复初始化 let mVisitorOptions = new VisitorOptions(); mVisitorOptions.setKefuRestServer('${客服登录地址}') .setAppkey('${AppKey}') .setTenantId('${租户ID}') .setAppVersion('${app版本号}') VisitorClient.getInstance().init(mContext, visitorOptions) text/html 2026-01-04T06:16:26+00:00 http://docs.easemob.com/cs/300visitoraccess/harmonyossdkvec?rev=1767507386&do=diff HarmonyOS 访客端SDK集成 * 环信客服云（Customer Engagement Cloud, CEC）现已推出专属 HarmonyOS SDK！您只需在客服云创建 APP 关联，并按照本文档的步骤集成 HarmonyOS SDK，即可轻松实现 HarmonyOS 版 APP 接入。 text/html 2024-12-02T08:17:35+00:00 http://docs.easemob.com/cs/300visitoraccess/harmonyosui-1?rev=1733127455&do=diff Harmonyos 访客端demo集成（含UI库） demo源码说明 * 环信客服云-鸿蒙版本访客端Demo中包含了最新版本SDK、UI等完整内容，旨在帮助您快速完成鸿蒙版本访客端SDK的集成工作 * 如果您在集成过程中有遇到任何疑问，请先参考下demo源码的逻辑，如果仍无法解决您遇到的问题，请您及时联系我们为您提供技术支持！ text/html 2017-11-21T09:44:03+00:00 http://docs.easemob.com/cs/300visitoraccess/iosagentapi?rev=1511257443&do=diff 客服 iOS AgentSDK API ---------- 目录 * * * * * 会话管理类 当前会话列表 //page 页码；limit:每页会话数(一般要包括所有会话) [[HDClient sharedClient].chatManager asyncLoadConversationsWithPage:<#(NSInteger)#> limit:<#(NSInteger)#> completion:^(NSArray *conversations, HDError *error) { //conversations 会话【HDConversation *】 }]; text/html 2017-11-20T06:53:28+00:00 http://docs.easemob.com/cs/300visitoraccess/iosagentsdk?rev=1511160808&do=diff 环信坐席 iOS SDK ---------- 开发工具 " Xcode" AgentSDKDemo 为Open Source,link to AgentSDKDemo 目录 * * * * * * * * * * SDK介绍 1、文件介绍：依赖库包括HyphenateLite.framework和AgentSDK.framework两个framework，二者缺一不可。 text/html 2024-11-22T06:26:28+00:00 http://docs.easemob.com/cs/300visitoraccess/iosdemo-1?rev=1732256788&do=diff iOS 访客端demo集成（含UI库） * 为了方便您快速了解我们的访客端SDK所提供的各种能力，我们对外开放了访客端集成Demo的全部源码，里面包含了对话过程中的业务处理及上层UI库； * 通过这个Demo源码，可以帮助产品人员快速了解我们的访客端功能，可以帮助研发人员快速了解集成技术逻辑，帮助测试人员通过对比demo和您自己的app，更快定位问题； text/html 2022-04-06T09:09:12+00:00 http://docs.easemob.com/cs/300visitoraccess/iosdemo?rev=1649236152&do=diff ios 访客端demo集成说明（含UI设计） 代码下载 您可以通过以下两种方式获取到源代码： * 下载代码压缩包：客服云sdk 及 Demo 下载 <http://www.easemob.com/download/cs> * 下载源代码：github源码地址 <https://github.com/easemob/kefu-ios-demo> 欢迎大家提交PR改进和修复HelpDeskUI中的问题。 text/html 2017-11-22T08:42:30+00:00 http://docs.easemob.com/cs/300visitoraccess/iossdk-customui?rev=1511340150&do=diff CEC iOS SDK集成（自定义UI） 不使用环信提供的客服UI，可以参考下面的集成文档。 下载SDK 从官网下载 iOS客服访客端SDK 下载后有三个目录: * BaseFramework: 包含 HyphenateLite.framework，是项目依赖库。 text/html 2024-08-28T01:50:16+00:00 http://docs.easemob.com/cs/300visitoraccess/iossdk?rev=1724809816&do=diff CEC iOS SDK集成 环信客服云（Customer Engagement Cloud, CEC）现已推出专属 iOS SDK！您只需在客服云创建 APP 关联，并按照本文档的步骤集成 iOS SDK，即可轻松实现 iOS 版 APP 接入。 SDK介绍 iOS SDK 支持以下功能： text/html 2023-11-21T07:26:32+00:00 http://docs.easemob.com/cs/300visitoraccess/iossdkapi?rev=1700551592&do=diff CEC iOS SDK API * * * * * * * * * 消息 发送文本消息 //toUser 为IM服务号 HDMessage *message = [HDMessage createTxtSendMessageWithContent:text to:toUser]; [[HDClient sharedClient].chatManager sendMessage:message progress:^(int progress) { //发送消息进度 } completion:^(HDMessage *aMessage, HDError *aError) { //发送消息完成，aError为空则为发送成功 }]; text/html 2025-03-05T02:56:49+00:00 http://docs.easemob.com/cs/300visitoraccess/iossdkvec?rev=1741143409&do=diff VEC iOS SDK集成 环信客服云（Customer Engagement Cloud, CEC）现已推出专属 iOS SDK！您只需在客服云创建 APP 关联，并按照本文档的步骤集成 iOS SDK，即可轻松实现 iOS 版 APP 接入。 SDK介绍 iOS SDK 支持以下功能： text/html 2025-04-27T07:18:19+00:00 http://docs.easemob.com/cs/300visitoraccess/mini-program?rev=1745738299&do=diff 微信小程序集成 概述 环信客服云支持微信小程序接入，绑定后您可以使用环信客服云统一接收与回复通过小程序咨询的消息。小程序属于微信渠道，小程序用户产生的会话消息将以微信渠道的形式在客服工作台进行展示和统计。 text/html 2019-02-25T10:33:50+00:00 http://docs.easemob.com/cs/300visitoraccess/persistent-connection?rev=1551090830&do=diff 长连接 客户端与服务端的连接方式包含“长连接（永久）”和“长连接（24小时）”。长连接（永久）包含Socket通道，能够保证客户端无论是否在线，都能够收到消息和通知；长连接（24小时）是仅有24小时时效的长连接，同样包含Socket通道，在时效内与长连接拥有相同的通信能力。 text/html 2024-09-14T01:41:39+00:00 http://docs.easemob.com/cs/300visitoraccess/private-server?rev=1726278099&do=diff 访客端SDK私有部署集成 环信客服云（Customer Engagement Cloud, CEC）提供的 Android/iOS SDK 可以用于公有云和私有部署两种场景。在这两种场景下，接口的使用方法均一致，区别在于：使用私有部署时，需要在初始化设置服务器IP地址和端口。 text/html 2024-08-28T01:48:40+00:00 http://docs.easemob.com/cs/300visitoraccess/restapi?rev=1724809720&do=diff REST API渠道集成 开通REST API渠道并配置服务器信息后，客服向客户回复的消息，将被环信转发到服务器的回调地址中。该功能可用于环信客服云与第三方服务器之间的消息传递。 注：REST API渠道为旗舰版功能。 text/html 2025-08-04T06:46:15+00:00 http://docs.easemob.com/cs/300visitoraccess/sidebar?rev=1754289975&do=diff * 创建APP关联 * 在线网页渠道集成 * Android 访客端demo集成（含UI库） * Android 访客端SDK集成（新版） * Android 访客端SDK API说明 * iOS 访客端demo集成（含UI库） * iOS 访客端SDK集成（新版） * iOS 访客端SDK API说明 * HarmonyOS 访客端demo集成（含UI库） * HarmonyOS 访客端SDK集成 * HarmonyOS 访客端SDK API说明 * 独立视频网页渠道集成 * 独立视频小程序渠道集成 * 微信客服集成 * 微信公众号集成 * 微信小程序集成 * 企业微信集成 * 微博渠道集成 * 抖音渠道接入 * 钉钉渠道集成 * 百度基木鱼渠道接入 * REST API渠道集成 * 扩展消息格式说明 * CEC iOS SDK 集成（旧版） * CEC Android SDK 集成（旧版） * APP客服工作台唤起 * 访客端SDK私有部署集成 * 工… text/html 2019-05-06T09:34:21+00:00 http://docs.easemob.com/cs/300visitoraccess/slack?rev=1557135261&do=diff Slack渠道集成 Slack是一个沟通协作平台，如果您已在Slack创建团队（team）并通过Slack团队维护客户关系，您可以在团队中添加Slack App，将App绑定到环信客户互动云，由您的客服团队作为Slack bot解答客户疑问。 text/html 2024-08-21T04:11:45+00:00 http://docs.easemob.com/cs/300visitoraccess/tiktok?rev=1724213505&do=diff 抖音渠道接入 概述 环信客服云支持抖音渠道接入，绑定后您可以使用环信客服云统一接收与回复抖音企业号私信消息。 ⚠️注意：抖音平台暂只开放了企业号私信对接。 绑定抖音账号 text/html 2019-02-25T10:19:18+00:00 http://docs.easemob.com/cs/300visitoraccess/web-plugin-order-message?rev=1551089958&do=diff 发送订单/轨迹消息（网页插件） 注意：网页插件旧版文档，仅供备份使用！ 如果您的网页支持在移动端浏览，且您需要当访客点击移动端的联系客服按钮时，自动向客服系统发送订单或轨迹消息，可以使用定制开发模式，并在 text/html 2025-08-04T06:43:44+00:00 http://docs.easemob.com/cs/300visitoraccess/web-widget?rev=1754289824&do=diff 网页渠道集成 客服云支持高度灵活的网页插件配置和集成，支持在客服工作台创建超多个网页插件，分别设置每个网页插件的功能，并对网页聊天窗口的实际效果进行预览。 相关域名使用说明 text/html 2017-09-22T07:12:35+00:00 http://docs.easemob.com/cs/300visitoraccess/wechat-callback?rev=1506064355&do=diff 微信回调模式集成（旧版） 该集成方式主要针对有开发者的公众号集成，需要涉及到服务端程序的集成，因此需要首先将公众号设置为开发者模式，微信会将粉丝发送的信息及事件推送到设定的服务器地址上。 text/html 2023-11-22T03:21:07+00:00 http://docs.easemob.com/cs/300visitoraccess/wechatcs?rev=1700623267&do=diff 微信客服接入 在线客服增加”微信客服”渠道，进一步拓宽和整合了微信生态里企业与用户的服务触点，满足企业在公众号、小程序、视频号、搜一搜、微信支付、微信内网页的客服需求，支持企业将微信客服快速接入到环信全渠道客服系统。