Google Chat API به شما امکان می‌دهد برنامه‌های Chat بسازید تا سرویس‌هایتان را با Google Chat ادغام کنید و منابع Chat مثل فضاها، اعضا، و پیام‌ها را مدیریت کنید.
- منبع REST: v1.customEmojis
- منبع REST: v1.media
- منبع REST: v1.spaces
- منبع REST: v1.spaces.members
- منبع REST: v1.spaces.messagePins
- REST Resource: v1.spaces.messages
- منبع REST: v1.spaces.messages.attachments
- منبع REST: v1.spaces.messages.reactions
- منبع REST: v1.spaces.spaceEvents
- منبع REST: v1.users.availability
- REST Resource: v1.users.sections
- REST Resource: v1.users.sections.items
- منبع REST: v1.users.spaces
- REST Resource: v1.users.spaces.spaceNotificationSetting
- منبع REST: v1.users.spaces.threads
سرویس: chat.googleapis.com
برای فراخوانی این سرویس، توصیه می‌کنیم از کتابخانه‌های کارخواه ارائه‌شده توسط Google استفاده کنید. اگر برنامه شما برای فراخوانی این سرویس باید از کتابخانه‌های خودتان استفاده کند، هنگام درخواست‌های API از اطلاعات زیر استفاده کنید.
سند اکتشاف
سند اکتشاف مشخصاتی ماشین‌خوانا برای توصیف و مصرف میاناهای برنامه‌سازی کاربردی REST است. از آن برای ساختن کتابخانه‌های کارخواه، افزایه‌های IDE، و ابزارهای دیگری که با Google API تعامل دارند استفاده می‌شود. یک سرویس ممکن است چندین سند اکتشاف ارائه دهد. این سرویس سند اکتشاف زیر را ارائه می‌دهد:
نقطه پایان سرویس
نقطه پایان سرویس نشانی وب پایه‌ای است که نشانی شبکه سرویس میانای برنامه‌سازی کاربردی را مشخص می‌کند. یک سرویس ممکن است چندین نقطه پایانی سرویس داشته باشد. این سرویس دارای نقطه پایانی سرویس زیر است و همه شناسه منابع یکسان زیر مربوط به این نقطه پایانی سرویس هستند:
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.users است برمی‌گرداند. |
get |
GET /v1/{name=spaces/*} جزئیات مربوط به فضا را برمی‌گرداند. |
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 عضویتی برای برنامه Chat تماس‌گیرنده، کاربر، یا «گروه Google» ایجاد می‌کند. |
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.messagePins
| روش‌ها | |
|---|---|
create |
POST /v1/{parent=spaces/*}/messagePins سنجاق پیام ایجاد می‌کند. |
delete |
DELETE /v1/{name=spaces/*/messagePins/*} سنجاق پیام را حذف می‌کند. |
list |
GET /v1/{parent=spaces/*}/messagePins پیام‌های سنجاق‌شده در فضا را فهرست می‌کند. |
منبع REST: v1.spaces.messages
| روش‌ها | |
|---|---|
create |
POST /v1/{parent=spaces/*}/messages پیامی را در فضای Google Chat ایجاد می‌کند. |
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/*} پیامی را به‌روز می‌کند. |
replaceCards |
POST /v1/{name=spaces/*/messages/*}:replaceCards کارت‌های موجود در پیام را جایگزین می‌کند. |
search |
POST /v1/{parent=spaces/*}/messages:search پیام‌هایی را در Google Chat جستجو می‌کند که کاربر تماس‌گیرنده به آن‌ها دسترسی دارد. |
update |
PUT /v1/{message.name=spaces/*/messages/*} پیامی را به‌روز می‌کند. |
منبع REST: v1.spaces.messages.attachments
| روش‌ها | |
|---|---|
get |
GET /v1/{name=spaces/*/messages/*/attachments/*} فراداده پیوست پیام را دریافت می‌کند. |
منبع 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/*} رویدادی را از فضای Google Chat برمی‌گرداند. |
list |
GET /v1/{parent=spaces/*}/spaceEvents رویدادها را از فضای Google Chat فهرست می‌کند. |
منبع REST: v1.users.availability
| روش‌ها | |
|---|---|
get |
GET /v1/{name=users/*/availability} اطلاعات دردسترس بودن را برای کاربر انسانی در Google Chat برمی‌گرداند. |
markAsActive |
POST /v1/{name=users/*/availability}:markAsActive کاربر را به‌عنوان ACTIVE در Google Chat علامت‌گذاری می‌کند. |
markAsAway |
POST /v1/{name=users/*/availability}:markAsAway کاربر را به‌عنوان AWAY در Google Chat علامت‌گذاری می‌کند. |
markAsDoNotDisturb |
POST /v1/{name=users/*/availability}:markAsDoNotDisturb کاربر را به‌عنوان DO_NOT_DISTURB در Google Chat علامت‌گذاری می‌کند. |
patch |
PATCH /v1/{availability.name=users/*/availability} اطلاعات دردسترس بودن را برای کاربر انسانی به‌روز می‌کند. |
منبع REST: v1.users.sections
| روش‌ها | |
|---|---|
create |
POST /v1/{parent=users/*}/sections بخشی در Google Chat ایجاد می‌کند. |
delete |
DELETE /v1/{name=users/*/sections/*} بخشی از نوع CUSTOM_SECTION را حذف می‌کند. |
list |
GET /v1/{parent=users/*}/sections بخش‌های دردسترس برای کاربر Chat را فهرست می‌کند. |
patch |
PATCH /v1/{section.name=users/*/sections/*} بخشی را به‌روز می‌کند. |
position |
POST /v1/{name=users/*/sections/*}:position ترتیب مرتب‌سازی بخش را تغییر می‌دهد. |
منبع REST: v1.users.sections.items
| روش‌ها | |
|---|---|
list |
GET /v1/{parent=users/*/sections/*}/items موارد را در یک بخش فهرست می‌کند. |
move |
POST /v1/{name=users/*/sections/*/items/*}:move موردی را از بخشی به بخش دیگر منتقل می‌کند. |
منبع 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} جزئیات مربوط به وضعیت خوانده شدن کاربر را در رشته برمی‌گرداند، که برای شناسایی پیام‌های خوانده‌شده و خوانده‌نشده استفاده می‌شود. |