开源IM项目OpenIM发布消息推送api,支持应用与IM互通深度融合

简介: 开源IM项目OpenIM发布消息推送api,支持应用与IM互通深度融合

以办公场景为例,比如员工入职通知,放假通知等业务通知,由oa系统处理具体的业务逻辑,再调用消息推送api,触达到目标用户。

效果示例

以协同办公为例,员工收到系统推送的工作通知,有新任务需要处理。

640.png

员工点击工作通知,可以查看具体详情,每条通知有不同的发送者昵称和头像。这种通知类型是一种新的会话类型,全部聚合在同一个会话。

640-1.png

OpenIM简介
OpenIM:从服务端到客户端SDK开源即时通讯整体解决方案。开发者可以轻松替代第三方IM云服务,打造具备聊天、社交功能的app,也可以在自身应用中集成SDK,以提供即时通讯能力。开源IM的价值在于“一切皆可控”“我的信息我做主”,无论是技术,还是信息安全。

整体超过7.2K star,OpenIM作为开源IM的领跑者,持续添加新功能,包括消息推送api,群聊已读。服务端和sdk都是Apache-2.0 License授权协议,可以免费使用。带有UI的产品需要商业授权,有兴趣的客户可以联系我们深度交流。

5X8小时vip专属服务,包括:
(1)一对一技术咨询,微信 电话等各种方式;
(2)sdk使用辅导咨询;
(3)服务端架构及部署答疑;
(4)IM新需求优先排期;
(5)bug优先修复;
(6)系统维护和故障响应;
web端体验:https://open-im-online.rentsoft.cn/

安卓端体验:https://www.pgyer.com/OpenIM

iOS端体验:

https://testflight.apple.com/join/o956rTGx

640-2.png

单机性能及容量总结

服务器资源:8核16G内存, 6个机械磁盘,每个磁盘100G, mongo 分片,10MB带宽。

容量:用户同时在线10万以上,消息条数10亿。

性能评估:同时在线用户10万,每秒钟发送消息900条,(从发送者发出消息到接收到消息)消息延时1秒

可靠性总结

每条消息都能被对方精确收到,并成功落地app本地db。对于失败的3条消息,接收方确实没有收到,确保系统消息一致性。

系统具备优秀的平行扩展能力,除存储模块外,其他模块都无状态,支持亿级用户,千亿消息量。

github地址:https://github.com/OpenIMSDK/Open-IM-Server

开发者中心:https://doc.rentsoft.cn/#/

简要描述

管理员通过后台接口发送通知类型消息

请求URL

http://x.x.x.x:10000/manager/send_msg

请求方式

POST

请求示例

{
"operationID": "Oa notification operationID111",
"sendID": "openIM123456",
"recvID": "18712345678",
"senderPlatformID": 2,
"senderFaceURL": "http://www.head.com",
"senderNickname": "系统通知2",
"content": {

   "notificationName": "公文管理", 
   "notificationFaceURL": "http://www.head1.com", 
   "notificationType": 1, 
   "text": "大家好,今天是...", 
   "externalUrl":"",
   "mixType": 0, 
   "pictureElem": {
       "sourcePath": "", 
       "sourcePicture": {
           "uuid": "", 
           "type": "", 
           "size": 0, 
           "width": 0, 
           "height": 0, 
           "url": ""
      }, 
       "bigPicture": {
           "uuid": "", 
           "type": "", 
           "size": 0, 
           "width": 0, 
           "height": 0, 
           "url": ""
      }, 
       "snapshotPicture": {
           "uuid": "", 
           "type": "", 
           "size": 0, 
           "width": 0, 
           "height": 0, 
           "url": ""
      }
  }, 
   "soundElem": {
       "uuid": "", 
       "soundPath": "", 
       "sourceUrl": "", 
       "dataSize": 0, 
       "duration": 0
  }, 
   "videoElem": {
       "videoPath": "", 
       "videoUUID": "", 
       "videoUrl": "", 
       "videoType": "", 
       "videoSize": 0, 
       "duration": 0, 
       "snapshotPath": "", 
       "snapshotUUID": "", 
       "snapshotSize": 0, 
       "snapshotUrl": "", 
       "snapshotWidth": 0, 
       "snapshotHeight": 0
  }, 
   "fileElem": {
       "filePath": "", 
       "uuid": "", 
       "sourceUrl": "", 
       "fileName": "", 
       "fileSize": 0
  }, 
   "ex": ""

},
"contentType": 1400,
"sessionType": 4,
"isOnlineOnly": false,
"offlinePushInfo": {

   "title": "admin revoke your message", 
   "desc": "", 
   "ex": "", 
   "iOSPushSound": "default", 
   "iOSBadgeCount": false

}
}Copy to clipboardErrorCopied
请求参数

参数名 类型 必选 说明
operationID string 是 操作ID,保持唯一,建议用当前时间微秒+随机数,用于后台链路追踪问题使用
sendID string 是 管理员ID,为后台config文件中配置的管理员ID中一个,默认openIM123456
recvID string 是 接收者userID
senderPlatformID int 否 发送者平台号,模拟用户发送时填写, 1->IOS,2->Android,3->Windows,4->OSX,5->Web,5->MiniWeb,7->Linux
senderFaceURL string 否 发送者头像,用于客户端通知会话产生
senderNickname string 否 发送者昵称,用于客户端通知会话产生
content object 是 消息的具体内容,内部是json 对象
notificationName string 是 通知标题
notificationFaceURL string 是 通知头像
notificationType int 是 通知类型,如:1代表入职通知,2代表离职通知
text string 是 通知正文e
externalUrl string 否 通知点击后需要跳转到的地址链接(不填则无需跳转)
mixType int 是 通知混合类型 0:纯文字通知 1:文字+图片通知 2:文字+视频通知 3:文字+文件通知
pictureElem object 否 图片元素对象
sourcePicture object 否 原图
bigPicture object 否 大图
snapshotPicture object 否 缩略图
soundElem object 否 声音元素对象
videoElem object 否 视频元素对象
fileElem object 否 文件元素对象
uuid string 否 对象唯一ID用于缓存使用
type/videoType/ string 否 图片类型/视频类型
size/dataSize/videoSize/snapshotSize/fileSize int 否 多媒体文件大小,单位字节
width/snapshotWidth int 否 图片/视频缩略图宽度
height/snapshotHeight int 否 图片/视频缩略图高度
url/sourceUrl/videoUrl string 否 图片/文件/视频的URL
sourcePath/soundPath/videoPath/filePath string 否 文件路径,可不填写
fileName string 否 文件名字
ex string 否 扩展字段
contentType int 是 消息类型固定为1400
sessionType int 是 通知会话类型固定为4
isOnlineOnly bool 否 改字段设置为true时候,发送的消息服务器不会存储,接收者在线才会收到,不在线该消息丢失。
offlinePushInfo object 否 离线推送的具体内容,如果不填写,使用服务器默认推送标题
title string 否 推送的标题
desc string 否 推送的具体描述
ex string 否 扩展字段
iOSPushSound string 否 IOS的推送声音
iOSBadgeCount bool 否 IOS推送消息是否计入桌面图标未读数
返回示例

{
"errCode": 0,
"errMsg": "",
"data": {

 "serverMsgID": "", 
 "clientMsgID": "", 
 "sendTime": 1645697804432

}
}Copy to clipboardErrorCopied
返回参数

参数名 类型 说明
errCode int 0成功,非0失败
errMsg string 错误信息
sendTime int 消息发送的具体时间,具体为毫秒的时间戳
serverMsgID string 服务器生成的消息的唯一ID
clientMsgID string 客户端生成的消息唯一ID,默认情况使用这个为主键
消息类型格式描述

简要描述

管理员消息发送字段中contentType支持的消息类型说明以及消息content的具体字段说明。

ContentType消息类型说明

ContentType值 类型说明
101 文本消息
102 图片消息
103 音频消息
104 视频消息
105 文件消息
106 群聊中的@类型消息
107 合并转发类型消息
108 名片消息
109 地理位置类型消息
110 自定义消息
111 撤回类型消息
112 已读回执类型消息
114 引用类型消息
Content具体内容

content内部为具体的json对象,不同的消息类型是不同的json对象

文本消息

{
...,
"content": {

 "text": "nihao"

},
....
}Copy to clipboardErrorCopied
参数名 必选 类型 说明
text 是 string 文本消息的具体内容
自定义消息

{
...,
"content": {

 "data": "", 
 "description": "", 
 "extension": ""

},
....
}Copy to clipboardErrorCopied
参数名 类型 必选 说明
data json string 是 用户自定义的消息为json对象转换后的string
description json string 否 扩展的描述信息为json对象转换后的string,可以不使用
extension json string 否 扩展字段,暂时不使用

目录
相关文章
|
2月前
|
存储 网络协议 前端开发
基于开源IM即时通讯框架MobileIMSDK:RainbowChat v11.7版已发布
Android端主要更新内容: 1)[优化] 优化了首页“消息”列表中单聊类型未正确同步时的收发消息和点击后的处理逻辑; 2)[优化] 优化了首页“消息”列表中同一好友和陌生人会话不能自动合并的问题;
71 2
|
6天前
|
算法 前端开发 API
开源轻量级IM框架MobileIMSDK的鸿蒙NEXT客户端库已发布
MobileIMSDK-鸿蒙端是一套基于鸿蒙Next(纯血鸿蒙)系统的IM即时通讯客户端库: 1)超轻量级(编译后库文件仅50KB)、无任何第3方库依赖(开箱即用); 2)纯ArkTS编写、无Native代码、高度提炼、简单易用; 3)基于鸿蒙Next标准WebSocket API,简洁优雅; 4)可运行于任何支持鸿蒙Next的平台; 5)能与 MobileIMSDK的各种客户端完美互通; 6)可应用于鸿蒙Next中的消息推送、客服聊天、企业OA、IM等场景。
85 45
|
2月前
|
移动开发 网络协议 小程序
基于开源IM即时通讯框架MobileIMSDK:RainbowChat-iOS端v9.1版已发布
RainbowChat是一套基于开源IM聊天框架 MobileIMSDK 的产品级移动端IM系统。RainbowChat源于真实运营的产品,解决了大量的屏幕适配、细节优化、机器兼容问题
67 5
|
3月前
|
移动开发 前端开发 JavaScript
开源即时通讯IM框架MobileIMSDK的H5端技术概览
开源即时通讯IM框架MobileIMSDK的H5端技术概览
72 2
开源即时通讯IM框架MobileIMSDK的H5端技术概览
|
2月前
|
前端开发 JavaScript API
惊呆了!学会AJAX与Fetch API,你的Python Web项目瞬间高大上!
在Web开发领域,AJAX与Fetch API是提升交互体验的关键技术。AJAX(Asynchronous JavaScript and XML)作为异步通信的先驱,通过XMLHttpRequest对象实现了局部页面更新,提升了应用流畅度。Fetch API则以更现代、简洁的方式处理HTTP请求,基于Promises提供了丰富的功能。当与Python Web框架(如Django、Flask)结合时,这两者能显著增强应用的响应速度和用户体验,使项目更加高效、高大上。
56 2
|
2月前
|
前端开发 JavaScript API
告别繁琐!AJAX与Fetch API,让你的前后端沟通畅通无阻,项目效率飙升!
在Web开发中,前后端的顺畅沟通至关重要。传统方法常需频繁刷新页面,影响体验与效率。AJAX和Fetch API的出现简化了这一过程。AJAX利用XMLHttpRequest实现局部页面更新,提升用户体验;Fetch API则以更简洁的语法和强大的功能,进一步优化异步请求处理。两者均能显著提高开发效率,简化代码结构,让项目迭代更快速。拥抱这些技术,让Web开发之路更加顺畅。
36 0
|
15天前
|
人工智能 自然语言处理 API
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口,能够处理文本、音频和视频输入,提供自然流畅的对话体验,适用于多种应用场景。
64 3
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
|
2天前
|
JSON 安全 API
淘宝商品详情API接口(item get pro接口概述)
淘宝商品详情API接口旨在帮助开发者获取淘宝商品的详细信息,包括商品标题、描述、价格、库存、销量、评价等。这些信息对于电商企业而言具有极高的价值,可用于商品信息展示、市场分析、价格比较等多种应用场景。
|
10天前
|
前端开发 API 数据库
Next 编写接口api
Next 编写接口api
|
17天前
|
XML JSON 缓存
阿里巴巴商品详情数据接口(alibaba.item_get) 丨阿里巴巴 API 实时接口指南
阿里巴巴商品详情数据接口(alibaba.item_get)允许商家通过API获取商品的详细信息,包括标题、描述、价格、销量、评价等。主要参数为商品ID(num_iid),支持多种返回数据格式,如json、xml等,便于开发者根据需求选择。使用前需注册并获得App Key与App Secret,注意遵守使用规范。

热门文章

最新文章