API 参考
在线调试

查询广播消息

更新时间: 2024/07/17 16:58:08

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

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/broadcast_notification/:{broadcast_id}

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

路径参数

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

响应

Header

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

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

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"
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
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
  • Header
  • 路径参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码