列出消息

本指南介绍了如何对以下资源的 Message 资源使用 list 方法： Google Chat API，以查看聊天室中可过滤的分页消息列表。

通过 Message 资源 代表 文本 或 卡片 消息。您可以 在 Google Chat API 中通过调用 create、get、update 或 delete 消息 相应的方法有关短信和卡片消息的详情，请参阅 Google Chat 消息概览。

前提条件

Python

  • Python 3.6 或更高版本
  • pip 软件包管理工具
  • 最新的 Google 客户端库。若要安装或更新这些应用 在命令行界面中运行以下命令： 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

列出消息

列出带有 用户身份验证， 请在请求中传递以下内容：

以下示例列出了 Chat 聊天室中发送 2023 年 3 月 16 日：

Python

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

  2. 在 chat_messages_list.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 lists messages in a space sent after March 16, 2023.
    '''

    # 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().list(

          # The space for which to list messages.
          parent = 'spaces/SPACE',

          # An optional filter that returns messages
          # created after March 16, 2023.
          filter = 'createTime > "2023-03-16T00:00:00-00:00"'

      ).execute()

    # Prints the list of messages.
    print(result)

if __name__ == '__main__':
    main()

  3. 在代码中，将 SPACE 替换为聊天室名称， 您可以从 spaces.list 方法 或通过聊天室网址发送。

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

    python3 chat_messages_list.py

之后，Google Chat API 会返回在指定聊天室中发送的消息列表， 2023 年 3 月 16 日