LiveChatMessages: insert

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

Влияние на квоту. Вызов этого метода сокращает квоту на 20 единиц.

Примеры использования

Запрос

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.questionText (строка): основной вопрос опроса.
    • snippet.pollDetails.metadata.options (массив) – список объектов вариантов.
    • Требования: от 2 до 4 элементов.
    • Порядок. Элементы показываются в том порядке, в котором они перечислены.
    • Каждый объект в массиве должен содержать:
      • optionText (строка) – текст, который показывается для определенного варианта ответа.

Ответ

В случае успеха этот метод возвращает ресурс liveChatMessage в теле ответа.

Ошибки

В таблице ниже перечислены сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Подробнее об ошибках YouTube Live Streaming 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 и ответ.