LiveChatMessages: insert

在实时聊天中添加消息或投票活动。

常见使用场景

请求

HTTP 请求

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

授权

此请求需要获得以下至少一个范围的授权(详细了解身份验证和授权)。

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

参数

下表列出了此查询支持的参数。列出的所有参数均为查询参数。

参数
必需参数
part string
part 形参有以下两种用途。它标识写入操作将设置的属性以及 API 响应将包含的属性。将参数值设为 snippet

请求正文

在请求正文中提供 liveChatMessage 资源。 对于该资源,您必须为以下属性指定值

  • snippet.liveChatId
  • snippet.type - 请选择以下选项之一:textMessageEventpollEvent
  • 如果类型为 textMessageEvent,请添加 snippet.textMessageDetails.messageText
  • 如果类型为 pollEvent,请添加具有以下值的 snippet.pollDetails: <ph type="x-smartling-placeholder">
      </ph>
    • snippet.pollDetails.metadata.options.questionText
    • snippet.pollDetails.metadata.options.optionText 的列表。你必须列出至少 2 项,但不得超过 5 项。内容会按列出的顺序依序显示。

响应

如果成功,此方法将在响应正文中返回 liveChatMessage 资源

错误

下表列出了 API 在响应此方法调用时可能会返回的错误消息。如需了解详情,请参阅错误消息文档。

错误类型 错误详情 说明
forbidden (403) forbidden 您没有创建指定消息所需的权限。
forbidden (403) liveChatDisabled 指定的实时聊天已被所有者停用,这意味着无法在该聊天中添加消息。
forbidden (403) liveChatEnded 指定的实时聊天已下线。
invalidValue (400) messageTextInvalid 短信内容 (snippet.textMessageDetails.messageText) 无效。
notFound (404) liveChatNotFound API 请求中标识的实时聊天不存在。如果聊天已被所有者删除,就会出现此错误。
required (400) liveChatIdRequired liveChatMessage 资源必须包含 snippet.liveChatId 属性的值,并为其指定一个值。
required (400) messageTextRequired liveChatMessage 资源必须包含 snippet.textMessageDetails.messageText 属性的值,并为其指定一个值。
required (400) typeRequired liveChatMessage 资源必须包含 snippet.type 属性的值,并为其指定一个值。将参数值设为 text
required (400) preconditionCheckFailed 已有固定的进行中的投票活动。
rateLimitExceeded rateLimitExceeded 用户在指定时间范围内发布的聊天消息过多。

试试看!

使用 APIs Explorer 调用此 API 并查看 API 请求和响应。