# 消息 (/zh-CN/api-reference/rtm/android/message)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

收发消息是 RTM 服务的基础功能之一，任何使用 RTM 服务发送的消息将会在 100 ms 以内送达到任何一个在线订阅用户端上，你可以一次只给一个人发消息，也可以一次给多人广播消息，这取决于你的使用方式。

RTM 有 3 种频道类型，分别是 Message Channel、User Channel 和 Stream Channel。3 种频道类型的主要区别如下：

- Message Channel：实时频道，消息通过频道传递，可扩展性强。本地用户可以调用 `publish` 方法，将 `channelType` 参数设为 `MESSAGE`，并将 `channelName` 参数设为频道名称，即可在频道中发送消息。远端用户可以调用 `subscribe` 方法订阅频道并接收消息。
- User Channel：向指定用户发送点对点消息。本地用户可以调用 `publish` 方法，将 `channelType` 参数设为 `USER`，并将 `channelName` 参数设为对方的 `userId`，即可向指定用户发送消息。指定用户可以通过 `onMessageEvent` 事件通知来接收消息。
- Stream Channel：流传输频道，用户需要先加入频道，然后加入 Topic，消息通过 Topic 传递。本地用户可以调用 `publishTopicMessage` 方法在 Topic 中发送消息，远端用户可以调用 `subscribeTopic` 方法订阅 Topic 并接收消息。

本文介绍如何在 Message Channel 和 User Channel 中收发消息。

想要了解更多收发消息的信息可以查看：

- [消息](/zh-CN/realtime-media/rtm/build/messaging/send-message)

## publish [#publish]

### 接口描述 [#接口描述]

你可以直接调用 `publish` 方法向订阅该频道的所有在线用户发送消息。即使没有订阅频道，也能在频道中发送消息。

:::info[信息]
以下做法可有效提升消息收发的可靠性：

- 消息负载限制在 32 KB 以内，否则发送会失败。
- 向单个频道发送消息的速率上限为 60 QPS。如果发送速率超限，将会有部分消息被丢弃。在满足要求的情况下，速率越低越好。
:::

成功调用该方法后，订阅了该频道并且开启了事件监听的用户会通过 `onMessageEvent` 收到这条消息，详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)。

### 接口方法 [#接口方法]

你可以通过以下方式调用 `publish` 方法：

```java tab="publish [1/2]"
// publish [1/2]
void publish(
        String channelName,
        String message,
        PublishOptions options,
        ResultCallback<Void> resultCallback
        );
```

```java tab="publish [2/2]"
// publish [2/2]
void publish(
        String channelName,
        byte[] message,
        PublishOptions options,
        ResultCallback<Void> resultCallback
        );
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | [message-android-html-0-1-4 details](#table-slot-message-android-html-0-1-4) |
| `message` | String\byte[] | 必填 | - | 消息负载。 |
| `options` | `PublishOptions` | 必填 | - | 消息选项。 |
| `resultCallback` | `ResultCallback<Void>` | 必填 | - | [message-android-html-0-4-4 details](#table-slot-message-android-html-0-4-4) |

<a id="table-slot-message-android-html-0-1-4"></a>

**message-android-html-0-1-4 details**

- 如需向 Message Channel 发送消息，填写频道名称。
- 如需向 User Channel 发送消息，填写用户 ID。

<a id="table-slot-message-android-html-0-4-4"></a>

**message-android-html-0-4-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法。
- 调用失败：执行 `onFailure` 方法。

<a id="options"></a>
`PublishOptions` 数据类型包含以下属性：

| 属性 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `customType` | String | 选填 | - | 用户自定义字段。仅支持 String 型。 |
| `storeInHistory` | boolean | 选填 | `false` | [message-android-html-1-3-4 details](#table-slot-message-android-html-1-3-4) |

<a id="table-slot-message-android-html-1-3-4"></a>

**message-android-html-1-3-4 details**

是否开启历史消息存储。开启后，消息在发送的同时会被存储到云端，便于用户在进入频道后可以查询到历史消息记录。

:::info[信息]
历史消息功能目前处于 Public Beta 阶段。如需使用，需要前往[控制台](https://console.shengwang.cn/product/RTM2?tab=config)开通。
:::

### 基本用法 [#基本用法]

示例 1：向指定 Message Channel 发送 String 消息

```java
String message = "Hello world";
PublishOptions options = new PublishOptions();
options.setCustomType("PlainTxt");
options.setStoreInHistory(true); // 设置消息是否缓存，如果设置为true，需要开通history服务
rtmClient.publish("my_channel", message, options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "send message to channel success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

示例 2：向指定 Message Channel 发送 Byte 消息

```java
byte[] message = new byte[] {1, 2, 3, 4};
PublishOptions options = new PublishOptions();
options.setCustomType("ByteArray");
options.setStoreInHistory(true); // 设置消息是否缓存，如果设置为true，需要开通history服务
rtmClient.publish("my_channel", message, options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "send message to channel success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

示例 3：向指定 User Channel 发送 String 消息

```java
PublishOptions options = new PublishOptions();
options.setChannelType(RtmChannelType.USER);
options.setCustomType("PlainText");
options.setStoreInHistory(true); // 设置消息是否缓存，如果设置为true，需要开通history服务
rtmClient.publish("Tony", "Hello world", options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "send message success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

示例 4：向指定 User Channel 发送 Byte 消息

```java
byte[] message = new byte[] {1, 2, 3, 4};
PublishOptions options = new PublishOptions();
options.setChannelType(RtmChannelType.USER);
options.setCustomType("ByteArray");
options.setStoreInHistory(true); // 设置消息是否缓存，如果设置为true，需要开通history服务
rtmClient.publish("Tony", message, options, new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
        log(CALLBACK, "send message success");
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
        log(ERROR, errorInfo.toString());
    }
});
```

## getMessages [#getmessages]

### 接口描述 [#接口描述-1]

如果你需要从指定频道中获取历史消息，在客户端调用 `getMessages` 方法。

### 接口方法 [#接口方法-1]

你可以通过以下方式调用 `getMessages` 方法：

```java
void getMessages(
    String channelName,
    RtmChannelType channelType,
    GetHistoryMessagesOptions options,
    ResultCallback<GetMessagesResult> resultCallback
);
```

| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `channelName` | String | 必填 | - | 频道名称。 |
| `channelType` | `RtmChannelType` | 必填 | - | 频道类型。详见 [`RtmChannelType`](/zh-CN/api-reference/rtm/android/enumv#channeltype)。 |
| `options` | `GetHistoryMessagesOptions` | 必填 | - | 查询选项。 |
| `resultCallback` | `ResultCallback<GetMessagesResult>` | 必填 | - | [message-android-html-2-4-4 details](#table-slot-message-android-html-2-4-4) |

<a id="table-slot-message-android-html-2-4-4"></a>

**message-android-html-2-4-4 details**

调用结果回调：

- 调用成功：执行 `onSuccess` 方法并返回 `GetMessagesResult` 数据类型。
- 调用失败：执行 `onFailure` 方法。

`GetHistoryMessagesOptions` 数据类型包含以下属性：

|     属性     |  类型  | 是否必填 | 默认值 | 描述          |
| --------- | --- | ----- | --- | -------- |
| `messageCount`  | int |   选填   |  `100`   | 单次查询的最大消息数。如果单次查询的时间范围内消息数大于该值，则需多次调用 `getMessages` 方法进行查询。 |
|   `start`   |  long  |   选填   |  `0`   | 历史消息开始的时间戳。 |
| `end` | long |   选填   |   `0`    | 历史消息结束的时间戳。   |

:::info[信息]
RTM SDK 提供 `start` 和 `end` 参数，你可以根据实际需求进行设置：

- `start` 和 `end` 为 UTC 时间戳，且两者间隔不能超过 24 小时（取 `event` 事件中返回的 `timestamp` 值）。
- 如果你只设置了 `start` 参数，则你会获得比 `start` 时间戳更早的历史消息。
- 如果你只设置了 `end` 参数，则你会获得当前时间戳到 `end` 时间戳（包含）之间的历史消息。
- 如果你同时设置了 `start` 和 `end` 参数，则你会获得 `start` 和 `end` 时间戳（包含）之间的历史消息。
:::

`GetMessagesResult` 数据类型包含以下属性：

|  属性  |  类型  | 描述      |
| ---- | ----- | --------- |
| `newStart`         |         long         | 下一条历史消息的发送时间戳。如果该参数为 `0`，则表示没有下一条历史消息。               |
| `messageList`    | `ArrayList<HistoryMessage>`  | 历史消息列表。   |

`HistoryMessage` 数据类型包含以下属性：

|  属性  |  类型  | 描述      |
| ---- | ----- | --------- |
| `message`                | `RtmMessage`                |  消息。   |
| `publisher`              | String                |  消息发布者 ID。   |
| `customType` | String | 用户自定义字段。仅支持 String 型。                |
| `timestamp` | long | 消息发送的时间戳。                |

### 基本用法 [#基本用法-1]

```java
GetHistoryMessagesOptions options = new GetHistoryMessagesOptions();
options.setStart(0);
options.setEnd(0);
options.setMessageCount(100);

rtmClient.getHistory().getMessages("my_channel", RtmConstants.RtmChannelType.MESSAGE, options, new ResultCallback<GetMessagesResult>() {
    @Override
    public void onSuccess(GetMessagesResult result) {
        log(CALLBACK, "get channel history messages success! new start: " + result.getNewStart());
        for (HistoryMessage message : result.getMessageList()) {
            log(INFO, message.toString());
        }
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) { log(ERROR, errorInfo.toString()); }
});
```

<a id="接收消息"></a>
## 接收消息 [#接收消息]

RTM 提供消息、状态、事件变更等信息的事件通知。通过设置事件监听，你可以接收已订阅频道中的消息和事件。以接收 User Channel 中的消息为例，示例代码如下：

- 在初始化时添加事件监听：

  ```java
  rtmConfig.eventListener = new RtmEventListener {
      @Override
      public void onMessageEvent(MessageEvent event) {
          // User Channel 私聊消息
          if (event.getChannelType() == RtmChannelType.USER) {
            log(CALLBACK, "receive message from " + event.getPublisherId() + ", message: " + event.getMessage().toString());
          }
      }
      // ...
  }
  ```

- 在任意时间添加事件监听：

  ```java
  RtmEventListener listener = new RtmEventListener() {
      @Override
      public void onMessageEvent(MessageEvent event) {
          // User Channel 私聊消息
          if (event.getChannelType() == RtmChannelType.USER) {
            log(CALLBACK, "receive message from " + event.getPublisherId() + ", message: " + event.getMessage().toString());
          }
      }

      @Override
      public void onLinkStateEvent(LinkStateEvent event) {
      }
  };

  rtmClient.addEventListener(listener);
  // ...

  ```

关于如何添加和设置事件监听，详见[事件监听](/zh-CN/api-reference/rtm/android/configuration#事件监听)章节。