该接口可向应用下的所有聊天室成员发送广播消息，适用于公告、系统通知等场景。

功能描述

网易云信服务端支持向所有聊天室的所有账号发送消息，发送后，应用下的所有聊天室的所有成员都会收到该消息。消息类型包括文本消息、图片消息、语音消息、视频消息、地理位置消息、文件消息、提示消息和自定义消息。各类消息及相关功能的更多介绍，请参考 消息概述。

该功能适用于需要发公告通知所有用户的业务场景，如聊天室升级公告。若需要使用聊天室全服广播，请登录 网易云信控制台，在 应用管理 > 产品功能 > IM 即时通讯 > 聊天室 > 聊天室子功能配置 开通 聊天室全服广播，具体请参考 开通和配置聊天室。

聊天室全服广播消息只能在线广播，不存历史消息。

调用频率限制

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

请求信息

请求 URL

POST https://{endpoint}/im/v2.1/broadcast_notification/actions/chatroom

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

请求头参数

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

请求体参数

参数名称	类型	是否必选	描述
client_broadcast_id	String	是	聊天室全服广播消息 ID。使用 uuid 等随机串，客户端会通过该 ID 进行消息去重。
sender_id	String	是	聊天室广播消息发送者的 IM 账号 ID。
extension	String	否	开发者扩展字段，长度上限 4096 字符。
resend_flag	Integer	否	是否为重发消息。0（默认）：非重发消息；1：重发消息（会根据 client_broadcast_id 检查去重逻辑）。
- message	Object	是	消息体。
message_type	Integer	是	消息类型。 0：文本消息 1：图片消息 2：语音消息 3：视频消息 4：地理位置消息 6：文件消息 10：提示消息 100：自定义消息对于未开通安全通（即易盾反垃圾）功能的应用，自定义消息不会过内容审核。
sub_type	Integer	否	自定义消息子类型，大于 0。message_type = 100 时该参数才有效。
text	String	否	对于文本消息和提示消息，该字段必填，值为消息内容，长度上限 5000 位字符。 对于非文本/提示消息，该字段非必填，值为描述信息，可用于 全文关键字搜索历史消息，长度上限 500 位字符。
attachment	Object	否	非文本消息/提示消息的属性或自定义消息内容，长度上限 5000 位字符。 对于非文本消息/提示消息，该字段必填，每种消息的属性参数见：消息格式示例。
- message_config	Object	否	消息配置项。
high_priority	Boolean	否	是否重发高优先级消息，网易云信会优先保障投递此类消息，默认为 false（低优先级）。 若需要重发高优先级消息，需要配置可以设置 need_high_priority_msg_resend 参数。建议恰当使用该参数，以便在必要时，优先保障应用内的高优先级消息的投递。若全部设置为高优先级，则等于没有设置，单个聊天室最多支持每秒 10 条高优先级消息，超过的默认转为普通消息。
notify_target_tags	String	否	目标 标签表达式，用于设定聊天室消息提醒的投递对象，长度上限 128 位字符。
- route_config	Object	否	抄送相关配置项。
route_enabled	Boolean	否	该消息是否需要抄送至指定的应用服务器（需要为应用开通消息抄送功能），默认为 true（抄送）。
route_environment	String	否	当前消息需要抄送到的环境的名称，对应您在网易云信控制台中配置的自定义抄送的环境名称。
- antispam_config	Object	否	安全通相关配置项。
antispam_enabled	Boolean	否	该消息（除自定义消息）是否需要过安全通审核。 若已在 网易云信控制台 开通安全通，该参数默认为 true（过审核），若需要设置单条消息不经过审核，则设置为 fasle。 若未开通安全通，该参数无效。
antispam_business_id	String	否	安全通业务 ID，可以指定当前消息过安全通某个检测策略。 默认情况下网易云信控制后台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请 提交工单 联系网易云信技术支持工程师进行配置，配置好后传入对应的安全通业务 ID，表示当前消息过安全通的指定检测策略。
antispam_extension	String	否	透传给易盾的反垃圾增强版的检测参数，格式为 JSON，长度限制 1024 位字符（具体请参考易盾的反垃圾增强版用户 可扩展参数）。反作弊相关的 email、phone、token、extension，抄送到 antispam_cheating 参数中。其他用户增值信息，抄送到 antispam_extension 参数。
antispam_cheating	String	否	透传给易盾的反作弊检测参数，格式为 JSON，长度限制 1024 位字符（具体请参考易盾的反垃圾防刷版 专属参数）。反作弊相关的 email、phone、token、extension，抄送到 antispam_cheating 参数中。其他用户增值信息，抄送到 antispam_extension 参数。 antispam_extension 传入的值默认覆盖 extension。
antispam_custom_message_enabled	Boolean	否	是否对自定义消息的指定内容（antispam_custom_message）进行审核。 若已在 网易云信控制台 开通安全通，该参数默认为 false（不过审核），若需要设置该条自定义消息经过审核，则设置为 true。 若未开通安全通，该参数无效。
antispam_custom_message	String	否	自定义的安全通检测内容, JSON 格式，长度限制同 text 参数。格式如下： {"type":1,"data":"custom content"} 字段说明： type: 1 为文本；2 为图片；3 为视频；4 为音频；5 为图文 data: type 为 1、2、3、4 时，data 为字符串，分别传入文本内容、图片地址、视频/音频地址。 type 为 5 时，data 为 JSON 格式，例如： { "text":""，//1 个文本 必填 "images":["url1,"url2"], //最大 6 个图片 必填 "textbid":"", //文本检测业务 ID 选填 "picbid":"" //图片检测业务 ID 选填 } 该参数只对自定义消息（message_type = 100）且 ntispam_custom_message_enabled = true 时才生效。

请求体示例

JSON{
    "client_broadcast_id": "c9e6c306***3778829419",
    "sender_id": "test1",
    "message": {
        "msg_type": "0",
        "text": "系统公告：服务器将于今晚22:00-24:00进行维护"
    },
    "message_config": {
        "high_priority": false
    }
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
create_time	Long	聊天室广播消息发送时间戳。	是
client_broadcast_id	String	聊天室广播消息的 ID。	是
sender_id	String	聊天室广播消息发送方账号 ID。	是
from_nick	String	聊天室广播消息发送方的昵称。	否
from_avatar	String	聊天室广播消息发送方的头像。	否
message_type	Integer	广播消息类型。	是
text	String	文本/提示消息内容或多媒体消息的描述文本（该描述信息可用于云端历史消息关键词检索）。	否
attachment	Object	多媒体消息的属性或自定义消息内容。	否
sender_client_type	Integer	发送者的客户端类型。1：AOS；2：iOS；4：PC；16：WEB；32：REST；64：MAC；65：HARMONY。	是
high_priority	Boolean	是否为高优先级消息。true：高优先级消息。	是
sub_type	Integer	自定义消息子类型，大于 0。	否

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "client_broadcast_id": "d016b30**683fe0e6",
    "attachment": {
      "ext": "png",
      "search": "消息检索",
      "size": 50790,
      "w": 434,
      "name": "msgPic1753781038434",
      "h": 524,
      "url": "",
      "md5": "a338e704***fdbe144a"
    },
    "from_nick": "yytest34",
    "create_time": 1753781039124,
    "sub_type": 1,
    "message_type": 1,
    "from_avatar": "",
    "sender_id": "yytest34",
    "high_priority": true,
    "sender_client_type": 32
  }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
102421	用户被禁言	account chat banned
102422	用户被禁用	account banned
103404	用户资料不存在	user profile not exist
107410	该 App 未开启发消息功能	messaging function disabled
111410	聊天室全服广播功能未开通	broadcasting notification service disabled
111301	重发消息不存在	resent message not exist
111451	该广播消息未通过反垃圾审核	hit moderation rules
113410	聊天室服务未开通	chatroom service disabled
500	服务器内部错误	internal server error
503	服务器繁忙	server busy