在线调试

查询广播消息

更新时间: 2025/08/21 17:27:49

该接口可以查询一条广播消息详情,包括消息内容,消息发送者,消息过期时间等信息。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求信息

请求 URL

GET https://{endpoint}/im/v2/broadcast_notification/{broadcast_id}

请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header

路径参数

参数名称 类型 是否必选 描述
broadcast_id String 需要查询的广播消息 ID。

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
broadcast_id String 广播消息的 ID。
from_account_id String 广播消息发送方账号 ID。
content String 广播消息内容。
offline_enabled Boolean 广播消息是否存离线。
target_os Array of strings 接收广播消息的目标客户端。
create_time Long 广播消息发送时间戳。
expire_time Long 广播消息过期时间戳。

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "expire_time": 1505502793520,
        "content": "hello world",
        "create_time": 1505466793520,
        "offline_enabled": true,
        "broadcast_id": 48174937359009,
        "from": "asdasdasd",
        "target_os": [
            "ios",
            "pc",
            "aos"
        ]
    }
}

错误码

本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
111404 广播消息不存在 broadcasting notification not exist
111410 广播消息功能未开启 broadcasting notification service disabled
500 服务器内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 路径参数
  • 响应信息
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码