全员推送
POST
https://zim-api.zego.im/
全员推送，是指向所有在线用户（包括消息发送用户自己）、离线用户发送特定内容的消息，如文本、图片等。本功能适用于全员活动公告、送礼跨房间飘屏等场景。
- 在线用户：登录 ZIM 并且心跳未超时的用户。
- 离线用户：登录 ZIM 并上报 ZPNsPushId 之后，心跳超时的用户。
说明
- 如需使用本功能，请开通 ZIM 专业版或旗舰版服务。
- 通过本接口发送的消息不会导致会话产生，也不会被保存。
消息接收用户仅通过以下 ZIM SDK 的回调接口，接收全员推送的消息，得知消息由哪位用户发出。
| iOS | Android | macOS | Windows |
|---|---|---|---|
| broadcastMessageReceived | onBroadcastMessageReceived | broadcastMessageReceived | onBroadcastMessageReceived |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| broadcastMessageReceived | broadcastMessageReceived | onBroadcastMessageReceived | broadcastMessageReceived |
| uni-app | uni-app x | HarmonyOS |
|---|---|
| broadcastMessageReceived | broadcastMessageReceived |
说明
参数 FromUserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。
如果发送方使用的 SDK 版本（版本说明请参考 发布日志）低于 2.0.0，ZIM 服务端对应的仅支持 MessageType 为 2 的 Command 类型消息，不支持其他类型。
为了给开发者带来更好的体验，ZEGO 推荐开发者使用最新版本的 SDK。
消息接收方的 SDK 版本必须为 2.10.0 或以上，才能接受全员推送消息。
说明
调用频率限制：1 次/秒，每 24 小时内仅限 100 次，如需调整，请联系 ZEGO 技术支持。
Request
Query Parameters
Action string必填
可选值: [SendMessageToAllUsers]
接口原型参数
https://zim-api.zego.im/?Action=SendMessageToAllUsers
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
- application/json
Responses
- 200
OK
- application/json