Method: spaces.findDirectMessage
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
返回与指定用户的现有私信。如果找不到直接消息空间,则返回 404 NOT_FOUND
错误。如需查看示例,请参阅查找私信。
在进行应用身份验证的情况下,返回指定用户与调用 Chat 应用之间的私信聊天室。
在进行用户身份验证后,返回指定用户与经过身份验证的用户之间的私信空间。
支持以下类型的身份验证:
使用授权范围进行应用身份验证:
https://www.googleapis.com/auth/chat.bot
使用以下某个授权范围进行用户身份验证:
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.spaces
HTTP 请求
GET https://chat.googleapis.com/v1/spaces:findDirectMessage
网址采用 gRPC 转码语法。
查询参数
参数 |
name |
string
必需。要查找私信内容的用户的资源名称。 格式:users/{user} ,其中 {user} 是 People API 中的用户的 id ,或 Directory API 中的用户的 id 。例如,如果 People API 个人资料 ID 为 123456789 ,您可以使用 users/123456789 作为 name 来查找与该用户的私信。以用户身份进行身份验证后,您可以将电子邮件地址用作 {user} 的别名。例如,users/example@gmail.com ,其中 example@gmail.com 是 Google Chat 用户的电子邮件地址。
|
响应正文
如果成功,则响应正文包含一个 Space
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.readonly
https://www.googleapis.com/auth/chat.bot
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eRetrieves the existing direct message with a specified user or Chat app, returning a 404 error if none is found.\u003c/p\u003e\n"],["\u003cp\u003eSupports both app authentication and user authentication for finding direct messages.\u003c/p\u003e\n"],["\u003cp\u003eRequires providing the resource name of the user in the \u003ccode\u003ename\u003c/code\u003e query parameter using specific formats.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e HTTP request to the \u003ccode\u003ehttps://chat.googleapis.com/v1/spaces:findDirectMessage\u003c/code\u003e endpoint with gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with specific OAuth scopes like \u003ccode\u003echat.spaces\u003c/code\u003e, \u003ccode\u003echat.spaces.readonly\u003c/code\u003e, or \u003ccode\u003echat.bot\u003c/code\u003e.\u003c/p\u003e\n"]]],["This outlines how to retrieve an existing direct message space with a specific user via the Chat API. Use a `GET` request to `https://chat.googleapis.com/v1/spaces:findDirectMessage`. Provide the target user's resource name in the `name` query parameter (e.g., `users/123456789`). The request body should be empty. Upon success, the response includes a `Space` resource. Requires either App or User authentication and specific OAuth scopes like `chat.spaces` or `chat.spaces.readonly`.\n"],null,["# Method: spaces.findDirectMessage\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message).\n\nWith [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app.\n\nWith [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user.\n\nSupports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize):\n\n- [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with the authorization scope:\n\n - `https://www.googleapis.com/auth/chat.bot`\n- [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes:\n\n - `https://www.googleapis.com/auth/chat.spaces.readonly`\n - `https://www.googleapis.com/auth/chat.spaces`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/spaces:findDirectMessage`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the user to find direct message with. Format: `users/{user}`, where `{user}` is either the `id` for the [person](https://developers.google.com/people/api/rest/v1/people) from the People API, or the `id` for the [user](https://developers.google.com/admin-sdk/directory/reference/rest/v1/users) in the Directory API. For example, if the People API profile ID is `123456789`, you can find a direct message with that person by using `users/123456789` as the `name`. When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the email as an alias for `{user}`. For example, `users/example@gmail.com` where `example@gmail.com` is the email of the Google Chat user. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Space](/workspace/chat/api/reference/rest/v1/spaces#Space).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.spaces`\n- `https://www.googleapis.com/auth/chat.spaces.readonly`\n- `https://www.googleapis.com/auth/chat.bot`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]