Method: spaces.messages.create

在 Google Chat 聊天室中创建消息。如需查看示例，请参阅发送消息。

create() 方法需要用户或应用身份验证。根据您在请求中使用的身份验证类型，Chat 会以不同的方式归因消息发送者。

下图显示了您使用应用身份验证时 Chat 如何对消息进行归因。Chat 会将 Chat 应用显示为消息发送者。消息内容可以包含文本 (text)、卡片 (cardsV2) 和配件 widget (accessoryWidgets)。

通过应用身份验证发送消息

下图显示了使用用户身份验证时 Chat 如何对消息进行归因。Chat 会将用户显示为消息发送者，并通过显示消息名称将 Chat 应用归因于消息。消息内容只能包含文本 (text)。

通过用户身份验证发送消息

包括邮件内容在内的邮件大小上限为 32,000 字节。

HTTP 请求

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。要在其中创建消息的聊天室的资源名称。

格式：spaces/{space}

查询参数

参数
threadKey
(deprecated)

string

可选。已弃用：请改用 thread.thread_key。线程的 ID。最多支持 4000 个字符。如需发起或添加到线程，请创建一条消息并指定 threadKey 或 thread.name。有关用法示例，请参阅发起或回复邮件会话。
requestId

string

可选。此消息的唯一请求 ID。指定现有请求 ID 会返回使用该 ID 创建的消息，而不是创建新消息。
messageReplyOption

enum (MessageReplyOption)

可选。指定相应消息是发起会话还是回复会话。仅适用于已命名的聊天室。
messageId

string

可选。消息的自定义 ID。让 Chat 应用可获取、更新或删除消息，而无需在消息的资源名称（在消息 name 字段中表示）存储系统分配的 ID。

此字段的值必须满足以下要求：

  • 以 client- 开头。例如，client-custom-name 是有效的自定义 ID，但 custom-name 不是。
  • 最多包含 63 个字符，且只能包含小写字母、数字和连字符。
  • 在聊天室中是唯一的。Chat 应用无法为不同的消息使用相同的自定义 ID。

有关详情，请参阅为消息命名。

请求正文

请求正文包含一个 Message 实例。

响应正文

如果成功，响应正文将包含一个新创建的 Message 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

有关详情，请参阅授权指南。

MessageReplyOption

指定如何回复邮件。未来我们可能会添加更多州/省级行政区。

枚举
MESSAGE_REPLY_OPTION_UNSPECIFIED 默认。发起新会话。使用此选项会忽略包含的任何 thread ID 或 threadKey。
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD 创建消息，作为对 thread ID 或 threadKey 指定的会话的回复。如果失败，相应消息会改为发起新会话。
REPLY_MESSAGE_OR_FAIL 创建消息，作为对 thread ID 或 threadKey 指定的会话的回复。如果使用了新的 threadKey，系统会创建一个新线程。如果消息创建失败，则会返回 NOT_FOUND 错误。