- בקשת HTTP
- פרמטרים של נתיב
- פרמטרים של שאילתה
- גוף הבקשה
- גוף התשובה
- היקפי ההרשאות
- MessageReplyOption
- רוצים לנסות?
יצירת הודעה במרחב ב-Google Chat. לדוגמה, ראו שליחת הודעה.
השיטה create()
מחייבת אימות משתמש או אימות אפליקציות. בהתאם לסוג האימות שבו אתם משתמשים בבקשה שלכם, השיוך של שולח ההודעה ב-Chat משתנה בהתאם לסוג האימות.
בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות של אפליקציות. ב-Chat מוצגת אפליקציית Chat כשולח ההודעה. התוכן של ההודעה יכול להכיל טקסט (text
), כרטיסים (cardsV2
) וווידג'טים של אביזרים (accessoryWidgets
).
בתמונה הבאה אפשר לראות איך Chat משייך הודעה כשמשתמשים באימות משתמש. אפליקציית Chat מציגה את המשתמש כשולח של ההודעה, ומשייכת את השם שלה להודעה. תוכן ההודעה יכול להכיל רק טקסט (text
).
הגודל המקסימלי של הודעה, כולל תוכן ההודעה, הוא 32,000 בייטים.
בקשת HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שבו אפשר ליצור הודעה. פורמט: |
פרמטרים של שאילתה
פרמטרים | |
---|---|
threadKey |
זה שינוי אופציונלי. האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב- |
request |
זה שינוי אופציונלי. מזהה בקשה ייחודי של ההודעה הזו. כשמציינים מזהה בקשה קיים, מוצגת ההודעה שנוצרה עם המזהה הזה במקום ליצור הודעה חדשה. |
message |
זה שינוי אופציונלי. קובעת אם ההודעה תתחיל שרשור או תענה בשרשור. התכונה נתמכת רק במרחבים משותפים עם שם. |
message |
זה שינוי אופציונלי. מזהה מותאם אישית להודעה. מאפשר לאפליקציות Chat לקבל, לעדכן או למחוק הודעה בלי לאחסן את המזהה שהמערכת הקצה בשם המשאב של ההודעה (שמיוצג בשדה הערך בשדה הזה חייב לעמוד בדרישות הבאות:
מידע נוסף זמין במאמר מתן שם להודעה. |
גוף הבקשה
גוף הבקשה מכיל מופע של 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
מציין איך עונים להודעה. יכול להיות שבעתיד יתווספו מדינות נוספות.
טיפוסים בני מנייה (enum) | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
ברירת מחדל. התחלת שרשור חדש. אם משתמשים באפשרות הזו, המערכת מתעלמת מכל thread ID או שכלולים. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או . אם הניסיון נכשל, ההודעה תתחיל שרשור חדש במקום זאת. |
REPLY_MESSAGE_OR_FAIL |
יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או . אם משתמשים ב-threadKey חדש, נוצר שרשור חדש. אם יצירת ההודעה נכשלת, תוחזר במקום זאת שגיאה מסוג NOT_FOUND . |