广播消息收发

更新时间: 2024/03/15 16:12:31

网易云信 NIM Web SDK 支持接收广播消息。广播消息适用于需要通知所有用户的业务场景,如企业管理层通过内部即时通讯软件向全体员工发送内部通知。

技术原理

广播消息由服务端 API(msg.broadcastMsg.action)发起,SDK 收到广播消息之后触发回调直接往应用上层通知,对应用内的所有用户发送一条广播消息。

广播消息支持离线存储,如果发送时设置了存离线,则该消息具有有效期(默认7天,可自行配置)。更换设备登录,或者同一设备卸载重装应用,都能重新收到有效期内的广播消息。

前提条件

  • 广播消息功能需要单独开通,进行相关开发前,请确保您已在云信控制台应用管理 > 产品功能 > IM 即时通讯 > 全局功能开通全员广播功能。
  • 请确保您使用的 SDK 为 4.3.0 以上版本,4.3.0 之前版本不支持接收广播消息。
  • 已集成 SDK。
  • 注册云信 IM 账号,获取 accid 和 token。

使用限制

  • SDK 不支持发送广播消息,仅支持通过 IM 服务端 API(msg.broadcastMsg.action)发送,且一个应用一分钟最多调用10次,一天最多调用 1000 次,超过会返回 416 错误码。如需上调上限,请在官网首页通过微信、在线消息或电话等方式咨询商务人员。
  • 未登录 IM 的用户(例如仅通过独立模式进入聊天室的用户)无法收到广播消息。
  • 最多保留最近 100 条离线广播消息;
  • 广播消息不支持推送、漫游和生成会话,SDK 不支持保存广播消息历史记录。
  • 广播消息不支持客户端存储。

实现流程

  1. 消息接收者在调用getInstance方法进行 SDK 初始化时,注册onBroadCastMsgonBroadCastMsgs回调。

    回调 说明
    onbroadcastmsg 接收者在线时,收到广播消息的回调
    onbroadcastmsgs 同步到离线广播消息的回调,仅当NIMGetInstanceOptions.syncBroadcastMsgs=true时,才会同步离线广播消息

    初始化的完整示例代码,请参见初始化示例代码

  2. 消息发送者调用msg.broadcastMsg.action发送一条广播消息。

  3. SDK 触发onBroadCastMsgonBroadCastMsgs回调,接收者通过这两个回到接收广播消息。

    广播消息参数
    说明
    broadcastId 广播消息 ID
    body 广播消息体
    fromAccid 发送该广播消息的账号
    time 广播消息发送时间戳
此文档是否对你有帮助?
有帮助
去反馈
  • 技术原理
  • 前提条件
  • 使用限制
  • 实现流程