LiveChatMessages: insert

Adiciona uma mensagem ou enquete a um chat ao vivo.

Casos de uso comuns

Solicitação

Solicitação HTTP

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

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
part string
O parâmetro part serve a duas finalidades. identifica as propriedades que serão definidas pela operação de gravação e as propriedades que serão incluídas pela resposta da API. Defina o valor do parâmetro como snippet.

Corpo da solicitação

Forneça um recurso liveChatMessage no corpo da solicitação. Para esse recurso, você deve especificar valores para essas propriedades

  • snippet.liveChatId
  • snippet.type – escolha uma das seguintes opções: textMessageEvent ou pollEvent
  • Se o tipo for textMessageEvent, inclua snippet.textMessageDetails.messageText.
  • Se o tipo for pollEvent, inclua snippet.pollDetails com os seguintes valores:
    • snippet.pollDetails.metadata.options.questionText
    • Lista de snippet.pollDetails.metadata.options.optionText. Você deve listar no mínimo dois e no máximo cinco itens. Os itens são exibidos sequencialmente na ordem em que estão listados.

Resposta

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

Erros

A tabela a seguir identifica 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 criar a mensagem especificada.
forbidden (403) liveChatDisabled O chat ao vivo especificado foi desativado pelo proprietário. Por isso, não é possível adicionar mensagens a ele.
forbidden (403) liveChatEnded O chat ao vivo especificado não está mais ativo.
invalidValue (400) messageTextInvalid O texto da mensagem (snippet.textMessageDetails.messageText) não é válido.
notFound (404) liveChatNotFound O chat ao vivo identificado na solicitação da API não existe. Esse erro ocorrerá se o bate-papo tiver sido excluído pelo proprietário.
required (400) liveChatIdRequired O recurso liveChatMessage precisa incluir e especificar um valor para a propriedade snippet.liveChatId.
required (400) messageTextRequired O recurso liveChatMessage precisa incluir e especificar um valor para a propriedade snippet.textMessageDetails.messageText.
required (400) typeRequired O recurso liveChatMessage precisa incluir e especificar um valor para a propriedade snippet.type. Defina o valor do parâmetro como text.
required (400) preconditionCheckFailed Já existe uma enquete ativa fixada.
rateLimitExceeded rateLimitExceeded O usuário postou muitas mensagens de chat em um determinado período.

Confira!

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