该接口可以向 App 内的所有账号发送一条广播消息。

功能描述

该功能适用于需要通知所有用户的业务场景，如企业管理层通过内部即时通讯软件向全体员工发送内部通知。若需要使用广播消息，请登录 网易云信控制台，在 应用管理 > 产品功能 > IM 即时通讯 > 全局功能 开通 全员广播。

• 若需要要实现广播消息在客户端的正常接收，需要在客户端注册相应的监听/回调函数，否则将无法接收。具体说明请参考各端 SDK 文档。以 Android 端为例，请参考 广播通知收发。客户端 SDK 4.3.0 及以上版本才支持接收广播消息。
• 广播消息目前暂不支持第三方推送（APNS、小米、华为等）。
• 广播消息支持离线存储，并可以自定义设置离线存储的有效期，最多保留最近 10000 条离线广播消息。

调用频率

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

请求信息

请求 URL

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

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

请求头参数

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

请求体参数

参数名称	类型	是否必选	描述
content	String	是	广播消息内容，长度上限 4096 位字符。
from_account_id	String	否	广播消息发送者的 IM 账号 ID。
offline_enabled	Boolean	否	广播消息是否存离线。默认为 false（不存）。
ttl	Integer	否	存离线的有效时间，单位为小时，默认为 168 小时，即 7 天。 只有 offline_enabled = true 时，该参数才有效。
target_os	Array of strings	否	接收广播消息的目标客户端，默认为所有客户端。JSONArray 格式，例如： ["ios","aos","pc","web","mac"]

请求体示例

JSON{
    "from_account_id": "user123",
    "content": "content",
    "offline_enabled": true,
    "ttl": 168,
    "target_os": ["ios", "aos", "pc", "web", "mac"]
}

响应信息

响应头参数

响应 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": {
        "from_account_id": "user123",
        "broadcast_id": "132465465",
        "content": "content",
        "offline_enabled": true,
        "target_os": ["ios", "aos", "pc", "web", "mac"],
        "create_time": "1681385861000",
        "expire_time": "1681385861000"
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
111410	广播消息功能未开启	broadcasting notification service disabled
500	服务器内部错误	internal server error
503	服务器繁忙	server busy