LiveChatMessages: insert

Stay organized with collections Save and categorize content based on your preferences.

Adds a message to a live chat. The API currently supports the ability to insert text messages only.

Common use cases

Request

HTTP request

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

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
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.

Request body

Provide a liveChatMessage resource in the request body. For that resource:

  • You must specify a value for these properties:

    • snippet.liveChatId
    • snippet.type: Currently, the only supported value is textMessageEvent.
    • snippet.textMessageDetails.messageText

Response

If successful, this method returns a liveChatMessage resource in the response body.

Errors

The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.

Error type Error detail Description
forbidden (403) forbidden You do not have the permissions required to create the specified message.
forbidden (403) liveChatDisabled The specified live chat has been disabled by the owner, which means messages cannot be added to the chat.
forbidden (403) liveChatEnded The specified live chat is no longer live.
invalidValue (400) messageTextInvalid The message text (snippet.textMessageDetails.messageText) is not valid.
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.
rateLimitExceeded rateLimitExceeded The user has posted too many chat messages in a given timeframe.
required (400) liveChatIdRequired The liveChatMessage resource must include and specify a value for the snippet.liveChatId property.
required (400) messageTextRequired The liveChatMessage resource must include and specify a value for the snippet.textMessageDetails.messageText property.
required (400) typeRequired The liveChatMessage resource must include and specify a value for the snippet.type property. Set the parameter value to text

Try it!

Use the APIs Explorer to call this API and see the API request and response.