本文介绍如何通过网易云信服务端 API 发送全量用户推送，以及相关的常见问题。

功能描述

本接口用于对应用内的所有用户发送系统推送。该功能适用于需要通知所有用户的业务场景，如企业管理层通过内部即时通讯软件向全体员工发送内部通知。

云信系统推送支持通过 在线通道 和 厂商通道 两种方式下发：

• 在线通道：通过云信自有 IM 连接下发。
• 厂商通道：通过手机厂商自有系统连接下发。

支持漫游同步功能，提高推送可达性。

漫游同步指除了在线通道和厂商通道下发之外，客户端可以在登录云信 IM 时，通过同步拿到存在于服务端的系统推送漫游。从而在连接下发失败时，也能通过漫游同步获取系统推送，进一步提高系统推送的可达性。

调用频率

• 单应用频率限制：1 次/10分，100 次/1天
• 超限将报错（状态码：416），且应用将被屏蔽 1 分钟，之后才能再次调用

请求信息

请求 URL

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

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

请求头参数

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

请求体参数

参数名称	类型	是否必选	示例	说明
content	String	否	"系统推送"	在线推送内容，长度上限 4096 位字符。
- push_config	Object	否	-	厂商推送相关配置项。
push_nick_enabled	Boolean	否	true	厂商推送文案是否需要带上昵称，默认为 true（带昵称）。
push_badge_enabled	Boolean	否	true	厂商推送是否计数，默认为 true（计数）。
push_content	String	否	"推送内容"	厂商推送文案，长度上限 500 位字符。
push_payload	String	否	"{"key":"value"}"	厂商推送对应的 payload，必须是 JSON 格式，长度上限 2048 位字符。详情请参考 推送 payload 配置。
sender_account_id	String	否	"123456"	推送发送者的云信 IM 账号，必须保证唯一性，长度上限为 32 位字符。
target_type	Integer	是	1	推送类型。1：在线推送+厂商推送；2：厂商推送；3：在线推送。
target_os	Array of strings	否	["ios","aos","pc","web","mac"]	推送目标客户端，默认为所有客户端，包括：ios、aos、pc、web、mac、harmony、winphone。
roam_enabled	Boolean	否	false	是否漫游同步，默认为 false。
roam_expire_after	Long	否	604800	漫游同步的失效时间，单位（秒），默认 604800 秒（7天）。

请求体示例

JSON{
    "content": "content",
    "push_config": {
        "push_badge_enabled": true,
        "push_nick_enabled": true,
        "push_content": "pushcontent",
        "push_payload": null
    },
    "sender_account_id": "123456",
    "target_type": 1,
    "target_os": [
        "ios",
        "aos",
        "pc",
        "web",
        "mac"
    ],
    "roam_enabled": true,
    "roam_expire_after": 604800
}

响应信息

响应头参数

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

响应参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
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": {
        "push_id": 123456,
        "content": "content",
        "push_config": {
            "push_badge_enabled": true,
            "push_nick_enabled": true,
            "push_content": "pushcontent",
            "push_payload": null
        },
        "sender_account_id": "123456",
        "target_type": 1,
        "target_os": [
            "ios",
            "aos",
            "pc",
            "web",
            "mac"
        ],
        "roam_enabled": true,
        "roam_expire_time": 1505502793520,
        "create_time": 1505466793520
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
403	系统推送功能未开启	push is disabled
102404	用户不存在	account not exist
416	频率超限	rate limit exceeded
500	服务器内部错误	internal server error
503	服务器繁忙	server busy