Method: spaces.messages.create

پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید.

فراخوانی این روش نیاز به احراز هویت دارد و از انواع احراز هویت زیر پشتیبانی می کند:

  • برای پیام های متنی، احراز هویت کاربر یا تأیید اعتبار برنامه پشتیبانی می شود.
  • برای پیام های کارت، فقط احراز هویت برنامه پشتیبانی می شود. (فقط برنامه‌های چت می‌توانند پیام‌های کارت ایجاد کنند.)

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

مولفه های
parent

string

ضروری. نام منبع فضایی که در آن پیام ایجاد می شود.

قالب: spaces/{space}

پارامترهای پرس و جو

مولفه های
threadKey
(deprecated)

string

اختیاری. منسوخ شده: به جای آن از thread.thread_key استفاده کنید. شناسه تاپیک پشتیبانی از حداکثر 4000 کاراکتر برای شروع یا اضافه کردن به یک رشته، یک پیام ایجاد کنید و یک threadKey یا thread.name را مشخص کنید. برای مثال استفاده، شروع یا پاسخ دادن به رشته پیام را ببینید.

requestId

string

اختیاری. یک شناسه درخواست منحصر به فرد برای این پیام. تعیین شناسه درخواست موجود، پیام ایجاد شده با آن شناسه را به جای ایجاد یک پیام جدید برمی گرداند.

messageReplyOption

enum ( MessageReplyOption )

اختیاری. مشخص می کند که آیا یک پیام یک رشته را شروع می کند یا به یکی پاسخ می دهد. فقط در فضاهای نامگذاری شده پشتیبانی می شود.

messageId

string

اختیاری. یک شناسه سفارشی برای یک پیام. به برنامه‌های گپ اجازه می‌دهد بدون نیاز به ذخیره شناسه اختصاص داده شده به سیستم در نام منبع پیام (که در قسمت name پیام نشان داده شده است) پیامی را دریافت، به‌روزرسانی یا حذف کنند.

مقدار این فیلد باید شرایط زیر را داشته باشد:

  • با client- شروع می شود- . برای مثال، client-custom-name یک شناسه سفارشی معتبر است، اما custom-name نیست.
  • دارای حداکثر 63 کاراکتر و فقط حروف کوچک، اعداد و خط فاصله است.
  • در یک فضا منحصر به فرد است. برنامه چت نمی‌تواند از یک شناسه سفارشی برای پیام‌های مختلف استفاده کند.

برای جزئیات، به نام پیام مراجعه کنید.

درخواست بدن

بدنه درخواست شامل یک نمونه از 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

نحوه پاسخ دادن به یک پیام را مشخص می کند. ممکن است در آینده ایالت های بیشتری اضافه شود.

Enums
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 برگردانده می شود.