在实时聊天中添加消息。目前,该 API 仅支持插入短信。
常见使用场景
请求
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
:目前唯一支持的值是textMessageEvent
。snippet.textMessageDetails.messageText
响应
如果成功,此方法将在响应正文中返回 liveChatMessage 资源。
错误
下表列出了该 API 为响应对此方法的调用可能返回的错误消息。如需了解详情,请参阅错误消息文档。
错误类型 | 错误详情 | 说明 |
---|---|---|
forbidden (403) |
forbidden |
您没有创建指定消息所需的权限。 |
forbidden (403) |
liveChatDisabled |
指定的实时聊天已被所有者停用,这意味着消息无法添加到聊天中。 |
forbidden (403) |
liveChatEnded |
指定的实时聊天消息已失效。 |
invalidValue (400) |
messageTextInvalid |
消息文本 (snippet.textMessageDetails.messageText ) 无效。 |
notFound (404) |
liveChatNotFound |
API 请求中指定的实时聊天不存在。如果所有者删除了该聊天,就会出现此错误。 |
rateLimitExceeded |
rateLimitExceeded |
用户在指定时间范围内发布了太多聊天消息。 |
required (400) |
liveChatIdRequired |
liveChatMessage 资源必须包含 snippet.liveChatId 属性并指定值。 |
required (400) |
messageTextRequired |
liveChatMessage 资源必须包含 snippet.textMessageDetails.messageText 属性并指定值。 |
required (400) |
typeRequired |
liveChatMessage 资源必须包含 snippet.type 属性并指定值。将参数值设为 text |
试试看!
使用 APIs Explorer 调用此 API,并查看 API 请求和响应。