客户端鉴权

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 login 方法登录。

rtmClient.login("your_token", new ResultCallback<Void>() {
    @Override
    public void onSuccess(Void responseInfo) {
      // 处理登录结果
    }

    @Override
    public void onFailure(ErrorInfo errorInfo) {
      // 处理报错
    }
});

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 onTokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 onLinkStateEvent 回调，报告如下内容：

• 当前状态（currentState）：FAILED
• 触发本次状态迁移的操作（operation）：SERVER_REJECT
• 状态迁移的原因（reasonCode）：TOKEN_EXPIRED

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 loginByToken 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 joinWithOption 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 loginByToken 方法登录。

[rtm loginByToken:@"your_token" completion:^(AgoraRtmCommonResponse * _Nullable response, AgoraRtmErrorInfo * _Nullable errorInfo) {
    if (errorInfo == nil) {
        NSLog(@"login success!!");
    } else {
        NSLog(@"login failed, errorCode %d, reason %@", errorInfo.errorCode, errorInfo.reason);
    }
}];

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 tokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 didReceiveLinkStateEvent 回调，报告如下内容：

• 当前状态（currentState）：AgoraRtmLinkStateFailed
• 触发本次状态迁移的操作（operation）：AgoraRtmLinkOperationServerReject
• 状态迁移的原因（reasonCode）：AgoraRtmLinkStateChangeReasonTokenExpired

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 Token 对客户端的用户进行鉴权。

1. 创建一个项目文件夹，其中包含如下文件：

   • index.html：用户界面
   • client.js：使用 RTM SDK 的 App 逻辑

   Copy Text

   |-- SDK/libs/agora-rtm-version.min.js
   |-- index.html
   |-- client.js

2. 将官网下载的 SDK 中的 libs 文件夹中的 JS 文件保存到你的项目下。

3. 在 index.html 中加入以下代码，创建用户界面。

   • 你需要将 <path to the JS file> 替换为你上一步保存的 JS 文件的路径。

   Copy Text

   <html>
   <head>
      <title>RTM Token demo</title>
   </head>
   <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
   <body>
      <h1>Token demo</h1>
      <script src="<path to the JS file>"></script>
    <script src="./client.js"></script>
   
   </body>
   </html>

4. 将如下代码贴入 client.js 文件中，实现客户端鉴权逻辑。

   • 将 <Your App ID> 替换为你的 App ID。该 App ID 必须与 Token 生成代码中的 App ID 一致。
   • 将 <Your Host URL and port> 替换为你部署好的本地 Golang 服务器的主机 URL 和端口，如 10.53.3.234:8082 。

   Copy Text

   // 是否开启 Token 更新循环
   let started = true;
   
   function sleep(time) {
       return new Promise((resolve) => setTimeout(resolve, time));
   }
   
   function fetchToken(uid) {
       return new Promise(function (resolve) {
           axios
               .post(
                   "http://<Your Host URL and port>/fetch_rtm_token",
                   {
                       uid: uid,
                   },
                   {
                       headers: {
                           "Content-Type": "application/json; charset=UTF-8",
                       },
                   },
               )
               .then(function (response) {
                   const token = response.data.token;
                   resolve(token);
               })
               .catch(function (error) {
                   console.log(error);
               });
       });
   }
   
   async function loginRTM() {
       // 你的 App ID
       const appID = "<Your App ID>";
   
       // 设置 RTM 用户 ID
       const uid = "1234";
   
       // 获取 Token
       const rtmToken = await fetchToken(uid);
   
       // 初始化客户端
       const client = new AgoraRTM.RTM(appID, uid, { token: rtmToken });
   
       // 显示连接状态变化
       client.addEventlistener("linkState", function (event) {
         const currentState = event.currentState;
         const previousState = event.previousState;
         const serviceType = event.serviceType;
         const operation = event.operation;
         const reason = event.reason;
         const affectedChannels = event.affectedChannels;
         const timestamp = event.timestamp;
         const isResumed = event.isResumed;
         console.log("Link state changed to: " + currentState + " Reason: " + reason);
       });
   
       // 登录 RTM 系统
       await client.login();
   
       while (started) {
           // 每 30 秒更新一次 Token。此更新频率是为了功能展示，生产环境建议每小时更新一次
           await sleep(30 * 1000);
           const newToken = await fetchToken(uid);
           await client.renewToken(newToken);
   
           let currentDate = new Date();
           let time = currentDate.getHours() + ":" + currentDate.getMinutes() + ":" + currentDate.getSeconds();
           console.log("Renew RTM token at " + time);
       }
   }
   
       async function loginRTM() {
           // 你的 App ID
           const appID = "<Your App ID>";
   
           // 设置 RTM 用户 ID
           const uid = "1234";
   
           // 获取 Token
           const token = await fetchToken(uid);
   
           // 初始化客户端
           const client = new AgoraRTM.RTM(appID, uid);
   
           // 显示连接状态变化
           client.on("linkState", function (event) {
             const currentState = event.currentState;
             const previousState = event.previousState;
             const serviceType = event.serviceType;
             const operation = event.operation;
             const reason = event.reason;
             const affectedChannels = event.affectedChannels;
             const timestamp = event.timestamp;
             const isResumed = event.isResumed;
             console.log("Link state changed to: " + currentState + " Reason: " + reason);
           });
   
           // 登录 RTM 系统
           await client.login({ token });
   
           while (started) {
               // 每 30 秒更新一次 Token。此更新频率是为了功能展示，生产环境建议每小时更新一次
               await sleep(30 * 1000);
               const newToken = await fetchToken(uid);
               await client.renewToken(newToken);
   
               let currentDate = new Date();
               let time = currentDate.getHours() + ":" + currentDate.getMinutes() + ":" + currentDate.getSeconds();
               console.log("Renew RTM token at " + time);
           }
       }
   
       loginRTM();

   在上述代码示例中，你可以看到 Token 与客户端的以下代码逻辑有关：

   • 使用 App ID、用户 ID 和 Token 初始化 RTM 实例。App ID 和用户 ID 必须和生成 Token 时使用的 App ID 和用户 ID 一致。
   • 调用 login 方法登录 RTM 系统。
   • 定时从服务端获取新的 Token 并调用 renewToken 方法更新 SDK 的 Token。声网建议你定时（例如每小时）从服务端生成 Token 并调用 renewToken 方法更新 SDK 的 Token，保证 SDK 的 Token 一直处于有效状态。

5. 用支持的浏览器打开 index.html 文件，进入开发者模式。在控制台可以看到客户端执行以下操作：

   • 成功登录 RTM 系统。
   • 每隔 30 秒调用 renewToken 方法更新 Token。

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 tokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 linkState 回调，报告如下内容：

• 当前状态（currentState）：FAILED
• 触发本次状态迁移的操作（operation）：SERVER_REJECT
• 状态迁移的原因（reason）：TOKEN_EXPIRED

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 login 方法登录。

import { RtmClient, RtmConfig } from '@shengwang/rtm-full';
import type { TokenEvent } from '@shengwang/rtm-full';
import { RtmError, RtmTokenEventType } from '@shengwang/rtm-full';

const rtmConfig: RtmConfig = {
  appId: "your_app_id",
  userId: "your_user_id"
};

try {
  const rtmClient = new RtmClient(rtmConfig);
  
  // 监听 Token 事件
  rtmClient.addEventListener('token', (event: object) => {
    const tokenEvent = event as TokenEvent;
    console.log("Token event:", tokenEvent.eventType);
    console.log("Reason:", tokenEvent.reason);
    
    if (tokenEvent.eventType === RtmTokenEventType.WILL_EXPIRE) {
      console.log("Token will expire, renewing...");
      try {
        const result = await rtmClient.renewToken('your_new_token_string');
        console.log("Token renewed successfully");
      } catch (error) {
        if (error instanceof RtmError) {
          console.error("Renew token failed:", error.errorCode, error.reason);
        }
    }
  });
  
  // 使用 Token 登录
  const response = await rtmClient.login("your_token");
  console.log("Login successful:", response);
} catch (error) {
  console.error("Login failed:", error);
  if (error instanceof RtmError) {
    console.error(`Login failed: ${error.reason} (code: ${error.errorCode})`);
  }
}

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 token 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 linkState 回调，报告如下内容：

• 当前状态（currentState）：FAILED
• 触发本次状态迁移的操作（operation）：SERVER_REJECT
• 状态迁移的原因（reasonCode）：TOKEN_EXPIRED

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 LoginAsync 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 JoinAsync 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 LoginAsync 方法登录。

var result = await rtmClient.LoginAsync("your_token");
if (result.Status.Error)
{
    // 登录失败，处理报错
    Debug.Log(result.Status.ErrorCode);
}
else
{
    // 登录成功
}

开发注意事项Copy Anchor Link

参数匹配Copy Anchor Link

生成 RTM Token 时填入的用户 ID 和 App ID，需要和初始化实例时填入的用户 ID 和 App ID 一致。

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 OnTokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 OnConnectionStateChanged 回调，报告 FAILED 连接状态和 TOKEN_EXPIRED 状态变更原因。此时，用户需要先调用 logout 方法登出 RTM 系统，再调用 login 方法使用新的 Token 登录 RTM 系统。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 login 方法登录。

class TokenResult {
    final String status;
    final String token;
    TokenResult(this.status, this.token);
}
// 定义获取 token 函数
Future<TokenResult> fetchToken({required String channelName}) async {
    // 向 Token Provider 请求 token
    ......
    String status = "success";
    String token = "your_token_here";
    return TokenResult(status, token);
}

rtmClient.addListener({
    token:(event) => {
        if(event.channelName == '') {                                        // 当 event 中 channelName 为空时，表示 `MESSAGE` 服务 Token 过期
            var result = await fetchToken();                                    // 获取 `MESSAGE` 服务 Token
            rtmClient.renewToken(result.token);                                 // 更新 `MESSAGE` 服务 Token
        } else {                                                              // 当 event 中 channelName 不为空时，表示 `STREAM` 服务 Token 过期
            var result = await fetchToken(channelName: event.channelName);      // 获取 `STREAM` 服务 Token
            streamChannel.renewToken(result.token);                             // 更新 `STREAM` 服务 Token
        }
    }
});

var token = await fetchToken();

var (status,response) = await rtmClient.login(token);
if (status.error == true) {
    print(status);
} else {
    print(response);
}

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 token 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 linkState 回调，报告如下内容：

• 当前状态（currentState）：failed
• 触发本次状态迁移的操作（operation）：serverReject
• 状态迁移的原因（reasonCode）：tokenExpired

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 login 方法登录。

RtmConfig config;
config.appId = "your app id";
config.userId = "your user id";
config.eventHandler = new RtmEventHandler();

int errorCode = 0;
IRtmClient* rtmClient = createAgoraRtmClient(config, errorCode);
if (!rtmClient || errorCode != 0) {
  // create rtm client failed
}

uint64_t requestId;
rtmClient->login("your token", requestId);

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 onTokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 onLinkStateEvent 回调，报告如下内容：

• 当前状态（currentState）：RTM_LINK_STATE_FAILED
• 触发本次状态迁移的操作（operation）：RTM_LINK_OPERATION_SERVER_REJECT
• 状态迁移的原因（reasonCode）：RTM_LINK_STATE_CHANGE_REASON_TOKEN_EXPIRED

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通 RTM 服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 RTM Token 对客户端的用户进行鉴权。

使用获取到的 RTM Token，通过 login 方法登录。

rtm.login(token) {res, error in
    if error != nil {
        print("\(error?.operation) failed! error reason is \(error?.reason)")
    } else {
        print("success")
    }
}

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 tokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 didReceiveLinkStateEvent 回调，报告如下内容：

• 当前状态（currentState）：failed
• 触发本次状态迁移的操作（operation）：serverReject
• 状态迁移的原因（reasonCode）：tokenExpired

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。

鉴权是指在用户访问你的系统前，对其进行身份校验。用户在使用声网服务，如加入音视频通话或登录信令系统时，声网使用 Token 对其鉴权。

RTM 提供 Message Channel 和 Stream Channel 两种频道类型，使用不同类型的频道，对应的 Token 类型也不同：

• 使用 Message Channel：只需在调用 login 方法登录 RTM 系统时，传入开通了 RTM 服务的 Token（以下简称 RTM Token）。
• 使用 Stream Channel：在使用 RTM Token 鉴权的基础上，还需要在调用 join 方法加入 Stream Channel 时传入开通了 RTC 服务的 Token（以下简称 RTC Token）。

本文展示如何搭建一个使用 RTM Token 鉴权的客户端。使用 RTC Token 请参考使用 RTC Token 鉴权。

鉴权流程Copy Anchor Link

下图展示了 RTM Token 鉴权的基本流程：

RTM Token 在 App 服务器上生成，其最长有效期为 24 小时。当用户从你的 App 客户端登录到 RTM 系统时，声网平台会读取该 Token 中包含的信息，并进行校验。Token 包含以下信息：

• 你在声网控制台创建项目时生成的 App ID
• RTM 用户 ID
• RTM Token 过期的 Unix 时间戳

前提条件Copy Anchor Link

开始前，请确保你的项目或使用的声网产品满足如下条件：

• 已开启 App 证书的声网项目以及项目的 App ID，可参考开通服务获取。
• 已在你的项目中集成实时消息 SDK 并实现基本的收发消息功能，详见实现收发消息。

实现用户鉴权Copy Anchor Link

本节展示如何使用 Token 对客户端的用户进行鉴权。

1. 创建一个项目文件夹，其中包含如下文件：

   • index.html：用户界面
   • client.js：使用 RTM SDK 的 App 逻辑

   Copy Text

   |-- SDK/libs/agora-rtm-version.min.js
   |-- index.html
   |-- client.js

2. 将官网下载的 SDK 中的 libs 文件夹中的 JS 文件保存到你的项目下。

3. 在 index.html 中加入以下代码，创建用户界面。

   • 你需要将 <path to the JS file> 替换为你上一步保存的 JS 文件的路径。

   Copy Text

   <html>
   <head>
      <title>RTM Token demo</title>
   </head>
   <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
   <body>
      # Token demo
      <script src="<path to the JS file>"></script>
    <script src="./client.js"></script>
   
   </body>
   </html>

4. 将如下代码贴入 client.js 文件中，实现客户端鉴权逻辑。

   • 将 <Your App ID> 替换为你的 App ID。该 App ID 必须与 Token 生成代码中的 App ID 一致。
   • 将 <Your Host URL and port> 替换为你部署好的本地 Golang 服务器的主机 URL 和端口，如 10.53.3.234:8082 。

   Copy Text

   // 是否开启 Token 更新循环
   let started = true;
   
   function sleep(time) {
       return new Promise((resolve) => setTimeout(resolve, time));
   }
   
   function fetchToken(uid) {
       return new Promise(function (resolve) {
           axios
               .post(
                   "http://<Your Host URL and port>/fetch_rtm_token",
                   {
                       uid: uid,
                   },
                   {
                       headers: {
                           "Content-Type": "application/json; charset=UTF-8",
                       },
                   },
               )
               .then(function (response) {
                   const token = response.data.token;
                   resolve(token);
               })
               .catch(function (error) {
                   console.log(error);
               });
       });
   }
   
   async function loginRTM() {
       // 你的 App ID
       const appID = "<Your App ID>";
   
       // 设置 RTM 用户 ID
       const uid = "1234";
   
       // 获取 Token
       const token = await fetchToken(uid);
   
       // 初始化客户端
       const client = new AgoraRTM.RTM(appID, uid);
   
       // 显示连接状态变化
       client.addEventListener('linkState', function (event) {
           const currentState = event.currentState;
           const reason = event.reason;
           console.log("Link state changed to: " + currentState + " Reason: " + reason);
       });
   
       // 登录 RTM 系统
       await client.login({ token });
   
       while (started) {
           // 每 30 秒更新一次 Token。此更新频率是为了功能展示，生产环境建议每小时更新一次
           await sleep(30 * 1000);
           const newToken = await fetchToken(uid);
           await client.renewToken(newToken);
   
           const currentDate = new Date();
           const time = currentDate.getHours() + ":" + currentDate.getMinutes() + ":" + currentDate.getSeconds();
           console.log("Renew RTM token at " + time);
       }
   }
   
   loginRTM();

   在上述代码示例中，你可以看到 Token 与客户端的以下代码逻辑有关：

   • 使用 App ID、用户 ID 和 Token 初始化 RTM 实例。App ID 和用户 ID 必须和生成 Token 时使用的 App ID 和用户 ID 一致。
   • 调用 login 方法登录 RTM 系统。
   • 定时从服务端获取新的 Token 并调用 renewToken 方法更新 SDK 的 Token。声网建议你定时（例如每小时）从服务端生成 Token 并调用 renewToken 方法更新 SDK 的 Token，保证 SDK 的 Token 一直处于有效状态。

5. 用支持的浏览器打开 index.html 文件，进入开发者模式。在控制台可以看到客户端执行以下操作：

   • 成功登录 RTM 系统。
   • 每隔 30 秒调用 renewToken 方法更新 Token。

开发注意事项Copy Anchor Link

App 证书与 RTM TokenCopy Anchor Link

生成 RTM Token 需要先在控制台启用对应项目的 App 证书。项目一旦开启了 App 证书，就必须使用 RTM Token 鉴权。

RTM Token 过期Copy Anchor Link

你可以根据业务需求指定 RTM Token 的有效期 (最长为 24 小时)。当 RTM Token 将在 30 秒后过期时，会触发 tokenPrivilegeWillExpire 回调，提醒用户 Token 即将过期。收到该回调时，你可以在服务端重新生成 RTM Token，然后调用 renewToken 方法，将新生成的 RTM Token 传给 SDK。

如果 Token 已过期，则 SDK 会触发 linkState 回调，报告如下内容：

• 当前状态（currentState）：FAILED
• 触发本次状态迁移的操作（operation）：SERVER_REJECT
• 状态迁移的原因（reason）：TOKEN_EXPIRED

此时，用户需要先在端侧更新 Token，排除故障后再调用 login 方法重新登录。