1.说明:
教程属于官方E聊SDK-简介(2)
进入官网
进入管理台
SDK版本:v1.02
技术交流QQ群: 471688937
2.平台支持情况:
平台 |
SDK |
源码 |
备注 |
Web |
兼容Chrome,Firefox, Safari 等 |
开源 |
开发完成 |
小程序 |
微信小程序平台 |
开源 |
开发完成 |
ReactNative |
适配Android4.1及其以上,适配iOS9.0 及其以上,适配移动端浏览器 |
开源 |
开发完成 |
Android |
原生开发,适配Android4.4及其以上 |
暂无 |
开发计划中 |
Java |
计划适配64位PC系统(windows,mac,linux) |
暂无 |
开发计划中 |
c++ |
计划适配64位PC系统(windows,mac,linux) |
暂无 |
开发计划中 |
2.开源版SDK与专业版SDK的区别:
客户可以根据自己的情况选用开源版SDK,专业版SDK。开源版与专业版的客户端SDK功能是一样的,差别在于服务器端开源的功能,差别如下:
服务端功能 |
开源版SDK |
专业版SDK |
文件上传/下载 |
有(支持本地文件服务器) |
有(支持本地服务器,阿里云oss) |
用户在线/离线监听 |
无 |
有 |
API权限功能 |
无 |
有 |
集群功能 |
单机 |
支持集群拓展 |
服务端开源地址
3.专业版授权分类:
现可根据客户业务的需求与开发阶段灵活提供的专业版授权分类
|
测试版 |
体验版 |
收费版 |
价格 |
无 |
无 |
待定 |
授权有效期 |
30个月 |
永久 |
根据付费期限 |
用户上限 |
100人 |
20人 |
无限制 |
群员上限 |
100人 |
20人 |
500 |
最大连接数 |
100 |
20 |
无限制 |
消息文件上限 |
10G |
1G |
无限制 |
消息文件保存时间 |
7天 |
7天 |
30天 |
3.功能明细:
3.1 消息类型
消息类型 |
格式 |
文字消息 |
type=TEXT, 正文为json格式,包含内容(body) |
图片消息 |
type=IMAGE, 正文为json格式,包含图片名称(name),大小(size),下载链接(body) |
文件消息 |
type=FILE, 正文为json格式,包含图片名称(name),大小(size),下载链接(body) |
3.2 IM消息
IM消息 |
功能描述 |
单聊消息 |
用户可向指定的用户发送消息 |
群聊消息 |
用户可向群内所有人发送消息 |
系统通知 |
用户能被动接受E聊服务端发往客户端的系统通知 |
历史消息 |
用户能查询一段时间内的聊天记录 |
未读消息 |
若消息未读,显示未读数量 |
会话列表 |
用户能获取最近一段时间内的会话列表 |
3.3 用户管理
用户管理 |
功能描述 |
添加用户 |
在E聊服务端添加用户(auid,token), 只有添加后的用户才能聊天(仅服务端API支持) |
编辑用户资料 |
可以编辑用户昵称、性别、头像、签名、手机、邮箱等资料 |
获取用户资料 |
获取单条、多条的用户信息,用户信息包括(用户昵称、性别、头像、签名、手机、邮箱等) |
3.4 用户关系
用户关系 |
功能描述 |
添加好友 |
可添加用户为好友 |
删除好友 |
可从好友列表中删除好友 |
获取好友信息 |
可单条、批量获取好友的信息,如(名字、头像、备注名、签名等) |
禁言 |
不显示对话用户发送的消息 |
获取禁言列表 |
获取被禁言的用户列表 |
黑名单 |
能将对话用户拉进黑名单 |
获取黑名单列表 |
获取被拉入黑名单的用户列表 |
3.5 群组功能
群组功能 |
功能描述 |
创建群 |
可以拉好友创建群,创建者即为群主 |
更新群 |
更新群信息,如(群名、群公告、群简介、群Logo等) |
删除群/解散群 |
若自己是群主,即为解散群;若自己是群员,就是退群 |
获取群信息 |
可单条、批量获取群信息,如(群名、群公告、群简介、群Logo等) |
获取群详情与群成员信息 |
获取群详情(群名、群公告、群简介、群Logo等) ,以及群成员信息(用户昵称、性别、头像、签名、手机、邮箱) |
添加群成员 |
为指定群添加群成员 |
移除群成员 |
为指定群移除群成员 |
3.6 文件服务器
文件服务器功能 |
功能描述 |
上传文件 |
通过获取的上传凭证上传文件,现支持的平台: 本地服务器、阿里云对象存储oss |
下载文件 |
下载文件到客户端 |
3.7 其他功能
功能 |
功能描述 |
监听用户的上线状态 |
通过用户的auid监听用户的在线状态,若用户在线/离线,会发送消息到监听的客户端 |