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 بايت.

بالنسبة إلى طلبات Webhook، لا تحتوي الاستجابة على الرسالة الكاملة. لا تملأ الاستجابة سوى الحقلَين 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

اختياريّ. معرّف طلب فريد لهذه الرسالة. يؤدي تحديد معرّف طلب حالي إلى عرض الرسالة التي تم إنشاؤها باستخدام هذا المعرّف بدلاً من إنشاء رسالة جديدة.
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.

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