该接口可以分页查询广播消息列表详情，包括消息内容，消息发送者，消息过期时间等信息。

调用频率

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

请求信息

请求 URL

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

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

请求头参数

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

查询参数

参数名称	类型	是否必选	说明	默认值
page_token	String	否	分页标识符，如果为空，则从第一页开始查询。	-
limit	Integer	否	每页返回的广播消息数，最大为 100。若传入小于等于 0 的数，默认为 100。	100
type	Integer	否	查询的类型。1：查询所有广播消息；2：查询存离线的广播消息；3：查询不存离线的广播消息。	1

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否还有更多数据。	是
next_token	String	分页标识符，下一次拉取偏移量。	否
- items	Array of objects	返回的会话信息。	否
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": {
        "has_more": false,
        "items": [
            {
                "expire_time": 1505502793520,
                "content": "hello world",
                "create_time": 1505466793520,
                "offline_enabled": true,
                "broadcast_id": 48174937359009,
                "from": "asdasdasd",
                "target_os": [
                    "ios",
                    "pc",
                    "aos"
                ]
            },
            {
                "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
111410	广播消息功能未开启	broadcasting notification service disabled
500	服务器内部错误	internal server error
503	服务器繁忙	server busy