Google Chat API

API چت گوگل به شما امکان می‌دهد برنامه‌های چت بسازید تا سرویس‌های خود را با چت گوگل ادغام کنید و منابع چت مانند فضاها، اعضا و پیام‌ها را مدیریت کنید.

سرویس: chat.googleapis.com

برای فراخوانی این سرویس، توصیه می‌کنیم از کتابخانه‌های کلاینت ارائه شده توسط گوگل استفاده کنید. اگر برنامه شما برای فراخوانی این سرویس نیاز به استفاده از کتابخانه‌های خودتان دارد، هنگام ارسال درخواست‌های API از اطلاعات زیر استفاده کنید.

سند کشف

یک سند کشف، مشخصاتی قابل خواندن توسط ماشین برای توصیف و استفاده از APIهای REST است. از آن برای ساخت کتابخانه‌های کلاینت، افزونه‌های IDE و سایر ابزارهایی که با APIهای گوگل تعامل دارند، استفاده می‌شود. یک سرویس ممکن است چندین سند کشف ارائه دهد. این سرویس سند کشف زیر را ارائه می‌دهد:

نقطه پایانی سرویس

یک نقطه پایانی سرویس ، یک URL پایه است که آدرس شبکه یک سرویس API را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و تمام URI های زیر نسبت به این نقطه پایانی سرویس هستند:

  • https://chat.googleapis.com

منبع REST: v1.customEmojis

روش‌ها
create POST /v1/customEmojis
یک ایموجی سفارشی ایجاد می‌کند.
delete DELETE /v1/{name=customEmojis/*}
یک ایموجی سفارشی را حذف می‌کند.
get GET /v1/{name=customEmojis/*}
جزئیات مربوط به یک ایموجی سفارشی را برمی‌گرداند.
list GET /v1/customEmojis
ایموجی‌های سفارشی قابل مشاهده برای کاربر احراز هویت شده را فهرست می‌کند.

منبع REST: v1.media

روش‌ها
download GET /v1/media/{resourceName=**}
رسانه‌ها را دانلود می‌کند.
upload POST /upload/v1/{parent=spaces/*}/attachments:upload
یک پیوست آپلود می‌کند.

منبع REST: v1.spaces

روش‌ها
completeImport POST /v1/{name=spaces/*}:completeImport
فرآیند وارد کردن اطلاعات برای فضای مشخص شده را تکمیل کرده و آن را برای کاربران قابل مشاهده می‌کند.
create POST /v1/spaces
فضایی ایجاد می‌کند.
delete DELETE /v1/{name=spaces/*}
یک فضای نامگذاری شده را حذف می‌کند.
findDirectMessage GET /v1/spaces:findDirectMessage
پیام مستقیم موجود با کاربر مشخص شده را برمی‌گرداند.
findGroupChats GET /v1/spaces:findGroupChats
تمام فاصله‌های دارای spaceType == GROUP_CHAT را برمی‌گرداند، که عضویت‌های انسانی آنها دقیقاً شامل کاربر فراخواننده و کاربران مشخص شده در FindGroupChatsRequest.memberships است.
get GET /v1/{name=spaces/*}
جزئیات مربوط به یک فاصله (space) را برمی‌گرداند.
list GET /v1/spaces
فضاهایی را که فراخواننده عضو آنهاست، فهرست می‌کند.
patch PATCH /v1/{space.name=spaces/*}
یک فضا را به‌روزرسانی می‌کند.
search GET /v1/spaces:search
بر اساس جستجوی مدیر، فهرستی از فضاهای موجود در یک سازمان Google Workspace را برمی‌گرداند.
setup POST /v1/spaces:setup
یک فضا ایجاد می‌کند و کاربران مشخص شده را به آن اضافه می‌کند.

منبع REST: v1.spaces.members

روش‌ها
create POST /v1/{parent=spaces/*}/members
برای برنامه چت تماس گیرنده، یک کاربر یا یک گروه گوگل، عضویت ایجاد می‌کند.
delete DELETE /v1/{name=spaces/*/members/*}
عضویت را حذف می‌کند.
get GET /v1/{name=spaces/*/members/*}
جزئیات مربوط به عضویت را برمی‌گرداند.
list GET /v1/{parent=spaces/*}/members
عضویت‌ها را در یک فضا فهرست می‌کند.
patch PATCH /v1/{membership.name=spaces/*/members/*}
عضویت را به‌روزرسانی می‌کند.

منبع REST: v1.spaces.messages

روش‌ها
create POST /v1/{parent=spaces/*}/messages
پیامی را در فضای چت گوگل ایجاد می‌کند.
delete DELETE /v1/{name=spaces/*/messages/*}
یک پیام را حذف می‌کند.
get GET /v1/{name=spaces/*/messages/*}
جزئیات مربوط به یک پیام را برمی‌گرداند.
list GET /v1/{parent=spaces/*}/messages
پیام‌های موجود در فضایی که تماس‌گیرنده عضو آن است، از جمله پیام‌های اعضا و فضاهای مسدود شده را فهرست می‌کند.
patch PATCH /v1/{message.name=spaces/*/messages/*}
یک پیام را به‌روزرسانی می‌کند.
update PUT /v1/{message.name=spaces/*/messages/*}
یک پیام را به‌روزرسانی می‌کند.

منبع REST: v1.spaces.messages.attachments

روش‌ها
get GET /v1/{name=spaces/*/messages/*/attachments/*}
ابرداده (metadata) یک پیوست پیام را دریافت می‌کند.

منبع REST: v1.spaces.messages.reactions

روش‌ها
create POST /v1/{parent=spaces/*/messages/*}/reactions
یک واکنش ایجاد می‌کند و آن را به یک پیام اضافه می‌کند.
delete DELETE /v1/{name=spaces/*/messages/*/reactions/*}
واکنش به یک پیام را حذف می‌کند.
list GET /v1/{parent=spaces/*/messages/*}/reactions
واکنش‌ها به یک پیام را فهرست می‌کند.

منبع REST: v1.spaces.spaceEvents

روش‌ها
get GET /v1/{name=spaces/*/spaceEvents/*}
رویدادی را از فضای چت گوگل برمی‌گرداند.
list GET /v1/{parent=spaces/*}/spaceEvents
رویدادها را از یک فضای چت گوگل فهرست می‌کند.

منبع REST: v1.users.spaces

روش‌ها
getSpaceReadState GET /v1/{name=users/*/spaces/*/spaceReadState}
جزئیات مربوط به وضعیت خواندن کاربر را در یک فاصله برمی‌گرداند، که برای شناسایی پیام‌های خوانده شده و خوانده نشده استفاده می‌شود.
updateSpaceReadState PATCH /v1/{spaceReadState.name=users/*/spaces/*/spaceReadState}
وضعیت خوانده شدن کاربر را در یک فاصله به‌روزرسانی می‌کند، که برای شناسایی پیام‌های خوانده شده و خوانده نشده استفاده می‌شود.

منبع REST: v1.users.spaces.spaceNotificationSetting

روش‌ها
get GET /v1/{name=users/*/spaces/*/spaceNotificationSetting}
تنظیمات اعلان فاصله را دریافت می‌کند.
patch PATCH /v1/{spaceNotificationSetting.name=users/*/spaces/*/spaceNotificationSetting}
تنظیمات اعلان فضا را به‌روزرسانی می‌کند.

منبع REST: v1.users.spaces.threads

روش‌ها
getThreadReadState GET /v1/{name=users/*/spaces/*/threads/*/threadReadState}
جزئیاتی درباره وضعیت خواندن کاربر در یک رشته را برمی‌گرداند، که برای شناسایی پیام‌های خوانده شده و خوانده نشده استفاده می‌شود.