跳到主要内容

发送全体聊天室广播消息

应用下的用户可向应用下所有聊天室发送一条广播消息。仅当时在聊天室中的用户可以收到此条消息,后加入聊天室的用户无法收到此消息。

  • 不支持将聊天室广播消息存入服务端聊天室历史消息记录(聊天室消息云端存储服务)。
  • 不支持通过向聊天室发送广播消息来维护聊天室存活。如需控制聊天室存活时长,可前往控制台免费基础功能页面,调整聊天室销毁等待时间。您也可以使用保活聊天室 API 动态设置需要保活的聊天室。
  • 通过该接口发送的消息,默认不会向消息发件人客户端同步。如需同步,请参见 isIncludeSender 参数用法。

开通服务

使用聊天室广播消息功能前,请确认已为当前 App Key 开通相关服务。

如未开通服务,Server API 将返回 1009 错误。注意,在未开通服务时,如果连续请求导致 API 请求频率超过限制,Server API 会返回 HTTP 429 Too Many Requests 错误(错误码为 1008)。

请求方法

POST: https://数据中心域名/message/chatroom/broadcast.json

频率限制: 每秒钟限 1 次

签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名

正文参数

HTTP 请求正文数据格式为 application/x-www-form-urlencoded,支持以下 HTTP 表单参数:

参数类型必传说明
fromUserIdString发送人用户 ID。
objectNameString接受内置消息类型(见消息类型概述)或自定义消息的消息类型值。

注意:在自定义消息时,消息类型不可以 "RC:" 开头,以免与系统内置消息类型重名;消息类型长度不可超过 32 个字符。SDK 中必须已注册过该自定义消息,否则 SDK 收到该消息后将无法解析。
contentString所发送消息的内容,单条消息最大 128k。
  • 内置消息类型:将消息内容体 JSON 对象序列化为 JSON 字符串传入。消息内容 JSON 结构体详见用户内容类消息格式或其他内置消息类型的消息内容格式。

    例如,文本消息内容 JSON 结构体内部包含 content 字段(此为 JSON 结构体内的 key 值,注意区分),则需要将 {"content":"Hello world!"} 序列化后的结果作为此处 content 字段的值。

  • 自定义消息类型objectName 字段必须指定为自定义消息类型):如果发送自定义消息,该参数可自定义格式,不限于 JSON。
isIncludeSenderInt是否向发件人客户端同步已发消息。1 表示同步,详见发件人客户端如何同步已发消息。请注意,该 API 仅支持在发件人已登陆客户端(在线)的情况下同步已发消息。默认值为 0,即不同步。

请求示例

POST /message/chatroom/broadcast.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

content=%7B%22content%22%3A%22hello%22%2C%22extra%22%3A%22helloExtra%22%7D&fromUserId=2191&objectName=RC:TxtMsg

返回结果

HTTP 响应正文包含具有以下结构的 JSON 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。

返回结果示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}