Method: spaces.messages.list

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

از انواع اصالت‌سنجی زیر پشتیبانی می‌کند:

  • اصالت‌سنجی برنامه با تأیید سرپرست با دامنه مجوز:

    • https://www.googleapis.com/auth/chat.app.messages.readonly. هنگام استفاده از این دامنه اصالت‌سنجی، این روش فقط پیام‌های عمومی را در فضا برمی‌گرداند. این شامل پیام‌های خصوصی نمی‌شود.

  • اصالت‌سنجی کاربر با یکی از دامنه‌های مجوز زیر:

    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (فقط فضاهای حالت وارد کردن)

درخواست HTTP

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

نشانی وب از نحو تراتبدیل gRPC استفاده می‌کند.

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

پارامترها
parent

string

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

قالب: spaces/{space}

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

پارامترها
pageSize

integer

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

اگر مشخص نشده باشد، حداکثر ۲۵ مورد برگردانده می‌شود.

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

مقادیر منفی خطای 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

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

enum (MarkupSyntax)

اختیاری. نحو خروجی موردنظر را برای فیلد formattedText پیام Chat مشخص می‌کند.

متن درخواست

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

بدنه پاسخ

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

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

نمایش 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
  • https://www.googleapis.com/auth/chat.app.messages.readonly

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