- درخواست HTTP
- پارامترهای مسیر
- پارامترهای پرس و جو
- درخواست بدن
- بدن پاسخگو
- محدوده مجوز
- MessageReplyOption
- آن را امتحان کنید!
پیامی را در فضای چت Google ایجاد می کند. برای مثال، به ارسال پیام مراجعه کنید.
متد create()
به احراز هویت کاربر یا برنامه نیاز دارد. Chat بسته به نوع احراز هویتی که در درخواست خود استفاده می کنید، فرستنده پیام را متفاوت نسبت می دهد.
تصویر زیر نشان می دهد که چگونه Chat هنگام استفاده از احراز هویت برنامه، پیامی را نسبت می دهد. Chat برنامه چت را به عنوان فرستنده پیام نمایش می دهد. محتوای پیام میتواند شامل متن ( text
)، کارتها ( cardsV2
) و ابزارکهای جانبی ( accessoryWidgets
) باشد.
تصویر زیر نشان میدهد که چگونه Chat هنگام استفاده از احراز هویت کاربر، یک پیام را مشخص میکند. Chat کاربر را به عنوان فرستنده پیام نمایش می دهد و برنامه Chat را با نمایش نام پیام به آن نسبت می دهد. محتوای پیام فقط می تواند حاوی متن ( text
) باشد.
حداکثر اندازه پیام، با احتساب محتوای پیام، 32000 بایت است.
درخواست HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
پارامترها | |
---|---|
parent | مورد نیاز. نام منبع فضایی که در آن پیام ایجاد می شود. قالب: |
پارامترهای پرس و جو
پارامترها | |
---|---|
threadKey | اختیاری. منسوخ شده: به جای آن از |
requestId | اختیاری. یک شناسه درخواست منحصر به فرد برای این پیام. تعیین شناسه درخواست موجود، پیام ایجاد شده با آن شناسه را به جای ایجاد یک پیام جدید برمی گرداند. |
messageReplyOption | اختیاری. مشخص می کند که آیا یک پیام یک رشته را شروع می کند یا به یکی پاسخ می دهد. فقط در فضاهای نامگذاری شده پشتیبانی می شود. |
messageId | اختیاری. یک شناسه سفارشی برای یک پیام. به برنامههای گپ اجازه میدهد بدون نیاز به ذخیره شناسه اختصاص داده شده به سیستم در نام منبع پیام (که در قسمت مقدار این فیلد باید شرایط زیر را داشته باشد:
برای جزئیات، به نام پیام مراجعه کنید. |
درخواست بدن
بدنه درخواست شامل یک نمونه از 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 یا موجود در آن نادیده گرفته می شود. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD | پیام را به عنوان پاسخ به رشته مشخص شده توسط thread ID یا ایجاد می کند. اگر شکست بخورد، پیام به جای آن یک رشته جدید شروع می کند. |
REPLY_MESSAGE_OR_FAIL | پیام را به عنوان پاسخ به رشته مشخص شده توسط thread ID یا ایجاد می کند. اگر یک threadKey جدید استفاده شود، یک موضوع جدید ایجاد می شود. اگر ایجاد پیام ناموفق باشد، به جای آن یک خطای NOT_FOUND برگردانده می شود. |