LiveChatMessages: insert

پیام یا نظرسنجی را به چت زنده اضافه می کند.

موارد استفاده رایج

درخواست

درخواست 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 یا pollEvent
  • اگر نوع textMessageEvent است، snippet.textMessageDetails.messageText را وارد کنید
  • اگر نوع pollEvent است، snippet.pollDetails را با مقادیر زیر وارد کنید:
    • snippet.pollDetails.metadata.options.questionText
    • فهرست snippet.pollDetails.metadata.options.optionText . شما باید حداقل دو مورد و حداکثر پنج مورد را لیست کنید. موارد به ترتیبی که فهرست شده اند به ترتیب نمایش داده می شوند.

واکنش

در صورت موفقیت آمیز بودن، این روش یک منبع liveChatMessage را در بدنه پاسخ باز می گرداند.

خطاها

جدول زیر پیام های خطایی را مشخص می کند که API می تواند در پاسخ به تماس با این روش بازگرداند. برای جزئیات بیشتر به مستندات پیام خطا مراجعه کنید.

نوع خطا جزئیات خطا شرح
forbidden (403) forbidden شما مجوزهای لازم برای ایجاد پیام مشخص شده را ندارید.
forbidden (403) liveChatDisabled چت زنده مشخص شده توسط مالک غیرفعال شده است، به این معنی که پیام ها را نمی توان به گپ اضافه کرد.
forbidden (403) liveChatEnded چت زنده مشخص شده دیگر زنده نیست.
invalidValue (400) messageTextInvalid متن پیام ( snippet.textMessageDetails.messageText ) معتبر نیست.
notFound (404) liveChatNotFound چت زنده مشخص شده در درخواست API وجود ندارد. این خطا در صورتی رخ می دهد که چت توسط مالک حذف شده باشد.
required (400) liveChatIdRequired منبع liveChatMessage باید یک مقدار برای ویژگی snippet.liveChatId داشته باشد و مشخص کند.
required (400) messageTextRequired منبع liveChatMessage باید یک مقدار برای ویژگی snippet.textMessageDetails.messageText داشته باشد و مشخص کند.
required (400) typeRequired منبع liveChatMessage باید یک مقدار برای ویژگی snippet.type داشته باشد و مشخص کند. مقدار پارامتر را روی text تنظیم کنید
required (400) preconditionCheckFailed یک نظرسنجی فعال پین شده از قبل وجود دارد.
rateLimitExceeded rateLimitExceeded کاربر در یک بازه زمانی معین پیام های چت زیادی ارسال کرده است.

آن را امتحان کنید!

از APIs Explorer برای فراخوانی این API و مشاهده درخواست و پاسخ API استفاده کنید.