LiveChatMessages: insert
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Agrega un mensaje o una encuesta a un chat en vivo.
Casos de uso habituales
Solicitud
Solicitud HTTP
POST https://www.googleapis.com/youtube/v3/liveChat/messages
Autorización
Esta solicitud requiere autorización con al menos uno de los siguientes permisos. Para obtener más información sobre la autenticación y autorización, consulta Cómo implementar la autenticación de OAuth 2.0.
| Alcance |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
Parámetros
En la siguiente tabla, se enumeran los parámetros que admite esta consulta. Todos los parámetros mencionados son parámetros de consulta.
| Parámetros |
| Parámetros obligatorios |
part |
string
El parámetro part tiene dos propósitos. Identifica las propiedades que establecerá la operación de escritura, así como las propiedades que incluirá la respuesta de la API. Establece el valor del parámetro en snippet. |
Cuerpo de la solicitud
Proporciona un recurso liveChatMessage en el cuerpo de la solicitud.
Para ese recurso, debes especificar valores para estas propiedades:
snippet.liveChatIdsnippet.type: Elige una de las siguientes opciones: textMessageEvent o pollEvent.- Si el tipo es
textMessageEvent, incluye snippet.textMessageDetails.messageText.
- Si el tipo es
pollEvent, incluye snippet.pollDetails con los siguientes valores:
snippet.pollDetails.metadata.options.questionText- Es una lista de
snippet.pollDetails.metadata.options.optionText. Debes incluir al menos dos elementos y no más de cinco. Los elementos se muestran de forma secuencial en el orden en que se enumeran.
Errores
En la siguiente tabla, se identifican los mensajes de error que podría mostrar la API en respuesta a una llamada a este método. Para obtener más información, consulta API de YouTube Live Streaming: Errores.
| Tipo de error |
Detalle del error |
Descripción |
forbidden (403) |
forbidden |
No tienes los permisos necesarios para crear el mensaje especificado. |
forbidden (403) |
liveChatDisabled |
El propietario inhabilitó el chat en vivo especificado, lo que significa que no se pueden agregar mensajes al chat. |
forbidden (403) |
liveChatEnded |
El chat en vivo especificado ya no está disponible. |
invalidValue (400) |
messageTextInvalid |
El texto del mensaje (snippet.textMessageDetails.messageText) no es válido. |
notFound (404) |
liveChatNotFound |
El chat en vivo identificado en la solicitud a la API no existe. Este error se produce si el propietario borró el chat. |
required (400) |
liveChatIdRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.liveChatId. |
required (400) |
messageTextRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.textMessageDetails.messageText. |
required (400) |
typeRequired |
El recurso liveChatMessage debe incluir y especificar un valor para la propiedad snippet.type. Establece el valor del parámetro en text. |
required (400) |
preconditionCheckFailed |
Ya existe una encuesta activa fijada. |
rateLimitExceeded |
rateLimitExceeded |
El usuario publicó demasiados mensajes de chat en un período determinado. |
Pruébalo
Usa APIs Explorer para llamar a esta API y ver la solicitud y la respuesta de la API.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-01-02 (UTC)
[null,null,["Última actualización: 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."]]
