API 参考
在线调试

发送广播消息

更新时间: 2024/05/14 14:10:59

功能描述

网易云信服务端支持向 App 内的所有账号发送广播消息。

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

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

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

调用频率

单个应用默认最高调用频率:10 次/分。如超限,将被屏蔽 1 分钟。

请求

URL

POST https://open.yunxinapi.com/im/v2/broadcast_notification

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

请求体参数

参数名称 类型 是否必选 描述
content String 必选 广播消息内容,长度上限 4096 个字符。
from_account_id String 可选 广播消息发送者的云信账号 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":"123456",
    "content":"广播",
    "offline_enabled":"true",
    "ttl":"abcdef",
    "target_os":["ios","aos","pc","web","mac"]
}

响应

Header

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

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "from_account_id": "123456",
        "broadcast_id": "132465465",
        "content": "广播",
        "offline_enabled": true,
        "ttl": "abcdef",
        "target_os": ["ios", "aos", "pc", "web", "mac"],
        "create_time": "1681385861000",
        "expire_time": "1681385861000"
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
111410 广播消息功能未开启 broadcasting notification service disabled
500 服务器内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码