Method: spaces.messages.delete
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
刪除訊息。如需範例,請參閱「刪除訊息」。
支援下列類型的驗證:
使用授權範圍的應用程式驗證:
https://www.googleapis.com/auth/chat.bot
使用下列其中一個授權範圍進行使用者驗證:
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.import
(僅限匯入模式聊天室)
使用應用程式驗證時,要求只能刪除由呼叫的 Chat 應用程式建立的訊息。
HTTP 要求
DELETE https://chat.googleapis.com/v1/{name=spaces/*/messages/*}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
name |
string
必要欄位。訊息的資源名稱。 格式:spaces/{space}/messages/{message} 如果您為訊息設定了自訂 ID,可以使用 clientAssignedMessageId 欄位的值來代替 {message} 。詳情請參閱「命名訊息」。
|
查詢參數
參數 |
force |
boolean
(非必要) 在 true 時,刪除訊息也會一併刪除其分支回覆。當 false 時,如果訊息有討論串回覆,刪除作業就會失敗。 只有在以使用者身分進行驗證時才會套用。以 Chat 應用程式身分驗證時無效。
|
回應主體
如果成功,回應主體會是空白的 JSON 物件。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.import
https://www.googleapis.com/auth/chat.messages
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\u003cp\u003eThis method enables you to delete messages and optionally their replies using an HTTP DELETE request.\u003c/p\u003e\n"],["\u003cp\u003eIt supports both app and user authentication, with app authentication limiting deletion to messages created by the app.\u003c/p\u003e\n"],["\u003cp\u003eYou can specify whether to force delete threaded replies with the \u003ccode\u003eforce\u003c/code\u003e query parameter when using user authentication.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the message's resource name in the URL path and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using one of the specified OAuth scopes.\u003c/p\u003e\n"]]],["This document details how to delete a message using the Chat API. The `DELETE` request targets a specific message's resource name in the format `spaces/*/messages/*`. It supports both app and user authentication, with different limitations for each. The request requires a message's name as a path parameter. A `force` query parameter is optional for user authentication to delete threaded replies. The request body is empty, and a successful response returns an empty JSON object. One of three specified OAuth scopes is required.\n"],null,["# Method: spaces.messages.delete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\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\nDeletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages).\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.messages`\n - `https://www.googleapis.com/auth/chat.import` (import mode spaces only)\n\nWhen using app authentication, requests can only delete messages created by the calling Chat app.\n\n### HTTP request\n\n`DELETE https://chat.googleapis.com/v1/{name=spaces/*/messages/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the message. Format: `spaces/{space}/messages/{message}` If you've set a custom ID for your message, you can use the value from the `clientAssignedMessageId` field for `{message}`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message). |\n\n### Query parameters\n\n| Parameters ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `force` | `boolean` Optional. When `true`, deleting a message also deletes its threaded replies. When `false`, if a message has threaded replies, deletion fails. Only applies when [authenticating as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Has no effect when [authenticating as a Chat app](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.bot`\n- `https://www.googleapis.com/auth/chat.import`\n- `https://www.googleapis.com/auth/chat.messages`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]