网易云信 IM 服务端支持对系统推送的批量查询功能，支持分页查询和多种查询类型过滤。

调用频率

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

请求信息

请求 URL

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

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

请求头参数

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

请求查询参数

参数名称	类型	是否必选	示例	说明
page_token	String	否	-	分页标识符，如果为空，则从第一页开始查询。
limit	Integer	否	50	每页返回的系统推送数量，最大为 100，最小为 1，默认为 100。
type	Integer	否	1	查询的类型： 1（默认）：查询所有系统推送 2：查询漫游的系统推送 3：查询不存漫游的系统推送

响应信息

响应头参数

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

响应参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否有下一页。	是
next_token	String	分页的 token，用于下一页查询。	否
- items	Array of objects	系统推送列表。	否
push_id	Long	系统推送的 ID。	是
sender_account_id	String	推送发送者云信 IM 账号。	否
content	String	在线推送内容。	否
target_type	Integer	推送类型。1：在线推送+厂商推送；2：厂商推送；3：在线推送。	是
target_os	Array of strings	推送目标客户端。	是
roam_enabled	Boolean	是否漫游同步。	是
roam_expire_time	Long	漫游同步的失效时间。	否
create_time	Long	推送的创建时间。	是
- push_config	Object	厂商推送相关配置。	否
push_nick_enabled	Boolean	厂商推送文案是否需要带上昵称，默认为 true（带昵称）。	否
push_badge_enabled	Boolean	厂商推送是否计数，默认为 true（计数）。	否
push_content	String	厂商推送文案，长度上限 500 位字符。	否
push_payload	String	厂商推送对应的 payload，必须是 JSON 格式，长度上限 2048 位字符。详情请参考 推送 payload 配置。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": false,
        "next_token": "MTY4NzE2NjExMDEyMA==",
        "items": [
            {
                "push_id": 123456,
                "content": "系统通知内容",
                "push_config": {
                    "push_badge_enabled": true,
                    "push_nick_enabled": true,
                    "push_content": "您有新的系统消息",
                    "push_payload": "{\"key\":\"value\"}"
                },
                "sender_account_id": "system_001",
                "target_type": 1,
                "target_os": [
                    "ios",
                    "aos",
                    "pc",
                    "web",
                    "mac"
                ],
                "roam_enabled": true,
                "roam_expire_time": 1505502793520,
                "create_time": 1505466793520
            },
            {
                "push_id": 789012,
                "content": "重要系统公告",
                "push_config": {
                    "push_badge_enabled": true,
                    "push_nick_enabled": false,
                    "push_content": "系统维护通知",
                    "push_payload": null
                },
                "sender_account_id": "system_002",
                "target_type": 2,
                "target_os": [
                    "ios",
                    "aos"
                ],
                "roam_enabled": false,
                "roam_expire_time": null,
                "create_time": 1505466793521
            }
        ]
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
403	系统推送功能未开启	push is disabled
414	参数错误	parameter error
416	频率超限	rate limit exceeded
500	服务器内部错误	internal server error
503	服务器繁忙	server busy