米讯 社交SDK 开发指南

米讯SDK，主要提供各种即时通讯服务。帮助游戏和app快速实现 实时聊天，私信留言，音视频通话，群聊等im功能。

目前我们提供了Android、iOS的客户端SDK，同时提供了各个平台的详细文档和Demo，帮助快速入门。

 我们强烈建议你阅读完本篇指南之后，再去查看以上的详细文档。

接入方需要通过唯一的appid、appkey、guid来向米讯服务器绑定用户，后续交互通过这个guid来标志一个用户。

米讯服务器不关心guid的业务逻辑，接入方只需要保证guid独立性。

米讯服务器提供open-api，接入方服务器需要随时和米讯服务器同步群组关系。

支持 room（聊天室）和group（群组）两种群聊模式。

room：只提供在线消息收发，用户离线时自动退出。不保存记录。（频道聊天，房间聊天等）

group：稳定的群组关系，提供云端消息存储和离线消息等功能。（工会聊天、邮件等）

支持单聊、聊天室、群聊。并且具备完善的群组管理功能。

支持文字、语音、自定义文件、小视频、（开发中）等多种自定义类型消息。

聊天记录保存在云端，允许自由获取。

支持系统向指定用户和群组发送消息。

提供最多16人的 多人实时语音通话功能

支持通话中的各种设定

支持根据带宽情况，只能调整流量消耗

支持最多4人的多人视频功能（开发中）

如果不需要使用实时通话功能：可以删掉lib中的 rtc-sdk-jniso 和 libHDACEngineso 文件以减小SDK体积。

离线消息推送

敏感词过滤

资料和关系链托管

其他个性化业务

如有需求请单独联系我们

原生的 Android、iOS、的客户端 SDK

服务器帐号绑定、群组管理、系统消息发送的open api

可以实时监控用户数、消息数的开发者控制台（开发中）

为方便unity游戏接入，我们提供了unity的SDK封装和样例工程。

unityDemo分为展示基础功能的appDemo和演示游戏中实时通话的SpaceShooter。接入方可以按需参考。

接入方从米讯获取 appID和appkey。

所有服务端的接口鉴权，都要通过appID和appkey来实现。请妥善保存。

客户端接口需要的token、publicID、publickey，需要由接入方服务器，用appID和appkey来换取。再转发给客户端保存。

2、账户绑定（guid、token、pubkey）

接入方需要提供唯一的id来标识一个用户端。这个id，在米讯SDK中，称之为guid（最长128个字符）。

接入方服务器需要调用米讯服务器的bind_account（appid，appkey，guid）来进行注册。米讯服务器将返回对应这个guid的 token、publicID、publickey。

接入方app，在初始化米讯SDK提供的服务时，需要提供 （guid，token，publicID，publickey）。

 米讯服务器不关心guid的业务逻辑，接入方只需要保证guid独立性。

3、群聊（room，group）

米讯SDK提供两种模式的消息群聊服务。分别适合不同的场景。

所有群组的管理，需要接入方服务器和米讯服务器实时交互，保证用户在正确的群里。

接入方app，调用米讯sdk消息 *** 作，负责向群里的用户收发消息。SDK暂时不提供群组管理功能。

聊天室（Room）

只提供在线消息收发，用户离线（超过5min没心跳）自动退出room。再次上线需要重新加入。不保存消息记录。

适合频道聊天、聊天室、随机配对聊天等场景。

一个room，最多同时在线10000人。

rid：接入方定义，要保证不同room的rid唯一性。（128个字符内）

roomtype：接入方定义，方便用户屏蔽某一类room的消息。

群组（Group）

稳定的群组关系，提供云端消息存储和离线消息等功能。需要接入方服务器控制成员进出和群组创建销毁。

适合工会聊天，固定群聊等。

一个group，最多有1000个成员。

gid：接入方定义，要保证不同group的gid唯一性。（128个字符内）

grouptype由业务方定义，方便用户屏蔽某一类group的消息。

4、消息（Message）

Message是SDK用来传输消息的基本对象。需要接入放app构造，然后调用sdk的send接口进行发送。

Message的关键信息如下：

属性类型说明

messageID

String发送方填写的消息ID，用于本地消息去重

fromString发送方ID

targetString接收方ID ,单聊时为对方guid，群聊时为roomID或groopID

bodyMessageBody消息体。不同类型的消息，消息体内容不同，详见下方说明

bodyTypeint消息体枚举类型。暂时包括文本、语音。决定如何解释消息。

messageSeqlong服务端分配的消息序号，用于消息同步，离线消息拉取等



MessageBody

我们提供一下几种类型的MessageBody，后续会持续扩展

0、CustomMessageBody：data

1、TextMessageBody：text

2、AudioMessageBody：audioFilePath；audioUrl；duration

请接入方注意，控制每个Message最大不超过 5KB 的数据。

关于语音消息的录制工具，和自定义消息的方法，请参考详细说明文档。

4、语音通话（VOIP）和会议（Conference）

1、使用语音通话时，接入方服务器，需要先和米讯服务器交互，创建conference。并维护Conference里面的成员。

2、接入方客户端，通过joinconf（confid，guid）来加入确定的conference（前提是，这个conference的成员里面有这个人）

3、客户端加入房间成功后，可以使用各种接口控制音频通话 和 实时获取成员状态。

4、离开conference和确定conference不再使用时，需要及时leave和destroy。

如果不需要使用实时通话功能：可以删掉lib中的 rtc-sdk-jniso 和 libHDACEngineso 文件以减小SDK体积。

五、调用流程概要

1、发消息

2、实时语音通话

交互示意

调用流程图

六、详细文档和Demo

Android SDK 详情

iOS SDK 详情

服务端的 OpenAPI

七、

业务对接和常见问题：

韩尚佑；QQ：271843826；e-mail：hanshangyou@xiaomicom

服务端API：

张友明；QQ：179818827；e-mail：zhangyouming@xiaomicom

Android-SDK：

连冬阳；QQ：2460572865；e-mail：liandongyang@xiaomicom

刘飞；QQ：276985107；e-mail：liufei3@xiaomicom

iOS-SDK：

柯洪峰；QQ：249082954；e-mail：kehongfeng@xiaomicom

直播SDK，只需4行代码即可轻松接入，从主播方的声音、图像采集开始，然后进行美颜、降噪等预处理，接下来到编码，再经过 CDN等形式的传输到达服务器端，处理后解码，接收方就可以看到音视频内容。如果要咨询推流直播，推荐欢拓云直播平台，这个直播平台最重要是全方位挖掘直播关键数据，让直播运营优化有据可依。点击看看推流直播怎么弄


直播SDK应用场景有：
单向直播：
如传统单向秀场直播，主播通过PC或移动设备将音视频推流，观众拉流观看，文字聊天，礼物等互动，这也是目前大多数直播平台支持的模式。也适用于演播室、现场活动直播、发布会等同时只有一路（或几路的）直播流直播活动。
连麦互动直播：
连麦场景互动性更强一些，观众和主播或主播和主播之间可以进行1对 1、1对多进行音视频实时通话比如聊天、游戏开黑、PK等，观众端可同时观看到多位主播之间的互动。欢拓云直播多人连麦移动端支持16路。

想要了解更多关于推流直播的相关信息，推荐咨询欢拓云直播平台。欢拓一直致力于提供行业领先的互动直播SaaS云服务，更是获得了国家高新技术企业和科技创新小巨人企业认证；用强大技术、用心服务，为客户打造更好推流直播平台。

---