查找私信 (DM) 聊天室

本指南介绍了如何对 Google Chat API 的 Space 资源使用 findDirectMessage() 方法来获取有关私信 (DM) 聊天室的详细信息。

Space 资源表示用户和 Chat 应用可以发送消息、共享文件和协作的场所。聊天室有以下几种类型：

  • 私信 (DM) 是指两位用户或用户与 Chat 应用之间的对话。
  • 群组聊天是指三人或更多用户与 Chat 应用之间的对话。
  • 命名聊天室是用户发送消息、共享文件和协作的永久性场所。

通过应用身份验证进行身份验证后，Chat 应用可以获取其在 Google Chat 中有权访问的私信（例如其成员的私信）。使用用户身份验证进行身份验证会返回经过身份验证的用户有权访问的私信。

前提条件

Node.js

查找私信

如需在 Google Chat 中查找私信，请在请求中传递以下内容：

  • 使用应用身份验证时，请指定 chat.bot 授权范围。使用用户身份验证时，请指定 chat.spaces.readonly 或 chat.spaces 授权范围。
  • 调用 FindDirectMessage()，方法传递 DM 中另一位用户的 name 以返回结果。在进行用户身份验证的情况下，此方法会返回调用方用户与指定用户之间的私信。在进行应用身份验证的情况下，此方法会返回调用应用与指定用户之间的私信。
  • 如需将真人用户添加为聊天室成员，请指定 users/{user}，其中 {user} 是 People API 中 person 的 {person_id} 或 Directory API 中 user 的 ID。例如，如果 People API 人员 resourceName 为 people/123456789，您可以通过添加 users/123456789 作为 member.name 的成员资格，将该用户添加到聊天室。

查找需要用户身份验证的私信

如需查找需要用户身份验证的私信，请按以下步骤操作：

Node.js

chat/client-libraries/cloud/find-dm-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.readonly'];

// This sample shows how to find a Direct Message space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace USER_NAME here
    name: 'users/USER_NAME'
  };

  // Make the request
  const response = await chatClient.findDirectMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

如需运行此示例，请将 USER_NAME 替换为用户的 name 字段中的 ID。

Chat API 会返回一个 Space 实例，其中详细说明了指定的私信。

使用应用身份验证查找私信

如需使用应用身份验证查找私信，请按以下步骤操作：

Node.js

chat/client-libraries/cloud/find-dm-space-app-cred.js
import {createClientWithAppCredentials} from './authentication-utils.js';

// This sample shows how to find a Direct Message space with app credential
async function main() {
  // Create a client
  const chatClient = createClientWithAppCredentials();

  // Initialize request argument(s)
  const request = {
    // Replace USER_NAME here
    name: 'users/USER_NAME'
  };

  // Make the request
  const response = await chatClient.findDirectMessage(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

如需运行此示例，请将 USER_NAME 替换为用户的 name 字段中的 ID。

Chat API 会返回一个 Space 实例，其中详细说明了指定的私信。