获取消息详情

本指南介绍了如何使用 Message 资源的 get 方法 使用 Google Chat API 返回有关文本或卡片消息的详细信息。

在 Chat API 中，Chat 消息由 Message 资源。 Chat 用户只能发送包含文字的消息， 聊天应用可以使用许多其他即时通讯功能，包括 显示静态或交互式界面，从 以及以私密方式传递消息。详细了解消息功能 功能的详细信息，请参阅 Google Chat 消息概览。

前提条件

Python

接收通过用户身份验证的消息

使用 用户身份验证， 请在请求中传递以下内容：

  • 指定 chat.messages.readonly 或 chat.messages 授权范围。
  • 调用 get 方法 在 Message 资源。
  • 将 name 设置为要获取的消息的资源名称。

以下示例使用 用户身份验证：

Python

  1. 在您的工作目录中，创建一个名为 chat_message_get_user.py 的文件。

  2. 在 chat_message_get_user.py 中添加以下代码：

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets a message.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().messages().get(

        # The message to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name = 'spaces/SPACE/messages/MESSAGE'

    ).execute()

    # Prints details about the message.
    print(result)

if __name__ == '__main__':
    main()

  3. 在代码中进行以下替换：

    • SPACE：聊天室名称，您可以从中获取 该 spaces.list 方法 或通过聊天室网址发送。
    • MESSAGE：消息名称，您可以获取 从异步创建消息后返回的响应正文中 或者通过 自定义名称 分配给消息。

  4. 在您的工作目录中，构建并运行该示例：

    python3 chat_message_get_user.py

Chat API 会返回 Message 用于详细说明指定消息的内容。

通过应用身份验证接收消息

使用 应用身份验证， 请在请求中传递以下内容：

  • 指定 chat.bot 授权范围。
  • 调用 get 方法 在 Message 资源。
  • 将 name 设置为要获取的消息的资源名称。

以下示例使用 应用身份验证：

Python

  1. 在您的工作目录中，创建一个名为 chat_get_message_app.py 的文件。

  2. 在 chat_get_message_app.py 中添加以下代码：

    from google.oauth2 import service_account
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', credentials=CREDENTIALS)

# Get a Chat message.
result = chat.spaces().messages().get(

    # The message to get.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    #
    # Replace MESSAGE with a message name.
    # Obtain the message name from the response body returned
    # after creating a message asynchronously with Chat REST API.
    name='spaces/SPACE/messages/MESSAGE'

  ).execute()

# Print Chat API's response in your command line interface.
print(result)

  3. 在代码中进行以下替换：

    • SPACE：聊天室的 name 消息已发布，您可以从 spaces.list 方法 或通过聊天室网址发送。

    • MESSAGE：消息名称，您可以获取 从异步创建消息后返回的响应正文中 或者通过 自定义名称 分配给消息。

  4. 在您的工作目录中，构建并运行该示例：

    python3 chat_get_message_app.py

Chat API 会返回 Message 用于详细说明指定消息的内容。