LiveChatMessages: transition

Transiciona o status de uma mensagem de chat ao vivo do YouTube e inicia todos os processos associados ao novo status. Por exemplo, quando você transiciona o status de uma enquete ao vivo para closed, o YouTube encerra a enquete dessa mensagem. Antes de chamar esse método, confirme se o valor da propriedade status da mensagem da enquete ao vivo é active.

Impacto na cota:uma chamada para esse método tem um custo de cota de 20 unidades.

Solicitação

Solicitação HTTP

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

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).

Escopo
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
id string
O parâmetro id especifica o ID exclusivo da mensagem que está fazendo a transição para outro status.
status enum
O parâmetro status identifica o estado para o qual a mensagem está mudando. Para transicionar uma mensagem para o estado closed, o status precisa ser active para a enquete à qual a mensagem está vinculada.

Só é possível fazer a transição para closed, o que significa que a enquete está fechada.
Parâmetros opcionais
part string
O parâmetro part especifica as partes do recurso liveChatMessage que a resposta da API vai incluir. Os valores compatíveis são id, snippet e authorDetails.

Defina o valor do parâmetro como snippet para receber o resultado final da enquete no corpo da resposta.

Corpo da solicitação

Não forneça um corpo de solicitação ao chamar este método.

Resposta

Se for bem-sucedido, esse método vai retornar um recurso liveChatMessages no corpo da resposta.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.

Tipo de erro Detalhe do erro Descrição
forbidden (403) forbidden Você não tem as permissões necessárias para transicionar o status da mensagem especificada.
required (400) idRequired O parâmetro id obrigatório precisa identificar a mensagem cujo status você quer transicionar.
required (400) statusRequired A solicitação de API precisa especificar um valor para o parâmetro status.
notFound (404) liveChatMessagesNotFound A mensagem especificada pelo parâmetro id não existe.
forbidden (403) modificationNotAllowed Não é possível transicionar o status do recurso liveChatMessage especificado. O parâmetro id pode identificar uma mensagem cujo status não pode ser transicionado.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.