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