API 参考
在线调试

发送聊天室全服广播消息

更新时间: 2024/07/17 16:58:08

功能描述

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

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

该接口可以向 App 下所有聊天室的所有成员发送一条广播消息。

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

调用频率限制

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

请求

URL

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

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

请求体参数

参数名称 类型 是否必选 描述
client_broadcast_id String 必选 聊天室全服广播消息 ID。使用 uuid 等随机串,客户端会通过该 ID 进行消息去重。
sender_id String 必选 聊天室广播消息发送者的云信账号 ID。
extension String 可选 开发者扩展字段,长度上限 4096 位字符。
resend_flag Integer 可选 是否为重发消息。0(默认):非重发消息;1:重发消息(会根据 client_broadcast_id 检查去重逻辑)。
message Object 必选 消息体。
message_config Object 可选 消息配置项。
route_config Object 可选 抄送相关配置项。
antispam_config Object 可选 安全通相关配置项。

请求体示例

json{
    "client_broadcast_id": "c9e6c306-804f-4ec3-b8f0-573778829419",
    "sender_id": "test1",
    "message": {
        "msg_type": "0"
    }
}

响应

Header

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

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "create_time": "1456396333115",
        "from_avator": "http://b12026.nos.netease.com/MTAxMTAxMA==/bmltYV84NDU4OF8xNDU1ODczMjA2NzUwX2QzNjkxMjI2LWY2NmQtNDQ3Ni0E2LTg4NGE4MDNmOGIwMQ==",
        "client_broadcast_id": "c9e6c306-804f-4ec3-b8f0-573778829419",
        "from_client_type": "REST",
        "text": "This+is+test+msg",
        "room_id": "36",
        "sender_id": "zhangsan",
        "from_nick": "张三",
        "message_type": "0",
        "high_priority": 1
    }
}

错误码

错误码 错误码描述 错误信息示例
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
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率限制
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码