即时通讯开发指南（IM）

产品概述

蓝莺IM，是由美信拓扑团队研发的新一代即时通讯云服务，SDK设计简单集成方便，服务采用云原生技术和多云架构，私有云也可按月付费。

企业可以通过集成蓝莺IM SDK，配合使用云服务，为应用快速添加聊天功能。集成SDK后，典型的应用架构如下：

依靠十余年的即时通讯 IM 技术积累，蓝莺IM SDK和云服务 API 都已经过优化设计，通过更加简单的接口提供更加专业的服务。

一键启用多云架构，是蓝莺IM云服务的独特优势。

一键启用意味着，从基础功能到服务定制，均可通过控制台一键操作即开即用；而多云架构，支持应用在公有云、专有云和私有云的不同部署方式自由迁移，顺应业务发展阶段，无缝迁移无忧切换。

配合无所不能的控制台，你需要做的只有两件事，一是客户端集成蓝莺IM SDK，二是服务端对接蓝莺云服务 API。本文主要介绍 SDK 集成相关内容。

蓝莺IM SDK 是跨平台的，包括移动端（iOS/Android）、PC桌面端（Linux/Windows/Mac）、Web浏览器端（包括H5）以及微信小程序等。为了最大程度的复用，并提高服务质量，SDK 技术栈如下：

1. 统一设计并实现二进制即时通讯协议 XSYNC ，分别实现了 C++ 版和 Javascript 版；
2. 在 C++ 通讯库的基础上封装了全平台的 C++ SDK，并以此为基础继续封装了移动端（iOS/Android）和PC桌面端（Linux/Windows/Mac）SDK；
3. 移动端在实现蓝莺IM Demo 前均封装了本地的 UI Kit 库，但 iOS 和 Android 稍有不同，iOS 通过 Object-C 封装 SDK 后进一步转化成 Swift 库，而 Android 则通过 Swig 框架和 JNI 技术直接封装了 Java 库供上层使用；
4. PC桌面端通过 Electron 封装 C++ 通讯库后，与 Web 浏览器端共享一套由 Vue.js 实现的 UI 组件；
5. Javascript 通讯库通过 WebAssembly 加密封装后提供给 Web 浏览器端（包括H5）使用；
6. 微信小程序由于平台原因，除协议库外均与 Web 浏览器端不同，系统层调用了微信的网络和存储库，上层用的微信的 UI Kit；

新手接入指南

开始集成所有客户端之前，你需要通过蓝莺IM云服务控制台，创建应用并获取应用的 AppID 然后在各端设置。

1. 创建账号

注册并登陆蓝莺IM云服务控制台

1. 创建应用

登录成功后，点击创建应用

创建应用成功后，应用信息页面内获得该应用的 App ID 等重要信息，也可以点击功能页进行配置。

服务端

API 文档

服务端 API

私有部署安装

下载安装包 后直接在控制台按照步骤操作，亦可查看详细安装文档

客户端SDK

蓝莺IM SDK，代号 floo。文中有 IM SDK 的地方将会用 floo 代替。

SDK API 详细文档

1. iOS API
2. Android API
3. Web API，微信小程序API与此完全相同
4. C++ API

平台兼容

蓝莺IM SDK支持以下平台：

Changelog

待补充，请参考源码更新

客户端错误码