Method: spaces.messages.list

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المَعلمات
parent

string

مطلوبة. اسم مورد المساحة لإدراج الرسائل منه.

التنسيق: spaces/{space}

معلمات طلب البحث

المَعلمات
pageSize

integer

الحد الأقصى لعدد الرسائل المعروضة. قد تعرض الخدمة رسائل أقل من هذه القيمة.

وإذا لم يتم تحديدها، سيتم عرض 25 كحد أقصى.

الحد الأقصى للقيمة هو 1,000. إذا كنت تستخدم قيمة تزيد عن 1,000، يتم تغييرها تلقائيًا إلى 1,000.

تعرض القيم السلبية خطأ 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

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