LiveChatMessages: insert

Добавляет сообщение или опрос в чат.

Распространенные случаи использования

Запрос

HTTP-запрос 

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

Авторизация

Для этого запроса требуется авторизация хотя бы с одной из следующих областей. Дополнительные сведения об аутентификации и авторизации см. в разделе «Реализация аутентификации OAuth 2.0» .

Объем
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 может вернуть в ответ на вызов этого метода. Дополнительные сведения см. в разделе API потоковой передачи YouTube Live — ошибки .

Тип ошибки Детализация ошибки Описание
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.