开发前准备工作

一、准备工作

                

1、集成流程

                

(1)注册成为云通讯平台用户。

                

(2)登陆云通讯平台,进入管理控制台,创建自己的应用。

                

(3)下载云通讯SDK,根据开发手册进行编码实现。

                                 

2、前期准备

                

(1)注册成为云通讯的用户

                

(2)登陆云通讯平台,进入管理控制台,创建自己的应用。在创建IM类应用的时候,只需填写应用名称,不必选择"启用应用回调地址"、"启用IVR"、"启用TTS"、"服务器白名单"等选项。

                

                

(3)应用创建成功后,在"应用列表"里面可以看见自己刚刚创建的应用,可以对该应用进行编辑和删除操作。

                

注意:

开通IM相关功能,应用需要上线,才可以进行测试。点击“上线”,显示运营中就是上线状态。如果是第一次操作,会先提示提交认证信息,认证通过后才能上线。

   

                          

3、核心概念                

1)生产环境:对应的接入域名为:https://imapp.yuntongxun.com:8883                

2)开发者主账号:每个开发者在云通讯平台对应一个主账号               

    a)ACCOUNT SID:主账号id。                

    b)AUTH TOKEN:主账号验证token。                

3)AppID:应用标识,每个创建的应用都对应唯一的id标识。                

4)子账号:每个App用户在云通讯对应一个子账号,包括账号id和验证token,用于安全性验证。                

5)通讯账号:通讯账号主要用于云通讯平台的语音通讯能力,每个子账号都对应一个通讯账号,由系统自动生成。

                

说明:                

  • 每一个注册开发者对应一个主账号。                
  • 每一个主账号下可以创建多个应用。                                 
  • 每一个应用下面可以创建亿级子账号。               
  • 每一个子账号对应一个通讯账号。

                

二、使用介绍

                

1、云通讯IM 账号体系                

云通讯支持两种账号体系。                

(1)固定子账号体系(即通讯账号+通讯密码登录方式):开发者需要自己调用创建子账号接口 ,为app的用户创建对应的云通讯通讯账号,并将通讯账号和用户id进行绑定,通讯密码和用户密码进行绑定,登录 的时候必须用云通讯通讯账号和通讯密码登录。               

说明:固定子账号体系在IM5.0以后的版本中都支持如果要在demo中测试加密码登录方式,需要先在官网控制台创建自己的应 用,然后将demo默认的应id和token替换成自己创建的应用的,登录的通讯账号和密码,需要是该应用下创建的通讯账号和密码。              

Android中替换应用id和token的地方是ECPreferenceSettings类和RestServerDefines类,ios 是在AppConfig.plist文件(5.4.0及之后版本是在ECAppKey.h)中修改,demo中的appkey就是用户在控制台创建的应用的appid

                

(2)任意子账号体系(即自定义登录方式):用户不必自己在云通讯后台为用户创建云通讯子账号,可以直接使用用户自己开发的App中的账号进行登录,该登录方式我们不验证密码。用户在集成的过程中,可以自己实现对自己登录账号密码的验证。                

说明:任意子账号体系在IM5.0以后的版本中支持,登录的用户名,不能包含中文,特殊符号,不能以g开头,建议在5-20位之间。

2、应用ID和应用Token的获取

应用ID:登陆官网查看控制台→应用管理→应用列表→APP ID。

应用Token:登陆官网查看控制台→应用管理→应用列表→APP TOKEN。

如图所示:

                                

3、登录流程

                

对应账号体系,登录云通讯也有两种验证方式:

账号和密码验证方式:在登录的时候,输入云通讯的通讯账号和对应的通讯密码即可登录。

                

使用此种登陆方式,在app用户注册的时候,需要同时向云通讯后台注册,如图所示:

                

                

使用此种登陆方式,登陆流程如图所示:

                

                

账号和appId,appToken验证方式:此种方式登陆无需使用云通讯子账号,直接使用app的自有账号登陆即可,appID和appToken可以在官网的"控制台"相关应用的描述页面得到,此种方式的登陆流程如图所示:

                

                

4、业务指南

                

4.1、单聊

                

两个用户一对一进行聊天,支持文本、表情、语音、图片、附件5种消息格式。支持已发送(指消息已经发送到服务端)回执。

                

4.2、群组

                

两个以上用户一起聊天。支持文本、表情、语音、图片、附件5种消息格式。同样也支持已发送回执。

                

4.3、群组操作

                

支持创建群组、主动加入群组、邀请加入群组、成员主动退出群组、群主解散群组、群主踢人、设置消息免打扰操作。

群组又分为私有群组和公开群组。私有群组是指主动加入时必须经管理员同意才能加入的群组,公开群组是指主动加入时无需经管理员同意就能加入的群组。

                

4.4、离线消息

                

指用户不在线时候,有人给其发送消息,此时消息存储在服务端,当用户再上线时,从服务端获取这些之前未收到的消息。

                

4.5、设备推送

                

用户不在线时,有人给其发送消息,服务端会给用户设置发送推送通知。用户可以选择查看通知唤起应用,此时消息会被获取到。也可以选择忽略,此时消息变成离线消息。

注意:为了使在推送通知里面显示的是用户昵称而不是用户的账号ID,用户需要调用设置个人信息接口来设置用户的昵称。

                

Ios支持离线推送,离线推送是通过苹果的apns推送实现的,需要自己上传推送证书,请参考“iOS推送证书”文档,Android没有离线推送一说,当前最新版本支持在调用登出接口后,通过广播实现消息通知。

                

4.6、自定义消息

                

可以通过自定义消息发送指令来实现一些扩展功能。如消息已经送达,消息已读,位置分享、阅后即焚……。

                

5、体系架构           

5.1、技术特点                

容联IM通讯云服务,聚焦于"场景·连接"服务,帮助开发构建更完整的产品体验。                

容联IM通讯云的主要技术特点有:                

  • 无需更改App原有框架和App Server架构,集成sdk接口即可实现IM通讯能力。                
  • 采取无DNS设计,实现快速登录体验。                
  • 自适应网络和最小心跳包相结合的心跳技术,消耗更少电量。                
  • 采取特有的二进制协议和包体精简、包体压缩、智能多包合并策略实现最小流量包和最快的收发速度。               
  • 参考微信、陌陌的系统设计方案,采取真正的push-pull系统架构,保证不丢消息、有序到达以及弱网络环境下的消息接收。

                

5.2、第三方和容联IM交互示意图

                

                

如图:

                

蓝色应用为开发者开发的App和开发者的后台服务器,后台服务器实现开发者自己的业务逻辑和保存自己的私有数据。绿色为 容联IM通讯云,红色为容联IM的sdk。

                

蓝色空心箭头为开发者app和自己的后台服务器进行信令及业务交互,蓝色箭头为开发者App,黄色箭头表示App server通过RESTFUL API接口的方式调用容联云的服务,如获取历史消息,广播消息等。

                

5.3、SDK 体系结构

                

                

如图:

                

容联IM  SDK是一个能力库,提供各种IM相关的接口,包括Yuntx_IMLib 和LibCore两部分。Yuntx_IMLib采取Native语言开发,封装各种消息结构和能力结构。LibCore是核心IM  SDK的核心协议栈,主要处理特有的二进制协议和传输层协议,采取c语言开发。iOS和Android采取同一套LibCore,保证消息处理的一致性。