Method: spaces.messages.create

يتم إنشاء رسالة في مساحة Google Chat. للاطّلاع على مثال، يُرجى مراجعة مقالة إرسال رسالة.

تتوفّر الأنواع التالية من المصادقة:

  • مصادقة التطبيق باستخدام نطاق التفويض:
    • https://www.googleapis.com/auth/chat.bot
  • مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (مساحات وضع الاستيراد فقط)

يُسنِد Chat مُرسِل الرسالة بشكل مختلف استنادًا إلى نوع المصادقة الذي تستخدمه في طلبك.

تعرض الصورة التالية كيفية إسناد Chat لرسالة عند استخدام مصادقة التطبيق. يعرض Chat تطبيق Chat كمُرسِل للرسالة. يمكن أن يحتوي محتوى الرسالة على نص (text) وبطاقات (cardsV2) وعناصر واجهة مستخدم إضافية (accessoryWidgets).

تم إرسال الرسالة بعد مصادقة التطبيق

تعرض الصورة التالية كيفية إسناد Chat لرسالة عند استخدام مصادقة المستخدم. يعرض Chat المستخدم كمُرسِل للرسالة ويُسنِد تطبيق Chat إلى الرسالة من خلال عرض اسمه. يمكن أن يحتوي محتوى الرسالة على نص (text) فقط.

الرسالة المُرسَلة مع مصادقة المستخدم

الحد الأقصى لحجم الرسالة، بما في ذلك محتوى الرسالة، هو 32,000 بايت.

بالنسبة إلى طلبات الويب هوك، لا تحتوي الاستجابة على الرسالة الكاملة. لا تملأ الاستجابة سوى الحقلَين name وthread.name بالإضافة إلى المعلومات الواردة في الطلب.

طلب HTTP

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

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

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

المَعلمات
parent

string

الحقل مطلوب. اسم المورد للمساحة التي سيتم إنشاء رسالة فيها.

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

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

المَعلمات
threadKey
(deprecated)

string

اختياريّ. تم إيقاف هذه الميزة: يُرجى استخدام thread.thread_key بدلاً منها. معرّف سلسلة المحادثات. يمكن أن يحتوي على ما يصل إلى 4000 حرف. لبدء سلسلة محادثات أو الإضافة إليها، يمكنك إنشاء رسالة وتحديد threadKey أو thread.name. للاطّلاع على مثال عن كيفية الاستخدام، يُرجى مراجعة مقالة بدء سلسلة محادثات أو الردّ عليها.
requestId

string

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

لاستخدام هذا الحقل بفعالية:

  • تأكَّد من أنّ الطلبات اللاحقة متطابقة وتستخدم بيانات المصادقة نفسها المستخدَمة في الطلب الأصلي.
  • إذا سبق إنشاء رسالة باستخدام معرّف الطلب المقدَّم، يعرض الطلب هذه الرسالة. يُرجى العِلم أنّ الرسالة المعروضة قد لا تكون مكتملة، إذ يعرض واجهة برمجة التطبيقات الرسالة في طلبك مع ملء أسماء الموارد التي يحدّدها النظام. لاسترداد أحدث البيانات الوصفية للرسالة، يمكنك استدعاء messages.get.
  • يؤدي إعادة استخدام معرّف طلب حالي مع مستخدم مصادَق مختلف إلى حدوث خطأ.
messageReplyOption

enum (MessageReplyOption)

اختياريّ. يحدّد ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على سلسلة محادثات. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة.

عند الردّ على تفاعلات المستخدمين، يتم تجاهل هذا الحقل. بالنسبة إلى التفاعلات ضمن سلسلة محادثات، يتم إنشاء الردّ في سلسلة المحادثات نفسها. بخلاف ذلك، يتم إنشاء الردّ كسلسلة محادثات جديدة.
messageId

string

اختياريّ. معرّف مخصّص للرسالة. يسمح لتطبيقات Chat بالحصول على رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين المعرّف الذي يحدّده النظام في اسم مورد الرسالة (الممثَّل في حقل name للرسالة).

يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية:

  • تبدأ بـ client-. على سبيل المثال، client-custom-name هو معرّف مخصّص صالح، ولكن custom-name ليس كذلك.
  • يحتوي على ما يصل إلى 63 حرفًا وأحرف صغيرة وأرقامًا وواصلات فقط.
  • يكون فريدًا ضمن مساحة معيّنة. لا يمكن لتطبيق Chat استخدام المعرّف المخصّص نفسه لرسائل مختلفة.

لمعرفة التفاصيل، يُرجى مراجعة مقالة تسمية رسالة.
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

اختياريّ. يتحكّم في سلوك الإشعار عند نشر الرسالة. لمزيد من المعلومات، يُرجى مراجعة مقالة فرض الإشعارات أو إرسال رسائل صامتة.

نص الطلب

يحتوي نص الطلب على مثال Message.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال Message تم إنشاؤه حديثًا.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

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

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

MessageReplyOption

يحدّد كيفية الردّ على رسالة. قد تتم إضافة المزيد من الحالات في المستقبل.

عمليات التعداد
MESSAGE_REPLY_OPTION_UNSPECIFIED تلقائي: يبدأ سلسلة محادثات جديدة. عند استخدام هذا الخيار، يتم تجاهل أي thread ID أو threadKey مضمّنَين.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD ينشئ الرسالة كردّ على سلسلة المحادثات المحدّدة من خلال thread ID أو threadKey. إذا تعذّر ذلك، تبدأ الرسالة سلسلة محادثات جديدة بدلاً من ذلك.
REPLY_MESSAGE_OR_FAIL ينشئ الرسالة كردّ على سلسلة المحادثات المحدّدة من خلال thread ID أو threadKey. إذا تم استخدام threadKey جديد، يتم إنشاء سلسلة محادثات جديدة. إذا تعذّر إنشاء الرسالة، يتم عرض الخطأ NOT_FOUND بدلاً من ذلك.

CreateMessageNotificationOptions

خيارات سلوك الإشعار عند نشر الرسالة.

تمثيل JSON 
{
  "notificationType": enum (NotificationType)
}
الحقول
notificationType

enum (NotificationType)

نوع الإشعار للرسالة.

NotificationType

خيارات أنواع الإشعارات للرسالة.

عمليات التعداد
NOTIFICATION_TYPE_NONE السلوك التلقائي: يكون سلوك الإشعار مشابهًا لسلوك الإشعار عندما يرسل المستخدم البشري الرسالة باستخدام واجهة مستخدم Chat: لا يتم إرسال أي إشعار إلى المُرسِل البشري.
NOTIFICATION_TYPE_FORCE_NOTIFY

فرض إرسال إشعار إلى المستلِمين: يؤدي هذا الخيار إلى تجاهل إعدادات إشعارات المساحة وإعدادات عدم الإزعاج في Chat لدى المستخدمين. لا يتجاهل هذا الخيار إعدادات "عدم الإزعاج" على مستوى الجهاز.

يتطلب هذا الخيار مصادقة التطبيق.
NOTIFICATION_TYPE_SILENT

عدم إرسال إشعار إلى المستلِمين وعدم وضع علامة "غير مقروءة" على الرسالة: يكون هذا السلوك مشابهًا لسلوك المستخدم عند كتم المحادثة أو تفعيل إعداد "عدم الإزعاج" في Chat.

يتطلب هذا الخيار مصادقة التطبيق.