重磅推荐github突破7.2k star OpenIM消息推送api支持应用与IM融合
yuyutoo 2024-12-16 17:22 4 浏览 0 评论
OpenIM消息推送api打通了应用和IM系统之间的通知桥梁,让应用消息可以及时触达到目标用户。以办公场景为例,比如员工入职通知,放假通知等业务通知,由oa系统处理具体的业务逻辑,再调用消息推送api,触达到目标用户。
效果示例
以协同办公为例,员工收到系统推送的工作通知,有新任务需要处理。
员工点击工作通知,可以查看具体详情,每条通知有不同的发送者昵称和头像。这种通知类型是一种新的会话类型,全部聚合在同一个会话。
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
单机性能及容量总结
服务器资源: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 | 否 | 扩展字段,暂时不使用 |
相关推荐
- 微软Win10/Win11版Copilot上线:支持OpenAI o3推理模型
-
IT之家4月3日消息,科技媒体WindowsLatest昨日(4月2日)发布博文,报道称Windows10、Windows11新版Copilot应用已摘掉Beta帽...
- WinForm 双屏幕应用开发:原理、实现与优化
-
在当今的软件开发领域,多屏幕显示技术的应用越来越广泛。对于WinForm应用程序来说,能够支持双屏幕显示不仅可以提升用户体验,还能满足一些特定场景下的业务需求,比如在演示、监控或者多任务处理等场景...
- OpenJDK 8 安装(openjdk 8 windows)
-
通常OpenJDK8和11都能互相编译和通用。我们建议使用11,但是如果你使用JDK8的话也是没有问题的。建议配置使用OpenJDK,不建议使用OracleJDK,主要是因为版...
- 基于 Linux 快速部署 OpenConnect VPN 服务(ocserv 实战指南)
-
一、前言在如今远程办公和内网穿透需求日益增长的背景下,搭建一套安全、稳定、高效的VPN系统显得尤为重要。OpenConnectServer(ocserv)是一个开源、高性能的VPN服务端软件...
- 巧妙设置让Edge浏览器更好用(edge怎么设置好用)
-
虽然现在新版本的Edge浏览器已经推出,但是毕竟还处于测试的状态中。而Win10系统里面自带的老版Edge浏览器,却越来越不被人重视。其实我们只需要根据实际情况对老版本的Edge浏览器进行一些简单的设...
- 微软开源博客工具Open Live Writer更新:多项Bug修复
-
OpenLiveWriter前身是WindowsLiveWriter,是微软WindowsLive系列软件之一,曾经是博主们非常喜爱的一款所见即所得博文编辑工具,支持离线保存,还支持图像编辑...
- 基于OpenVINO的在线设计和虚拟试穿 | OPENAIGC大赛企业组优秀作品
-
在第二届拯救者杯OPENAIGC开发者大赛中,涌现出一批技术突出、创意卓越的作品。为了让这些优秀项目被更多人看到,我们特意开设了优秀作品报道专栏,旨在展示其独特之处和开发者的精彩故事。...
- Python open函数详解(python open函数源码)
-
演示环境,操作系统:Win1021H2(64bit);Python解释器:3.8.10。open是Python的一个内置函数,一般用于本地文件的读写操作。用法如下。my_file=open(fi...
- 世界上最好用的Linux发行版之一,OpenSUSE安装及简单体验
-
背景之前无意在论坛里看到openSUSE的Linux发行版,被称为世界上最好用的Linux发行版之一(阔怕),一直想体验一下,于是这期做一个安装和简单体验教程吧。...
你 发表评论:
欢迎- 一周热门
-
-
前端面试:iframe 的优缺点? iframe有那些缺点
-
带斜线的表头制作好了,如何填充内容?这几种方法你更喜欢哪个?
-
漫学笔记之PHP.ini常用的配置信息
-
推荐7个模板代码和其他游戏源码下载的网址
-
其实模版网站在开发工作中很重要,推荐几个参考站给大家
-
[干货] JAVA - JVM - 2 内存两分 [干货]+java+-+jvm+-+2+内存两分吗
-
正在学习使用python搭建自动化测试框架?这个系统包你可能会用到
-
织梦(Dedecms)建站教程 织梦建站详细步骤
-
【开源分享】2024PHP在线客服系统源码(搭建教程+终身使用)
-
2024PHP在线客服系统源码+完全开源 带详细搭建教程
-
- 最近发表
-
- 微软Win10/Win11版Copilot上线:支持OpenAI o3推理模型
- WinForm 双屏幕应用开发:原理、实现与优化
- 推荐一个使用 C# 开发的 Windows10 磁贴美化小工具
- OpenJDK 8 安装(openjdk 8 windows)
- 基于 Linux 快速部署 OpenConnect VPN 服务(ocserv 实战指南)
- 巧妙设置让Edge浏览器更好用(edge怎么设置好用)
- WPF做一个漂亮的登录界面(wpf页面设计)
- 微软开源博客工具Open Live Writer更新:多项Bug修复
- 基于OpenVINO的在线设计和虚拟试穿 | OPENAIGC大赛企业组优秀作品
- C#开源免费的Windows右键菜单管理工具
- 标签列表
-
- mybatis plus (70)
- scheduledtask (71)
- css滚动条 (60)
- java学生成绩管理系统 (59)
- 结构体数组 (69)
- databasemetadata (64)
- javastatic (68)
- jsp实用教程 (53)
- fontawesome (57)
- widget开发 (57)
- vb net教程 (62)
- hibernate 教程 (63)
- case语句 (57)
- svn连接 (74)
- directoryindex (69)
- session timeout (58)
- textbox换行 (67)
- extension_dir (64)
- linearlayout (58)
- vba高级教程 (75)
- iframe用法 (58)
- sqlparameter (59)
- trim函数 (59)
- flex布局 (63)
- contextloaderlistener (56)