Youtube · Schema

LiveChatMessageListResponse

A list of live chat message resources for a given broadcast.

GoogleMediaSocialStreamingVideoVideos

Properties

Name Type Description
kind string Identifies the API resource's type. Value is youtube#liveChatMessageListResponse.
etag string The Etag of this resource.
nextPageToken string The token for the next page of results.
pollingIntervalMillis integer The amount of time the client should wait before polling again, in milliseconds.
offlineAt string The date and time when the underlying stream went offline.
pageInfo object Paging details for a list of live streaming resources.
items array A list of chat messages that match the request criteria.
View JSON Schema on GitHub

JSON Schema

youtube-live-live-chat-message-list-response-schema.json Raw ↑
{
  "type": "object",
  "description": "A list of live chat message resources for a given broadcast.",
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#liveChatMessageListResponse.",
      "example": "youtube#video"
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource.",
      "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
    },
    "nextPageToken": {
      "type": "string",
      "description": "The token for the next page of results.",
      "example": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "pollingIntervalMillis": {
      "type": "integer",
      "description": "The amount of time the client should wait before polling again, in milliseconds.",
      "example": 10
    },
    "offlineAt": {
      "type": "string",
      "description": "The date and time when the underlying stream went offline.",
      "example": "2026-01-15T10:30:00Z",
      "format": "date-time"
    },
    "pageInfo": {
      "type": "object",
      "description": "Paging details for a list of live streaming resources.",
      "properties": {
        "totalResults": {
          "type": "integer",
          "description": "The total number of results in the result set.",
          "example": 42
        },
        "resultsPerPage": {
          "type": "integer",
          "description": "The number of results included in the API response.",
          "example": 10
        }
      }
    },
    "items": {
      "type": "array",
      "description": "A list of chat messages that match the request criteria.",
      "example": [],
      "items": {
        "type": "object",
        "description": "A liveChatMessage resource represents a chat message in a YouTube live broadcast.",
        "properties": {
          "kind": {
            "type": "string",
            "description": "Identifies the API resource's type. Value is youtube#liveChatMessage.",
            "example": "youtube#video"
          },
          "etag": {
            "type": "string",
            "description": "The Etag of this resource.",
            "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
          },
          "id": {
            "type": "string",
            "description": "The ID that YouTube assigns to uniquely identify the message.",
            "example": "abc123def456"
          },
          "snippet": {
            "type": "object",
            "description": "The snippet object contains basic details about the message.",
            "example": "example_value",
            "properties": {
              "liveChatId": {
                "type": "string",
                "description": "The ID of the live chat to which this message belongs."
              },
              "type": {
                "type": "string",
                "description": "The type of message.",
                "enum": [
                  "chatEndedEvent",
                  "fanFundingEvent",
                  "giftMembershipReceivedEvent",
                  "memberMilestoneChatEvent",
                  "membershipGiftingEvent",
                  "messageDeletedEvent",
                  "newSponsorEvent",
                  "pollClosedEvent",
                  "pollEditedEvent",
                  "pollOpenedEvent",
                  "pollVotedEvent",
                  "sponsorOnlyModeEndedEvent",
                  "sponsorOnlyModeStartedEvent",
                  "superChatEvent",
                  "superStickerEvent",
                  "textMessageEvent",
                  "tombstone",
                  "userBannedEvent"
                ]
              },
              "displayMessage": {
                "type": "string",
                "description": "Contains a string that can be displayed to the user. The string is not necessarily the message text itself."
              },
              "authorChannelId": {
                "type": "string",
                "description": "The ID of the user that authored this message."
              },
              "publishedAt": {
                "type": "string",
                "description": "The date and time when the message was orignally published.",
                "format": "date-time"
              },
              "hasDisplayContent": {
                "type": "boolean",
                "description": "Whether the message has display content that should be displayed to users."
              },
              "textMessageDetails": {
                "type": "object",
                "description": "Details about the text message. This object is only present if the type is textMessageEvent.",
                "properties": {
                  "messageText": {
                    "type": "string",
                    "description": "The user's message."
                  }
                }
              }
            }
          },
          "authorDetails": {
            "type": "object",
            "description": "The authorDetails object contains basic details about the user that posted this message.",
            "example": "example_value",
            "properties": {
              "channelId": {
                "type": "string",
                "description": "The YouTube channel ID of the message author."
              },
              "channelUrl": {
                "type": "string",
                "description": "The channel URL of the message author."
              },
              "displayName": {
                "type": "string",
                "description": "The channel's display name."
              },
              "profileImageUrl": {
                "type": "string",
                "description": "The channel's avatar URL."
              },
              "isVerified": {
                "type": "boolean",
                "description": "Indicates whether YouTube has verified the authenticity of the channel owner's identity."
              },
              "isChatOwner": {
                "type": "boolean",
                "description": "Indicates whether the user is the owner of the live chat."
              },
              "isChatSponsor": {
                "type": "boolean",
                "description": "Indicates whether the user is a sponsor of the live chat."
              },
              "isChatModerator": {
                "type": "boolean",
                "description": "Indicates whether the user is a moderator of the live chat."
              }
            }
          }
        },
        "required": [
          "kind",
          "etag"
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "LiveChatMessageListResponse",
  "x-schema-source": "openapi",
  "x-source-url": "openapi/youtube-live-streaming-openapi.yml"
}