Delete a message (original) (raw)

This guide explains how to use thedelete()method on the Message resource of the Google Chat API to delete a text or card message.

In the Chat API, a Chat message is represented by theMessage resource. While Chat users can only send messages that contain text, Chat apps can use many other messaging features, including displaying static or interactive user interfaces, collecting information from users, and delivering messages privately. To learn more about messaging features available for the Chat API, see theGoogle Chat messages overview.

With app authentication, you can use this method to delete a message that the Chat app sent. Withuser authentication, you can use this method to delete a message that the authenticated user sent. If the user is a space manager for the space, you might also be able to delete a message that other space members sent. For more information, see Learn about your role as a Space Manager.

Prerequisites

Node.js

• A Business or EnterpriseGoogle Workspace account with access toGoogle Chat.
• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Node.js Cloud Client Library.
  • Create access credentials based on how you want to authenticate in your Google Chat API request:
    * To authenticate as a Chat user,create OAuth client ID credentials and save the credentials as a JSON file namedcredentials.json to your local directory.
    * To authenticate as the Chat app,create service account credentials and save the credentials as a JSON file namedcredentials.json.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Python

• A Business or EnterpriseGoogle Workspace account with access toGoogle Chat.
• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Python Cloud Client Library.
  • Create access credentials based on how you want to authenticate in your Google Chat API request:
    * To authenticate as a Chat user,create OAuth client ID credentials and save the credentials as a JSON file namedcredentials.json to your local directory.
    * To authenticate as the Chat app,create service account credentials and save the credentials as a JSON file namedcredentials.json.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Java

• A Business or EnterpriseGoogle Workspace account with access toGoogle Chat.
• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Install the Java Cloud Client Library.
  • Create access credentials based on how you want to authenticate in your Google Chat API request:
    * To authenticate as a Chat user,create OAuth client ID credentials and save the credentials as a JSON file namedcredentials.json to your local directory.
    * To authenticate as the Chat app,create service account credentials and save the credentials as a JSON file namedcredentials.json.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Apps Script

• A Business or EnterpriseGoogle Workspace account with access toGoogle Chat.
• Set up your environment:
  • Create a Google Cloud project.
  • Configure the OAuth consent screen.
  • Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
  • Create a standalone Apps Script project, and turn on the Advanced Chat Service.
  • In this guide, you must use either user or app authentication. To authenticate as the Chat app, create service account credentials. For steps, seeAuthenticate and authorize as a Google Chat app.
• Choose an authorization scope based on whether you want to authenticate as a user or the Chat app.

Delete a message with user authentication

To delete a message with user authentication, pass the following in your request:

• Specify the chat.messages authorization scope.
• Call theDeleteMessage()method.
• Set name to the resource name of the message to delete.

The following example deletes a message withuser authentication:

Node.js

Python

Java

Apps Script

To run this sample, replace the following:

• SPACE_NAME: the ID from the space'sname. You can obtain the ID by calling theListSpaces() method or from the space's URL.
• MESSAGE_NAME: the ID from the message'sname. You can obtain the ID from the response body returned after creating a message asynchronously with the Chat API, or with thecustom name assigned to the message at creation.

If successful, the response body is empty, which indicates that the message is deleted.

Delete a message with app authentication

To delete a message withapp authentication, pass the following in your request:

• Specify the chat.bot authorization scope.
• Call theDeleteMessage()method.
• Set name to the resource name of the message to delete.

The following example deletes a message withapp authentication:

Node.js

Python

Java

Apps Script

To run this sample, replace the following:

• SPACE_NAME: the ID from the space'sname. You can obtain the ID by calling theListSpaces() method or from the space's URL.
• MESSAGE_NAME: the ID from the message'sname. You can obtain the ID from the response body returned after creating a message asynchronously with the Chat API, or with thecustom name assigned to the message at creation.

If successful, the response body is empty, which indicates that the message is deleted.

• Format a message.
• Get details about a message.
• List messages in a space.
• Update a message.
• Send a message.