环信第三方集成 -- 移动客服

最新推荐文章于 2021-05-29 12:35:43 发布

缘圈_Fighting

最新推荐文章于 2021-05-29 12:35:43 发布

阅读量8.2k

点赞数 1

分类专栏：第三方sdk 文章标签：环信环信第三方集成移动客服环信移动客服 sdk

本文链接：https://blog.csdn.net/q9104422999/article/details/52494415

版权

第三方sdk 专栏收录该内容

13 篇文章 1 订阅

订阅专栏

如果自己集成导入sdk

这里写图片描述

初始化sdk

这里写图片描述

以下是参考官方文档加自己的总结:

一 . APP接入

您已拥有一款Android或iOS版手机APP，只需要集成环信IM SDK，并在环信移动客服系统关联您的手机APP，就可以轻松处理来自您的APP用户的咨询。

为了帮助您快速集成环信IM SDK，我们为您准备了 “商城”Demo及其源码。您可以先使用商城Demo体验客服功能，然后参考“商城”Demo源码进行集成。

注意：环信只提供消息收发功能，APP的UI界面需要自定义。

第1步：注册移动客服账号

在移动客服注册页面，填写您的邮箱、密码等信息，注册移动客服账号。

注册页面

第2步：注册环信开发者账号

在环信管理后台注册页面，填写您的企业ID、用户名、密码等信息，注册环信开发者账号。

管理后台注册页面

第3步：创建应用和IM用户

登录环信管理后台，为您的手机APP创建一个应用，获取AppKey、ClientId、ClientSecret。

这里写图片描述

注册一个IM用户，获取用户名和密码。

这里写图片描述

第4步：将您的APP绑定移动客服

打开环信移动客服，进入“管理员模式 > 渠道管理 > 手机APP”。

这里写图片描述

点击“+添加APP关联”。填写关联名称（您的APP名称）、AppKey、ClientId、ClientSecret、IM服务号（IM用户的用户名）、IM Password（IM用户的密码），并保存。

这里写图片描述

第5步：验证该APP关联的消息收发

您可以通过“商城”Demo验证该APP关联的消息收发。打开“商城”Demo，点击“设置”，将设置页面的“AppKey”和“IM服务号”修改为上述APP关联的“AppKey”和“IM服务号”，即可先行体验通过您自己的AppKey发送的消息和留言。

验证步骤:

将demo中的 “AppKey”和“IM服务号”修改为上述APP关联

这里写图片描述

跟踪到要修改的代码的类中为

这里写图片描述

—————-运行查看收发效果——————

第6步：为您的APP集成用户体系

您需要为您的已有用户和新增用户创建环信ID，并关联起来，才可以在环信移动客服上正确显示访客信息（您的用户信息）。请参考用户和好友体系集成。

注：集成过程中有任何技术问题，请联系环信技术支持。

第7步：为您的APP集成消息和留言功能

参考“商城”Demo的开源代码，集成消息和留言功能。

iOS版demo源码下载地址： https://github.com/easemob/helpdeskdemo-ios
Android版demo源码下载地址：https://github.com/easemob/kefu-android-demo

注：源码使用的SDK版本为v2.x，集成过程中有任何技术问题，请联系环信技术支持。

后续操作

集成IM SDK后，您可以使用APP扩展集成，实现更多个性化功能。

APP渠道集成

客户只需要将手机APP集成环信即时通讯云IM SDK，并在环信移动客服系统关联该手机APP，即可轻松实现APP接入。

APP SDK集成

前提：您需要拥有一款自己的手机APP，Android版或iOS版。

第 1 步：注册环信IM开发者账号并登录。注册地址：https://console.easemob.com/index_register.html

第 2 步：添加您的手机APP，获取AppKey、ClientId、ClientSecret。

这里写图片描述

第 3 步：注册一个IM用户，获取用户名和密码（即IM服务号和IM password）。

这里写图片描述

第 4 步：下载IM SDK v2.x并集成。

下载地址：http://www.easemob.com/download/im

具体集成方法可参考“商城demo”中的开源代码。

iOS版demo源码下载地址：https://github.com/easemob/helpdeskdemo-ios
Android版demo源码下载地址：https://github.com/easemob/kefu-android-demo

注：集成过程中有任何技术问题，请联系环信技术支持。

第 5 步：使用管理员账号登录环信移动客服，进入“管理员模式→渠道管理→手机APP”。

这里写图片描述

第 6 步：点击“添加APP关联”，添加一个关联名称（一般为APP名称或咨询入口名称），并将APP的注册信息（AppKey、ClientId、ClientSecret、IM服务号、IM密码）填入关联项，点击保存。

这里写图片描述

若验证状态和应用状态均为绿色，则表明APP关联已添加成功。

这里写图片描述

第 7 步：返回客服模式，等待APP访客发起会话。

打开手机APP，点击“联系客服”，发起一个新会话，开始与客服聊天。

APP扩展集成和集成留言功能##

由于扩展集成和集成留言功能依个人所需进行扩展这里给出官方地址自行集成即可
http://docs.easemob.com/cs/300visitoraccess/10nativeapp#app_sdk%E9%9B%86%E6%88%90

以上步骤 app接入就完成了下面介绍一下

二 . 微信接入

您已拥有一个通过微信认证的微信公众号，只需将您的微信公众号绑定到环信移动客服系统，就可以轻松处理来自微信网友的咨询。

注意：未通过微信认证的服务号或订阅号无法使用环信移动客服的完整功能。使用环信移动客服时，需停用微信多客服，并关闭多客服客户端上的自动回复功能。

第1步：注册移动客服账号

在移动客服注册页面，填写您的邮箱、密码等信息，注册移动客服账号。

这里写图片描述

第2步：绑定微信公众号

登录环信移动客服，进入“管理员模式 > 渠道管理 > 微信”。

这里写图片描述

点击“+微信公众号”，添加微信公众号。

这里写图片描述

进入微信公众平台，扫描二维码授权环信移动客服。

这里写图片描述

第3步：设置自定义菜单

绑定成功后，微信公众号菜单将暂时失效，需重新设置自定义菜单。点击微信公众号，选择“自定义菜单”进行设置。

这里写图片描述

绑定微信公众号后，当微信网友向该微信公众号发送消息时，可以在环信移动客服的会话面板查看并回复。

后续操作

您可以设置粉丝首次关注自动回复功能。当微信网友首次关注您的微信公众号时，自动回复欢迎信息。

如果您是一位开发者，您也可以使用回调模式集成环信移动客服，或者，您可以为您的微信公众号菜单添加客服系统的H5网页聊天地址，请参考微信渠道集成。

三 . 微信渠道集成

请参考微信渠道集成这里将不再细说。
首次在微信渠道使用环信移动客服系统时，需要先在环信移动客服系统绑定微信公众号。

注意：未通过微信认证的服务号或订阅号无法使用环信移动客服的完整功能。使用环信移动客服时，需停用微信多客服，并关闭多客服客户端上的自动回复功能。

授权模式

通过微信公众号授权，直接与微信公众号绑定，客服可以直接与公众号的粉丝对话。

注意：

一个微信公众号仅可以绑定到一个管理员账号；
使用环信移动客服时，需停用微信多客服，并关闭多客服客户端上的自动回复功能。

第 1 步：使用管理员账号登录环信移动客服，进入“管理员模式→渠道管理→微信”，点击“+微信公众号”。

微信渠道

第 2 步：点击“微信公众号登录授权”。

添加微信公众号

第 3 步：使用微信公众号绑定的个人微信号扫描网页中的二维码（下图为示例）。

授权环信移动客服

第 4 步：绑定成功。可以设置微信公众号的自定义菜单。

设置微信公众号的自定义菜单

授权成功后：

微信公众平台的“自动回复”功能将被停用，且暂无法修改；
微信公众平台的“自定义菜单”功能将被停用，且暂无法修改；
通过微信公众平台设置的菜单将会暂时失效，须进入环信移动客服的“管理员模式→渠道管理→微信”重新设置菜单；
通过微信公众平台编辑的素材库可以进入环信移动客服的“管理员模式→渠道管理→微信”继续使用。

注意：

解除绑定时，需进入微信公众平台的“添加功能插件→授权管理”取消绑定。

回调模式

针对有开发者的公众号，需要首先将公众号设置为开发者模式，微信会将粉丝发送的信息及事件推送到设定的服务器地址上。在开发者中心中设置的第三方服务器接收到微信推送过来的粉丝消息后，根据需要有选择的将消息发送给环信指定的API，环信会将该粉丝消息发送给客服人员，客服回复后环信会将消息推送给第三方提供的API（符合环信格式），由第三方将客服回复消息发送给终端的粉丝用户。

回调模式集成包含如下步骤：

该集成方式主要针对有开发者的公众号集成，需要涉及到服务端程序的集成，因此需要首先将公众号设置为开发者模式，微信会将粉丝发送的信息及事件推送到设定的服务器地址上。

第 1 步：关联IM系统和客服系统
第 2 步：关联IM系统和第三方服务器
第 3 步：设置消息投递到环信
第 4 步：设置客服回复消息给微信粉丝
第 5 步：设置第三方服务器返回响应消息

第 1 步：关联IM系统和客服系统

登录环信管理后台。若您还没有账号，点击“立即注册”，注册成为环信开发者并登录。

注册环信开发者账号

进入我的应用，并点击“创建应用”，创建一个应用，并获取APP的AppKey、ClientId、ClientSecret（下图应用为示例）。

创建应用获取APP的AppKey、ClientId、ClientSecret

点击刚创建的应用，选择“IM用户→注册IM用户”，注册两个IM用户。例如：kefu001、kefu001_callback。

注册IM用户

使用管理员账号登录环信移动客服，进入“管理员模式→渠道管理→手机APP”，点击“添加APP关联”。

手机APP渠道

在“新增APP关联”窗口，填写关联名称、AppKey、ClientId、ClientSecret、IM服务号、IM Password，并点击“保存”，创建APP关联。

其中：“AppKey、ClientId、ClientSecret”对应您创建的APP的AppKey、ClientId、ClientSecret；“IM服务号、IM Password”对应您注册的其中一个IM用户的用户名和密码，如用户名kefu001与对应的密码。

添加APP关联

注：此关联成功启动之后，代表IM系统与客服系统成功关联起来。

第 2 步：关联IM系统和第三方服务器

使用APP的ClientId和ClientSecret获取APP管理员Token，并记录下来。

详情请参考：获取APP管理员token。

联系环信技术支持，开通实时消息回调。

需要向环信提供如下配置信息：

回调地址URL：客户自己指定的第三方服务器地址，环信会把消息推送到该地址上。
AppKey：客户为微信公众号创建的APP的AppKey。
回调ID：客户创建的第二个IM用户的用户名，如：上文中kefu001_callback。
token：上一步中获取的APP管理员token。
（可选）签名密钥：APP可以提供自己的密钥用来替换默认的密钥（默认情况下，回调密钥为123456，APP响应的密钥为654321）。

详情请参考：实时消息回调。

注：开通实时消息回调后，代表IM系统与第三方服务器成功关联起来。

第 3 步：设置消息投递到环信

在开发者中心中设置的第三方服务器接收到微信推送过来的粉丝消息后，根据需要有选择的将消息发送给环信指定的API，环信会将该粉丝消息发送给客服人员，坐席回复后环信会将消息推送给第三方提供的API（符合环信格式），由第三方将客服人员回复消息发送给终端的粉丝用户。

投递到环信的消息格式及API使用方式可以参见发送消息，需要额外注意的只有消息格式的变化，需要在消息的扩展信息中添加上至少如下信息：

目前支持文本消息、图片消息、语音消息类型。

文本消息：

{ "target_type":"users",
  "target":["kefu001"], //在环信移动客服中设置的关联IM账号
  "msg":{
      "type":"txt",
      "msg":"这里是微信粉丝发送给公众号的文本信息" 
      },
  "from":"kefu001_callback", //用于开通实时消息回调功能的IM账号
   "ext" : {
       "weichat":{
           "visitor":{ 
                  "source" : "weixin", //来源渠道微信，固定值
                  "msgId" : "0c9a31ed-430b-4edf-9aaf-6029f2674534", //消息id
                  "openid": "oAGnbt89fTgfzOlybTmAh_7s3Z_g",
                  "mp":"gh_9856dc55a1ea", //微信公众号ID
                  "userNickname":"微信粉丝昵称",
           }
       }
   }
}

图片消息：

{ "target_type":"users",
  "target":["kefu001"], //在环信移动客服中设置的关联IM账号
  "msg":{
      "type":"img", //固定值
      "filename":"name.jpg", //任意指定
      "secret":"secretsecretsecretsecret",  //任意指定，具体作用可见官网API文档
      "url":"http://pic1.ooopic.com/uploadfilepic/sheji.jpg"  //微信粉丝发送的图片url
      },
  "from":"kefu001_callback", //用于开通实时消息回调功能的IM账号
   "ext" : {
       "weichat":{
           "visitor":{ 
                  "source" : "weixin",  //固定值
                  "msgId" : "0c9a31ed-430b-4edf-9aaf-6029f2674534",  //微信消息id
                  "openid": "oAGnbt89fTgfzOlybTmAh_7s3Z_g",
                  "mp":"gh_9856dc55a1ea", //公众号ID
                  "userNickname":"微信粉丝昵称", //粉丝昵称
           }
       }
   }
}

语音消息：

{ "target_type":"users",
  "target":["kefu001"], //在环信移动客服中设置的关联IM账号
  "msg":{
      "type":"audio", //固定值
      "filename":"xsxuzhl20150810T182551.amr", //任意指定
      "secret":"secretsecretsecretsecret",  //根据需要指定，具体作用可见官网API文档
      "url":"http://a1.easemob.com/easemob-demo/chatdemoui/chatfiles/yyueywueywhdsh"  //微信粉丝发送的语音url，这里以把音频文件上传到环信服务器为例
      },
  "from":"kefu001_callback", //用于开通实时消息回调功能的IM账号
   "ext" : {
       "weichat":{
           "visitor":{ 
                  "source" : "weixin",  //固定值
                  "msgId" : "0c9a31ed-430b-4edf-9aaf-6029f2674534",  //微信消息id
                  "openid": "oAGnbt89fTgfzOlybTmAh_7s3Z_g",
                  "mp":"gh_9856dc55a1ea", //公众号ID
                  "userNickname":"微信粉丝昵称", //粉丝昵称
           }
       }
   }
}

说明：

目前环信移动客服系统只支持播放MP3格式的语音消息。使用回调模式投递语音消息到环信时，可以使用以下两种方式：

使用环信服务器上的语音文件URL地址：从微信服务器下载语音文件，调用REST接口将该语音文件上传到环信服务器，由环信服务器自动转成MP3格式后，调用上述接口发送给客服系统；
使用第三方服务器上的语音文件URL地址：从微信服务器下载语音文件，将该语音文件转成MP3格式后，保存在自己指定的服务器上，然后调用上述接口发送给客服系统。

第 4 步：设置客服回复消息给微信粉丝

公众号开发者提供回调服务给环信，环信会将客服人员回复的消息发送给提供的服务上，回调的地址集成时可联系环信处理。

目前仅支持文本消息和图片消息类型。

环信回调到消息内容如下：

文本消息：

{
  "timestamp": 1438837020808,
  "chat_type": "chat",
  "from": "kefu001", //在环信移动客服中设置的关联IM账号
  "to": "kefu001_callback", //用于开通实时消息回调功能的IM账号
  "payload": {
      "bodies": [
          {
              "msg": "座席回复的消息",
              "type": "txt"
          }
      ],
      "ext": {
          "weichat": {
              "visitor": {
                  "mp": “gh_9898dc96a1ea",
                  "openid": "oAGnbt89fTgfzOlybTmAh_7s3Z_g",
                  "userNickname": "微信粉丝昵称",
                  "source": "weixin"
              }
          }
      }
  },
  "msg_id": "91363492593926564",
  "callId": "easemob-demo#app_91363492593926564",
  "eventType": "chat",
  "security": “1d9b3a27574989826a034f02ece89161"  //回调签名，见环信回调签名认证方式
}

图片消息：

{
  "timestamp": 1438837366089,
  "chat_type": "chat",
  "from": "kefu001", //在环信移动客服中设置的关联IM账号
  "to": "kefu001_callback", //用于开通实时消息回调功能的IM账号
  "payload": {
      "bodies": [
          {
              "filename": "8899a801f289.jpg",
              "size": {
                  "width": 750,
                  "height": 500
              },
              "secret": "",
              "type": "img",
              "url": “https://a1.easemob.com/easemob-demo/xuzhengli/chatfiles/5bd56cb0-3bf8-11e5-b668-431280c88f48"  //坐席回复的图片地址
          }
      ],
      "ext": {
          "weichat": {
              "visitor": {
                  "mp": "gh_9898dc86a1ea",
                  "openid": "oAGnbt89fTgfzOlybTmAh_7s3Z_g",
                  "userNickname": "微信粉丝昵称",
                  "source": "weixin"
              }
          }
      }
  },
  "msg_id": "91364975632712188",
  "callId": "easemob-demo#xuzhengli_91364975632712188",
  "eventType": "chat",
  "security": "27db399e77d4f422e50f5b529820ef64"
}

第 5 步：设置第三方服务器返回响应消息

第三方服务器收到回调消息后，需要给环信服务器发送响应消息。响应内容不能超过1000个字符。

响应消息示例：

{
    "callId":"",//与环信推送的一致
    "accept":"true",//表明接受了此推送
    "reason":"",//可选，accept为false时使用
    "security":""//签名。格式如下: MD5（callId+约定的key+"true"），约定key为654321
}

注意：第三方服务器收到回调消息后的响应内容不能超过1000个字符，如果连续发送超长消息会导致回调接口被封禁。接收回调消息的第三方服务器需要保证回调接口高并发下的可用性，如果接收回调消息时出现504错误等，页面会因为响应消息过长而停止回调。

H5网页跳转模式集成

登录微信公众平台，打开“自定义菜单”，将H5网页链接地址添加到“联系客服”菜单上，保存并更新微信公众号，即可完成。

H5网页链接地址（需将以下网址中的tenantId修改为自己账号下的tenantId）：

http://kefu.easemob.com/webim/im.html?tenantId=0000

注：Android版微信菜单更新存在一定时间延迟。

app中的实例图

这里写图片描述

查看你自己的tenantId 实例图

这里写图片描述

需要修改代码中的tenantId 实例图

这里写图片描述

集成完后:

需要的注意事项是:

1.微信公众号和环信移动客服手机端sdk集成，目前只支持h5页面的形式，而且只能发送，文本，图片，表情

2.微信公众号和环信自带的pc客服管理，支持对话框聊天，而且只能发送，文本，图片，表情，客服可以接收语音

3.环信是不支持api消息发送，只支持两端集成sdk

环信只支持 (im和im) 用户和用户 (即:即时通讯云) , 可以进行发送视频等 , im和移动客服之间不能发送视频

5.未通过微信认证的服务号或订阅号无法使用环信移动客服的完整功能,

 (举例: 微信发送消息 客服可以收到 ,  但是客服回复 微信收不到的 现象)。

使用环信移动客服时，需停用微信多客服，并关闭多客服客户端上的自动回复功能。

安卓交流群 : 595856941

缘圈_Fighting

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

环信第三方集成 -- 移动客服

一 . APP接入

第1步：注册移动客服账号

第2步：注册环信开发者账号

第3步：创建应用和IM用户

第4步：将您的APP绑定移动客服

第5步：验证该APP关联的消息收发

验证步骤:

—————-运行查看收发效果——————

第6步：为您的APP集成用户体系

第7步：为您的APP集成消息和留言功能

后续操作

APP渠道集成

APP SDK集成

APP扩展集成 和 集成留言功能##

以上步骤 app接入就完成了 下面介绍一下

二 . 微信接入

第1步：注册移动客服账号

第2步：绑定微信公众号

第3步：设置自定义菜单

三 . 微信渠道集成

H5网页跳转模式集成

集成完后:

APP扩展集成和集成留言功能##

以上步骤 app接入就完成了下面介绍一下