跳到主要内容

发送聊天室消息

应用下的用户可向指定的单个或多个聊天室发送消息。

  • 通过该接口发送的消息，默认不会向消息发件人客户端同步。如需同步，请参见 isIncludeSender 参数用法。
  • 支持单次向多个聊天室发送消息，建议不要超过 10 个。
提示

如需向应用下所有聊天室发送消息，可使用发送全体聊天室广播消息（/message/chatroom/broadcast.json）接口。详见发送全体聊天室广播消息。

请求方法​

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

频率限制： 每秒钟限 100 条，同时向 10 个聊天室发送消息视为 10 条。

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

正文参数​

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

参数类型必传说明
fromUserIdString是发送人用户 ID。
toChatroomIdString是接收聊天室 ID，提供多个本参数可以实现向多个聊天室发送消息，建议最多不超过 10 个聊天室。
objectNameString是接受内置消息类型（见消息类型概述）或自定义消息的消息类型值。

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

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

  • 自定义消息类型（objectName 字段必须指定为自定义消息类型）：如果发送自定义消息，该参数可自定义格式，不限于 JSON。
isPersistedInt否是否需要为收件人在历史消息云端存储服务中存储此条消息。0 表示不存储；1 表示存储。默认值为 1，存储（依赖聊天室消息云端存储服务）。

一般情况下（第 1、2 种情况），客户端是否存储消息不依赖此参数。以下第 3 种情况属于例外：
  1. 如果消息属于内置消息类型，客户端 SDK 会根据消息类型本身的存储属性标识判断是否存入本地数据库。详见消息类型概述。
  2. 如果消息属于自定义消息类型，则客户端 SDK 会根据该类型在客户端上注册时的存储属性标识判断是否需要存入本地数据库。
  3. 如果消息属于客户端 App 上未注册自定义消息类型（例如客户端使用的 App 版本过旧），则客户端 SDK 会根据当前参数值确定是否将消息存储在本地。但因消息类型未注册，客户端无法解析显示该消息。
注意：客户端会在用户退出聊天室时自动清除本地的聊天室历史消息记录。
isIncludeSenderInt否是否向发件人客户端同步已发消息。1 表示同步，默认值为 0，即不同步。注意，仅设置该参数无法确保发件人客户端一定能获取到该条已发消息，您可能还需要启用其他服务。详见发件人客户端如何同步已发消息。
priorityInt否此条消息的优先级级别，默认不传的话为 0，此消息的优先级按照原有逻辑设定。
  • 1：白名单消息（消息高保障，需要开通聊天室白名单功能）。
  • 2：高优先级消息。
  • 3：低优先级消息（消息优先抛弃，需要开通聊天室消息优先级服务）。

请求示例​

POST /message/chatroom/publish.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&toChatroomId=2192&toChatroomId=2193&objectName=RC:TxtMsg

返回结果​

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

返回值返回类型说明
codeNumber返回码，200 为正常。
messageUIDsArraymessageUID 列表
messageUIDs[i].userIdString聊天室 ID， 和请求 toChatroomId 对应
messageUIDs[i].messageUIDString发送到对应聊天室的消息的唯一 ID

返回结果示例​

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

{
    "code": 200,
    "messageUIDs": [
        {
            "chatroomId": "2192",
            "messageUID": "XXXX-JJJJ-KKK-LLLL"
        },
        {
            "chatroomId": "2193",
            "messageUID": "XXXX-JJJJ-KKK-LLKL"
        }
    ]
}
最后于 更新