- طلب HTTP
- مَعلمات المسار
- معلمات طلب البحث
- نص الطلب
- نص الاستجابة
- نطاقات الأذونات
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- جرِّبه الآن
ينشئ رسالة في مساحة Chat في Google Chat. للاطّلاع على مثال، يُرجى مراجعة إرسال رسالة.
يتيح الأنواع التالية من المصادقة:
- مصادقة التطبيق باستخدام نطاق التفويض:
https://www.googleapis.com/auth/chat.bot
- مصادقة المستخدم باستخدام أحد نطاقات التفويض التالية:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messageshttps://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 |
الحقل مطلوب. اسم المورد للمساحة التي سيتم إنشاء رسالة فيها التنسيق: |
مَعلمات طلب البحث
| المعلمات | |
|---|---|
threadKey |
اختيارية: تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة |
requestId |
اختيارية: معرّف فريد لهذا الطلب ننصح باستخدام معرّف UUID عشوائي. يؤدي تحديد معرّف الطلب إلى جعل الطلب متكررًا، ما يضمن أنّ الطلبات المتعددة المتطابقة التي تحمل معرّف الطلب نفسه تؤدي إلى إنشاء رسالة واحدة فقط. وتؤدي الطلبات اللاحقة التي تتضمّن معرّف الطلب نفسه إلى عرض الرسالة الحالية ولا تعدّلها، حتى إذا كانت التفاصيل المطلوبة تختلف عن الحالة الحالية. لاستخدام هذا الحقل بفعالية:
|
messageReplyOption |
اختيارية: تحدّد ما إذا كانت الرسالة تبدأ سلسلة محادثات أو تردّ على رسالة أخرى. لا تتوفّر هذه الميزة إلا في المساحات المُسمّاة. عند الردّ على تفاعلات المستخدمين، يتم تجاهل هذا الحقل. بالنسبة إلى التفاعلات ضمن سلسلة محادثات، يتم إنشاء الردّ في سلسلة المحادثات نفسها. وإلا، سيتم إنشاء الرد كسلسلة محادثات جديدة. |
messageId |
اختيارية: معرّف مخصّص لرسالة يتيح لتطبيقات Chat الحصول على رسالة أو تعديلها أو حذفها بدون الحاجة إلى تخزين المعرّف الذي يحدّده النظام في اسم مورد الرسالة (الممثّل في حقل يجب أن تستوفي قيمة هذا الحقل المتطلبات التالية:
لمعرفة التفاصيل، يُرجى الاطّلاع على تسمية رسالة. |
createMessageNotificationOptions |
اختيارية: تتحكّم هذه السياسة في سلوك الإشعارات عند نشر الرسالة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة فرض الإشعارات أو إرسال رسائل صامتة. |
نص الطلب
يحتوي نص الطلب على مثال Message.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على مثال Message تم إنشاؤه حديثًا.
نطاقات الأذونات
يتطلب أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
MessageReplyOption
تحدّد هذه السمة كيفية الردّ على رسالة. وقد تتم إضافة المزيد من الولايات في المستقبل.
| عمليات التعداد | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
تلقائي: لبدء سلسلة محادثات جديدة يؤدي استخدام هذا الخيار إلى تجاهل أي thread ID أو مضمّن. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
يتم إنشاء الرسالة كردّ على سلسلة المحادثات المحدّدة من خلال thread ID أو . وفي حال تعذّر ذلك، تبدأ الرسالة سلسلة محادثات جديدة بدلاً من ذلك. |
REPLY_MESSAGE_OR_FAIL |
يتم إنشاء الرسالة كردّ على سلسلة المحادثات المحدّدة من خلال thread ID أو . إذا تم استخدام threadKey جديد، يتم إنشاء سلسلة محادثات جديدة. إذا تعذّر إنشاء الرسالة، سيتم عرض الخطأ NOT_FOUND بدلاً من ذلك. |
CreateMessageNotificationOptions
خيارات سلوك الإشعار عند نشر الرسالة
| تمثيل JSON |
|---|
{
"notificationType": enum ( |
| الحقول | |
|---|---|
notificationType |
نوع الإشعار للرسالة |
NotificationType
خيارات أنواع الإشعارات للرسالة
| عمليات التعداد | |
|---|---|
NOTIFICATION_TYPE_NONE |
الإعداد التلقائي يشبه سلوك الإشعارات ما يحدث عندما يرسل المستخدم البشري الرسالة باستخدام واجهة مستخدم Chat: لا يتم إرسال أي إشعار إلى المُرسِل البشري. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
يتم إرسال إشعار (إشعارات فورية أو إشعارات عبر البريد الإلكتروني أو غير ذلك) إلى منشئ الرسالة (على سبيل المثال، المستخدم الذي تم استخدام مصادقته لإنشاء الرسالة) ويتم وضع علامة على الرسالة كغير مقروءة. لن يؤدي هذا الإجراء إلى إلغاء إعدادات إشعارات المستخدمين الحالية في المساحة. على سبيل المثال، إذا اختار المستخدم عدم تلقّي إشعارات بشأن مساحة معيّنة، لن يتم إرسال إشعارات إليه حتى إذا تم ضبط هذا الخيار. يتطلب ذلك مصادقة المستخدم. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
فرض إرسال إشعار إلى المستلِمين يؤدي ذلك إلى تجاوز إعدادات إشعارات المساحة لدى المستخدمين وإعدادات "عدم الإزعاج" في Chat. لا يتجاوز هذا الخيار إعدادات "عدم الإزعاج" على مستوى الجهاز. يتطلّب ذلك مصادقة التطبيق. |
NOTIFICATION_TYPE_SILENT |
لا يتم إشعار المستلِمين، ولا يتم وضع علامة "غير مقروءة" على الرسالة. ويشبه هذا الإجراء كتم صوت المحادثة أو تفعيل ميزة عدم الإزعاج في Chat. يتطلّب ذلك مصادقة التطبيق. |