Method: spaces.messages.list

يسرد الرسائل في مساحة يكون المتصل عضوًا فيها، بما في ذلك الرسائل من الأعضاء المحظورين والمساحات. مثلاً، راجِع سرد الرسائل. يتطلب مصادقة المستخدم.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

معلمات المسار

المَعلمات
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

لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.