Method: spaces.messages.create

יצירת הודעה במרחב משותף ב-Google Chat. לדוגמה, ראו שליחת הודעה.

כדי להפעיל את השיטה הזו צריך אימות והיא תומכת בסוגי האימות הבאים:

  • להודעות טקסט, יש תמיכה באימות משתמשים או באימות אפליקציות.
  • עבור הודעות בכרטיס, יש תמיכה רק באימות אפליקציות. (רק אפליקציות של Chat יכולות ליצור הודעות בכרטיס).

בקשת HTTP

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של המרחב המשותף שבו רוצים ליצור הודעה.

פורמט: spaces/{space}

פרמטרים של שאילתה

פרמטרים
threadKey
(deprecated)

string

זה שינוי אופציונלי. הוצא משימוש: יש להשתמש במקום זאת ב-thread.thread_key. מזהה לשרשור. אפשר להזין עד 4,000 תווים. כדי להתחיל שרשור או להוסיף לשרשור, יש ליצור הודעה ולציין threadKey או thread.name. לדוגמה, תוכלו להיעזר במאמר התחלה של שרשור הודעות או מענה לו.

requestId

string

זה שינוי אופציונלי. מזהה בקשה ייחודי להודעה הזו. ציון מזהה בקשה קיים מחזיר את ההודעה שנוצרה עם המזהה הזה במקום ליצור הודעה חדשה.

messageReplyOption

enum (MessageReplyOption)

זה שינוי אופציונלי. ההגדרה קובעת אם ההודעה תתחיל שרשור או תענה לשרשור. האפשרות נתמכת רק במרחבים משותפים עם שם.

messageId

string

זה שינוי אופציונלי. מזהה מותאם אישית להודעה. ההגדרה מאפשרת לאפליקציות ל-Chat לקבל, לעדכן או למחוק הודעות בלי שיהיה צורך לשמור את המזהה שהוקצה על ידי המערכת בשם המשאב של ההודעה (המזהה הזה מופיע בשדה name של ההודעה).

הערך בשדה הזה צריך לעמוד בדרישות הבאות:

  • מתחיל ב-client-. לדוגמה, client-custom-name הוא מזהה מותאם אישית חוקי, אבל custom-name אינו מזהה מותאם אישית.
  • מכילה עד 63 תווים ומכילה רק אותיות קטנות, מספרים ומקפים.
  • היא ייחודית במרחב משותף. אפליקציית 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 או threadKey הכלולים.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או על ידי threadKey. אם הפעולה נכשלת, ההודעה תתחיל שרשור חדש במקום זאת.
REPLY_MESSAGE_OR_FAIL יצירת ההודעה כתשובה לשרשור שצוין על ידי thread ID או על ידי threadKey. אם משתמשים ב-threadKey חדש, נוצר שרשור חדש. אם יצירת ההודעה תיכשל, תוחזר השגיאה NOT_FOUND במקום זאת.