הוספת הודעה בצ'אט בשידור חי. ממשק ה-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
תשובה
אם הצלחת, השיטה הזו מחזירה משאב ChatLiveMessage בגוף התגובה.
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-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 ואת התשובה.