LiveChatMessages: insert

הוספת הודעה לצ'אט בשידור חי. ממשק ה-API תומך כרגע באפשרות להוסיף הודעות טקסט בלבד.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/liveChat/messages

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part משמש לשתי מטרות. היא מזהה את המאפיינים שפעולת הכתיבה תגדיר, וכן את המאפיינים שייכללו בתגובת ה-API. מגדירים את ערך הפרמטר כ-snippet.

גוף הבקשה

צריך לספק משאב LiveChatMessage בגוף הבקשה. במשאב הזה:

  • צריך לציין ערך למאפיינים הבאים:

    • snippet.liveChatId
    • snippet.type: בשלב זה, הערך הנתמך היחיד הוא textMessageEvent.
    • snippet.textMessageDetails.messageText

תשובה

אם הפעולה בוצעה בהצלחה, השיטה מחזירה משאב של LiveChatMessage בגוף התשובה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) forbidden אין לך את ההרשאות הנדרשות ליצירת ההודעה שצוינה.
forbidden (403) liveChatDisabled הצ'אט בשידור חי שצוין הושבת על ידי הבעלים, ולכן לא ניתן להוסיף הודעות לצ'אט.
forbidden (403) liveChatEnded הצ'אט בשידור חי שצוין כבר לא פעיל.
invalidValue (400) messageTextInvalid טקסט ההודעה (snippet.textMessageDetails.messageText) אינו חוקי.
notFound (404) liveChatNotFound הצ'אט בשידור חי שצוין בבקשת ה-API לא קיים. הודעת השגיאה הזו מופיעה אם הבעלים מחק את הצ'אט.
rateLimitExceeded rateLimitExceeded המשתמש פרסם יותר מדי הודעות צ'אט בפרק זמן נתון.
required (400) liveChatIdRequired המשאב liveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.liveChatId.
required (400) messageTextRequired המשאב liveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.textMessageDetails.messageText.
required (400) typeRequired המשאב liveChatMessage חייב לכלול ולציין ערך עבור המאפיין snippet.type. יש להגדיר את ערך הפרמטר ל-text

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.