Google Chat API

تتيح لك Google Chat API إنشاء تطبيقات في Chat لدمج خدماتك مع Google Chat وإدارة موارد Chat، مثل المساحات والأعضاء والرسائل.

الخدمة: chat.googleapis.com

لطلب هذه الخدمة، ننصح باستخدام مكتبات العميل التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لطلب هذه الخدمة، استخدِم المعلومات التالية عند طلب بيانات من واجهة برمجة التطبيقات.

مستند الاستكشاف

مستند الاستكشاف هو عبارة عن مواصفات يمكن معالجتها آليًا لوصف REST API واستهلاكها. وهو يُستخدم لبناء مكتبات العميل ومكوّنات IDE الإضافية وغيرها من الأدوات التي تتفاعل مع Google APIs. تجدر الإشارة إلى أنّ خدمة واحدة قد تقدّم أكثر من مستند استكشاف. تقدّم هذه الخدمة مستند الاستكشاف التالي:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي الجزء الأساسي من عنوان URL الذي يحدّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد يكون للخدمة الواحدة أكثر من نقطة نهاية واحدة. تحتوي هذه الخدمة على نقطة النهاية التالية، وجميع عناوين 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.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}
تعرض هذه السمة تفاصيل حول حالة قراءة المستخدم ضمن سلسلة محادثات، وتُستخدَم لتحديد الرسائل المقروءة وغير المقروءة.