LiveChatMessages: transition

Изменяет статус сообщения в чате YouTube Live и запускает процессы, связанные с новым статусом. Например, если вы измените статус активного опроса на closed, он будет завершен. Перед вызовом этого метода убедитесь, что значение свойства status для сообщения с опросом – active.

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

Запрос

HTTP-запрос

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

Авторизация

Для выполнения этого запроса требуется авторизация как минимум в одной из следующих областей доступа. Подробнее…

Область действия
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Параметры

В таблице ниже перечислены параметры, которые поддерживает этот запрос. Все перечисленные параметры являются параметрами запроса.

Параметры
Обязательные параметры
id string
Параметр id указывает уникальный идентификатор сообщения, статус которого меняется.
status enum
Параметр status определяет состояние, в которое переходит сообщение. Чтобы перевести сообщение в состояние closed, для опроса, с которым связано сообщение, параметр status должен иметь значение active.

Вы можете перейти только к состоянию closed, то есть опрос закрыт.
Необязательные параметры
part string
Параметр part определяет, какие части ресурса liveChatMessage будут включены в ответ API. Допустимые значения: id, snippet и authorDetails.

Установите значение параметра snippet, чтобы получить окончательный результат опроса в теле ответа.

Тело запроса

При вызове этого метода не указывайте тело запроса.

Ответ

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

Ошибки

В таблице ниже перечислены сообщения об ошибках, которые API может возвращать в ответ на вызов этого метода. Подробную информацию можно найти в документации по сообщениям об ошибках.

Тип ошибки Сведения об ошибке Описание
forbidden (403) forbidden У вас нет разрешений, необходимых для изменения статуса указанного сообщения.
required (400) idRequired Обязательный параметр id должен идентифицировать сообщение, статус которого вы хотите изменить.
required (400) statusRequired В запросе к API необходимо указать значение параметра status.
notFound (404) liveChatMessagesNotFound Сообщение, указанное в параметре id, не существует.
forbidden (403) modificationNotAllowed Статус указанного ресурса liveChatMessage не может быть изменен. Параметр id может идентифицировать сообщение, статус которого нельзя изменить.

Попробовать

Используйте APIs Explorer, чтобы вызвать этот API и посмотреть запрос к API и ответ.