Изменяет статус сообщения в чате YouTube и инициирует все процессы, связанные с новым статусом. Например, когда вы меняете статус опроса в реальном времени на closed
, YouTube прекращает опрос этого сообщения. Прежде чем вызывать этот метод, вам следует подтвердить, что значение свойства status
для сообщения живого опроса active
.
Запрос
HTTP-запрос
POST https://www.googleapis.com/youtube/v3/liveChatMessages/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.