应用配置

在开始配置你的应用之前，你需要先了解用户 ID、服务类型等概念，然后下载并安装 SDK，再初始化一个 RTM 对象实例，最后实现事件监听函数以捕获 RTM 实时网络中的所有事件通知。

用户 ID（userId）

用户 ID 是一个用于标识用户和设备的 ASCII 码字符串，长度最多为 64 个字符。在初始化 RTM 客户端实例时，你需要自行定义用户 ID 并将其传递给 userId 参数。RTM 规定在同一个 App ID（appId）下，每个用户或设备都必须具有唯一的全局用户 ID。

为了正确使用 RTM，你需要了解用户、设备和客户端的概念：

• 用户: 是指应用的实际使用者。
• 设备: 是指实际接入 RTM 网络的终端，包括但不限于手机、电脑、智能手表等 IoT 设备。
• 客户端: 是指运行在设备上的 RTM 对象实例。

一个用户可能拥有多台设备，而一台设备也有可能被多人拥有。为更好地区分不同的设备和用户，RTM 规定同一个用户 ID 不能在多台设备上同时登录 RTM 服务、一台设备上不能同时存在多个 RTM 客户端。如果一个用户拥有多台设备，则需要为每台设备都分配唯一的用户 ID。如果两台拥有相同用户 ID 的设备同时登录 RTM 服务，那么先登录上的设备会被后登录的设备挤下线，而被强制下线的设备会收到相应的事件通知。

在实际场景中，业务层的用户名和 RTM 的用户 ID 可能不同，你需要自行实现二者的映射与绑定逻辑。例如，用户先通过用户名登录你的业务服务器，服务器再生成对应的用户 ID，然后使用该用户 ID 初始化并登录 RTM 服务。

此外，用户 ID 也会影响计费和在线状态通知等功能的使用，所以声网建议你为用户和设备分配全局唯一的用户 ID 并在整个生命周期内保持不变。

安装 SDK

点击此处下载最新版本的 Unity SDK，并在你的项目中导入它。

详细流程参考快速开始。

初始化 RTM 实例

在使用 RTM 功能前，你需要使用 appId 和 userId 来初始化一个 RTM 实例。在后续的示例代码中，你需要将 your_appId 和 your_userId 字段都替换为你自己的 appId 和 userId。

信息

初始化 RTM 对象时的 appId 和 userId 为必填参数，如果缺失，则初始化会失败。

在一个客户端中，你只需要初始化一次 RTM 对象实例，即可在后续实现中通过该对象实例调用 RTM 的其他 API。

C#

using Agora.Rtm;

private IRtmClient rtmClient;

var config = new RtmConfig();
config.appId = "your_appId";
config.userId = "your_userId";
try
{
    rtmClient = RtmClient.CreateAgoraRtmClient(config);
    Debug.Log("RTM Client Initialize Successful");
}
catch (RTMException e)
{
    Debug.Log(string.Format("{0} is failed.", e.Status.Operation ));
    Debug.Log(string.Format("ErrorCode: {0}, due to: {1}", e.Status.ErrorCode, e.Status.Reason));
}

现在，你就可以使用 IRtmClient 对象调用 RTM 的其他 API 接口了。

日志设置

当你的应用处于开发、测试阶段时，你可能需要 SDK 输出更详细的信息来定位并修复问题。你可以在初始化 RTM 实例的时候通过设置 RtmConfig 中的 RTM_LOG_LEVEL 来开启日志输出并设置日志信息等级，之后即可在浏览器的控制台中查看日志信息。

C#

using Agora.Rtm;

private IRtmClient rtmClient;

LogConfig logConfig = new LogConfig()
// set log file path.
logConfig.filePath = "./logfile/";
// set log file size.
logConfig.fileSizeInKB = 512;
// set log report level.
logConfig.level = LOG_LEVEL.INFO;

RtmConfig config = new RtmConfig();
// initialize logconfig.
config.logConfig = logConfig;
config.appId = "your_appId";
config.userId = "your_userId";
try
{
    rtmClient = RtmClient.CreateAgoraRtmClient(config);
    Debug.Log("RTM Client Initialize Sucessfull");
}
catch (RTMException e)
{
    Debug.Log(string.Format("{0} is failed.", e.Status.Operation ));
    Debug.Log(string.Format("Error code: {0}, due to: {1}", e.Status.ErrorCode, e.Status.Reason));
}

日志有以下五种等级：

信息

在你的应用上线时，你需要将日志等级参数设置为 INFO。

枚举值	描述
NONE	0x0000: 不输出任何日志。
INFO	0x0001: 输出 FATAL、ERROR、WARN、INFO 级别的日志。我们推荐你将日志级别设为该等级。
WARN	0x0002: 仅输出 FATAL、ERROR、WARN 级别的日志。
ERROR	0x0004: 仅输出 FATAL、ERROR 级别的日志。
FATAL	0x0008: 仅输出 FATAL 级别的日志。

Proxy 设置

在一些网络服务受限的环境下，你可能需要设置代理服务才能访问外部资源。RTM 支持设置 Proxy 代理服务，你只需要在初始化 RTM 实例的时候开启这项功能即可。

C#

using Agora.Rtm;

private IRtmClient rtmClient;

var proxyConfig = new RtmProxyConfig()
// set proxy type as HTTP.
proxyConfig.proxyType = RTM_PROXY_TYPE.HTTP;
// set your proxy server address.
proxyConfig.server = "192.168.11.101";
// set your listener port.
proxyConfig.port = 8080;
// set your proxy account
proxyConfig.account = "Tony";
// set your proxy password
proxyConfig.password = "my_password"

RtmConfig config = new RtmConfig();
// initialize proxyConfig
config.proxyConfig = proxyConfig;

try
{
    rtmClient = RtmClient.CreateAgoraRtmClient(config);
    Debug.Log("RTM Client Initialize Sucessfull");
}
catch (RTMException e)
{
    Debug.Log(string.Format("{0} is failed.", e.Status.Operation ));
    Debug.Log(string.Format("Error code: {0}, due to: {1}", e.Status.ErrorCode, e.Status.Reason));
}

防火墙白名单设置

大型企业、医院、高校、银行等安全需求较高的机构会部署防火墙将办公环境与外网隔离开来，保护内部信息安全。为避免这些企业用户因防火墙无法使用声网的服务，你需要设置防火墙白名单。

信息

本节展示的目标端口可能会根据实际情况调整。如果遇到问题，联系 rtm-support@agora.io。

Message Channel

Message Channel 是 RTM 的基础服务，只要你使用了 RTM，就需要将以下内容添加到防火墙白名单：

域名

Shell

.agora.io

端口

目标端口	协议	操作
443; 7384; 8443; 9130; 9131; 9136; 9137; 9140, 9141	TCP	允许
1080; 3000; 8000; 8130; 8443; 9120; 9121; 9700; 25000	UDP	允许

Stream Channel

如果你还使用了 Stream Channel，你还需要将以下内容添加到防火墙白名单：

端口

目标端口	协议	操作
4001 - 4150	UDP	允许