全员推送

描述

全员推送，是指向所有在线用户（包括消息发送用户自己）、离线用户发送特定内容的消息，如文本、图片等。本功能适用于全员活动公告、送礼跨房间飘屏等场景。

• 在线用户：登录 ZIM 并且心跳未超时的用户。
• 离线用户：登录 ZIM 并上报 ZPNsPushId 之后，心跳超时的用户。

客户端将通过 ZIM SDK 的回调接口，接收全员推送的消息，得知消息由哪位用户发出。

接口原型

• 请求方法：POST
• 请求地址：https://zim-api.zego.im/?Action=SendMessageToAllUsers
• 传输协议：HTTPS
• 调用频率限制：1 次/秒，每 24 小时内仅限 100 次，如需调整，请联系 ZEGO 技术支持。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 - 公共请求参数。

请求示例

• 请求地址 URL：

  https://zim-api.zego.im/?Action=SendMessageToAllUsers
  &<公共请求参数>

• 请求消息体：

  {
      "FromUserId": "u1",
      "MessageType": 1,
      "MessageBody": {
          "Message":"hello world",
          "ExtendedData":"s"
      },
      "SubMsgType": 0,
      "PushType": 0
  }

响应参数

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考 全局返回码。