LiveChatMessages: insert
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Adiciona uma mensagem ou uma 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. Para saber mais sobre autenticação e autorização, consulte Como 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 dois propósitos. 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 essas propriedades:
snippet.liveChatIdsnippet.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ê precisa listar pelo menos dois itens e no máximo cinco. Os itens são mostrados sequencialmente na ordem em que estão listados.
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 |
O chat ao vivo especificado foi desativado pelo proprietário, o que significa que não é possível adicionar mensagens. |
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 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 chat em um determinado período. |
Confira!
Use APIs Explorer para chamar essa API e conferir a solicitação e a resposta dela.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-01-02 UTC.
[null,null,["Última atualização 2025-01-02 UTC."],[],[],null,["# LiveChatMessages: insert\n\nAdds a message or a poll to a live chat.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/youtube/v3/liveChat/messages\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes. To read more about authentication and authorization, see [Implementing OAuth 2.0 authentication](/youtube/v3/live/authentication).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to `snippet`. |\n\n### Request body\n\nProvide a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the request body.\nFor that resource, you must specify values for these properties\n\n- `snippet.liveChatId`\n- `snippet.type` - choose one of the following options: `textMessageEvent` or `pollEvent`\n- If type is `textMessageEvent`, include `snippet.textMessageDetails.messageText`\n- If type is `pollEvent`, include `snippet.pollDetails` with the following values:\n - `snippet.pollDetails.metadata.options.questionText`\n - List of `snippet.pollDetails.metadata.options.optionText`. You must list at least two items and no more than four items. Items are displayed sequentially in the order they're listed.\n\nResponse\n--------\n\nIf successful, this method returns a [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) in the response body.\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. For more details, see [YouTube Live Streaming API - Errors](/youtube/v3/live/docs/errors).\n\n| Error type | Error detail | Description |\n|----------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forbidden (403)` | `forbidden` | You don't have the permissions required to create the specified message. |\n| `forbidden (403)` | `liveChatDisabled` | The specified live chat has been disabled by the owner, which means messages cannot be added to the chat. |\n| `forbidden (403)` | `liveChatEnded` | The specified live chat is no longer live. |\n| `invalidValue (400)` | `messageTextInvalid` | The message text (`snippet.textMessageDetails.messageText`) is not valid. |\n| `notFound (404)` | `liveChatNotFound` | The live chat identified in the API request does not exist. This error occurs if the chat has been deleted by the owner. |\n| `required (400)` | `liveChatIdRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.liveChatId` property. |\n| `required (400)` | `messageTextRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.textMessageDetails.messageText` property. |\n| `required (400)` | `typeRequired` | The [liveChatMessage resource](/youtube/v3/live/docs/liveChatMessages#resource) must include and specify a value for the `snippet.type` property. Set the parameter value to `text` |\n| `required (400)` | `preconditionCheckFailed` | A pinned active poll already exists. |\n| `rateLimitExceeded` | `rateLimitExceeded` | The user has posted too many chat messages in a given timeframe. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
