- בקשת HTTP
- פרמטרים של הנתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התגובה
- היקפי הרשאות
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- כדאי לנסות!
יצירת הודעה במרחב ב-Chat ב-Google Chat. לדוגמה, ראו שליחת הודעה.
תמיכה בסוגי האימות הבאים:
- אימות אפליקציה עם היקף ההרשאות:
https://www.googleapis.com/auth/chat.bot
- אימות משתמשים עם אחד מהיקפי ההרשאות הבאים:
https://www.googleapis.com/auth/chat.messages.createhttps://www.googleapis.com/auth/chat.messages-
https://www.googleapis.com/auth/chat.import(רק במרחבים משותפים במצב ייבוא)
השיוך של שולח ההודעה ב-Chat משתנה בהתאם לסוג האימות שבו אתם משתמשים בבקשה.
בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות של אפליקציה. האפליקציה ל-Chat מוצגת כשולחת ההודעה. התוכן של ההודעה יכול לכלול טקסט (text), כרטיסים (cardsV2) ווידג'טים של אביזרים (accessoryWidgets).
בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות משתמש. המשתמש מוצג ב-Chat כשולח ההודעה, והאפליקציה ל-Chat משויכת להודעה באמצעות הצגת השם שלה. תוכן ההודעה יכול להכיל רק טקסט (text).
הגודל המקסימלי של הודעה, כולל התוכן שלה, הוא 32,000 בייטים.
בבקשות webhook, התשובה לא מכילה את ההודעה המלאה. התשובה מאכלסת רק את השדות name ו-thread.name, בנוסף למידע שהיה בבקשה.
בקשת HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של הנתיב
| פרמטרים | |
|---|---|
parent |
חובה. שם המשאב של המרחב שבו רוצים ליצור הודעה. פורמט: |
פרמטרים של שאילתה
| פרמטרים | |
|---|---|
threadKey |
אופציונלי. הוצא משימוש: צריך להשתמש ב- |
requestId |
אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש ב-UUID אקראי. ציון מזהה בקשה הופך את הבקשה לאידמפוטנטית, וכך מובטח שמספר בקשות זהות עם אותו מזהה בקשה יגרמו ליצירת הודעה אחת בלבד. בקשות עוקבות עם אותו מזהה בקשה מחזירות את ההודעה הקיימת ולא מעדכנות את ההודעה, גם אם הפרטים המבוקשים שונים מהמצב הנוכחי. כדי להשתמש בשדה הזה בצורה יעילה:
|
messageReplyOption |
אופציונלי. מציין אם ההודעה מתחילה שרשור או עונה לשרשור. התכונה נתמכת רק במרחבים משותפים עם שם. כשמגיבים לאינטראקציות של משתמשים, המערכת מתעלמת מהשדה הזה. באינטראקציות בתוך שרשור, התשובה נוצרת באותו שרשור. אחרת, התשובה תיצור שרשור חדש. |
messageId |
אופציונלי. מזהה מותאם אישית של הודעה. מאפשר לאפליקציות ל-Chat לקבל, לעדכן או למחוק הודעה בלי לאחסן את המזהה שהמערכת הקצתה בשם המשאב של ההודעה (מיוצג בשדה הערך של השדה הזה צריך לעמוד בדרישות הבאות:
פרטים נוספים זמינים במאמר מתן שם להודעה. |
createMessageNotificationOptions |
אופציונלי. קובעת את אופן ההתראה כשההודעה מתפרסמת. מידע נוסף זמין במאמר איך מאלצים התראות או שולחים הודעות שקטות. |
גוף הבקשה
גוף הבקשה מכיל מופע של Message.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Message.
היקפי הרשאות
צריך אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/chat.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://www.googleapis.com/auth/chat.messages.create
מידע נוסף זמין במדריך ההרשאות.
MessageReplyOption
מציינת איך להשיב להודעה. יכול להיות שנוסיף עוד מדינות בעתיד.
| טיפוסים בני מנייה (enum) | |
|---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
ברירת מחדל. התחלת שרשור חדש. אם משתמשים באפשרות הזו, המערכת מתעלמת מכל thread ID או שנכללים. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
יוצר את ההודעה כתשובה לשרשור שצוין על ידי thread ID או . אם זה לא יצליח, ההודעה תתחיל שרשור חדש. |
REPLY_MESSAGE_OR_FAIL |
יוצר את ההודעה כתשובה לשרשור שצוין על ידי thread ID או . אם משתמשים ב-threadKey חדש, נוצר שרשור חדש. אם יצירת ההודעה נכשלת, מוחזרת במקום זאת שגיאת NOT_FOUND. |
CreateMessageNotificationOptions
אפשרויות להתנהגות ההתראות כשמפרסמים את ההודעה.
| ייצוג ב-JSON |
|---|
{
"notificationType": enum ( |
| שדות | |
|---|---|
notificationType |
סוג ההתראה של ההודעה. |
NotificationType
האפשרויות של סוגי ההתראות להודעה.
| טיפוסים בני מנייה (enum) | |
|---|---|
NOTIFICATION_TYPE_NONE |
פעולת ברירת מחדל. ההתראות פועלות באופן דומה למצב שבו המשתמש האנושי שולח את ההודעה באמצעות ממשק המשתמש של Chat: לא נשלחת התראה לשולח האנושי. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
התראה (התראות, התראות באימייל וכו') נשלחת למשתמש שיצר את ההודעה (לדוגמה, המשתמש שהאימות שלו שימש ליצירת ההודעה) וההודעה מסומנת כהודעה שלא נקראה. ההגדרה הזו לא תבטל את הגדרת ההתראות הקיימת של המשתמשים במרחב המשותף. לדוגמה, אם המשתמש בחר לא לקבל התראות ממרחב מסוים, הוא לא יקבל התראות גם אם האפשרות הזו מוגדרת. נדרש אימות משתמש. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
הודעה מתפרצת לנמענים. ההתראה הזו עוקפת את הגדרות ההתראות של המשתמשים במרחב ואת הגדרות "נא לא להפריע" ב-Chat. האפשרות הזו לא עוקפת את ההגדרות של "נא לא להפריע" ברמת המכשיר. נדרש אימות של האפליקציה. |
NOTIFICATION_TYPE_SILENT |
לא לשלוח התראה לנמענים ולא לסמן את ההודעה כהודעה שלא נקראה. ההתנהגות הזו דומה למצב שבו המשתמש משתיק את השיחה או מפעיל את המצב נא לא להפריע ב-Chat. נדרש אימות של האפליקציה. |