Method: spaces.messages.list

پیام‌ها را در فضایی فهرست می‌کند که تماس‌گیرنده عضو آن است، از جمله پیام‌های اعضای مسدود شده و فضاها. اگر پیام‌هایی را از یک فضای بدون پیام فهرست کنید، پاسخ یک شی خالی است. هنگام استفاده از رابط REST/HTTP، پاسخ حاوی یک شی JSON خالی، {} است. برای مثال، فهرست پیام‌ها را ببینید.

نیاز به احراز هویت کاربر دارد.

درخواست HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messages

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
parent

string

مورد نیاز. نام منبع فضایی برای فهرست کردن پیام‌ها.

قالب: spaces/{space}

پارامترهای پرس و جو

پارامترها
pageSize

integer

اختیاری. حداکثر تعداد پیام های برگشتی این سرویس ممکن است پیام های کمتری از این مقدار را برگرداند.

اگر مشخص نشده باشد، حداکثر 25 عدد برگردانده می شود.

حداکثر مقدار 1000 است. اگر از مقداری بیش از 1000 استفاده می کنید، به طور خودکار به 1000 تغییر می کند.

مقادیر منفی یک خطای INVALID_ARGUMENT را برمی‌گرداند.

pageToken

string

اختیاری. نشانه صفحه دریافت شده از تماس پیام های لیست قبلی. این پارامتر را برای بازیابی صفحه بعدی ارائه کنید.

هنگام صفحه بندی، تمام پارامترهای دیگر ارائه شده باید با فراخوانی که توکن صفحه را ارائه می کند مطابقت داشته باشد. انتقال مقادیر مختلف به سایر پارامترها ممکن است منجر به نتایج غیرمنتظره شود.

filter

string

اختیاری. یک فیلتر پرس و جو

می توانید پیام ها را بر اساس تاریخ ( createTime ) و رشته ( thread.name ) فیلتر کنید.

برای فیلتر کردن پیام‌ها بر اساس تاریخ ایجاد آنها، createTime با یک مهر زمانی در قالب RFC-3339 و دو علامت نقل قول مشخص کنید. به عنوان مثال، "2023-04-21T11:30:00-04:00" . می توانید از بزرگتر از عملگر > برای فهرست کردن پیام هایی که پس از مهر زمانی ایجاد شده اند یا کمتر از عملگر < برای فهرست کردن پیام هایی که قبل از مهر زمانی ایجاد شده اند استفاده کنید. برای فیلتر کردن پیام ها در یک بازه زمانی، از عملگر AND بین دو مهر زمانی استفاده کنید.

برای فیلتر کردن بر اساس رشته، thread.name مشخص کنید که به صورت spaces/{space}/threads/{thread} قالب‌بندی شده است. شما فقط می توانید یک thread.name در هر پرس و جو تعیین کنید.

برای فیلتر کردن بر اساس موضوع و تاریخ، از عملگر AND در درخواست خود استفاده کنید.

به عنوان مثال، پرس و جوهای زیر معتبر هستند:

createTime > "2012-04-21T11:30:00-04:00"

createTime > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

createTime > "2012-04-21T11:30:00+00:00" AND

createTime < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

درخواست‌های نامعتبر توسط سرور با خطای INVALID_ARGUMENT رد می‌شوند.

orderBy

string

اختیاری. نحوه ترتیب لیست پیام ها مقداری را برای سفارش با یک عملیات سفارشی مشخص کنید. مقادیر عملیات سفارش معتبر به شرح زیر است:

  • ASC برای صعود.

  • DESC برای نزول.

ترتیب پیش‌فرض createTime ASC است.

showDeleted

boolean

اختیاری. آیا شامل پیام های حذف شده است یا خیر. پیام‌های حذف‌شده شامل زمان حذف شده و ابرداده‌های مربوط به حذف آن‌ها است، اما محتوای پیام در دسترس نیست.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

پیام پاسخ برای لیست کردن پیام ها.

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "messages": [
    {
      object (Message)
    }
  ],
  "nextPageToken": string
}
فیلدها
messages[]

object ( Message )

لیست پیام ها

nextPageToken

string

برای بازیابی صفحه بعدی نتایج، می توانید یک نشانه به عنوان pageToken ارسال کنید. اگر خالی باشد، هیچ صفحه بعدی وجود ندارد.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.