LiveChatMessages: insert

Adiciona uma mensagem ou uma enquete a uma conversa ao vivo.

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

Casos de uso comuns

Solicitação

Solicitação HTTP

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

Autorização

Essa solicitação exige autorização com pelo menos um dos escopos a seguir. Para saber mais sobre autenticação e autorização, consulte Implementar a autenticação OAuth 2.0.

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 tem duas finalidades. Ele 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, é necessário especificar valores para estas 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 o objeto snippet.pollDetails estruturado da seguinte maneira:
    • snippet.pollDetails.metadata.questionText (string): a pergunta principal da enquete.
    • snippet.pollDetails.metadata.options (matriz): uma lista de objetos de opção.
    • Requisitos: inclua um mínimo de 2 e um máximo de 4 itens.
    • Ordenação: os itens são exibidos sequencialmente na ordem exata em que estão listados.
    • Cada objeto na matriz precisa conter:
      • optionText (string): o texto exibido para essa escolha específica da enquete.

Resposta

Se bem-sucedido, esse método retorna um recurso liveChatMessage 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. Para mais detalhes, consulte API YouTube Live Streaming - Erros.

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 A conversa ao vivo especificada foi desativada pelo proprietário, o que significa que não é possível adicionar mensagens à conversa.
forbidden (403) liveChatEnded A conversa ao vivo especificada não está mais ativa.
invalidValue (400) messageTextInvalid O texto da mensagem (snippet.textMessageDetails.messageText) não é válido.
notFound (404) liveChatNotFound A conversa ao vivo identificada na solicitação de API não existe. Esse erro ocorre se a conversa foi excluída 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 conversa em um determinado período.

Confira!

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