Method: spaces.messages.create

在 Google Chat 聊天室中创建消息。有关示例，请参阅发送消息。

支持以下类型的身份验证：

  • 使用授权范围的应用身份验证：
    • https://www.googleapis.com/auth/chat.bot
  • 通过以下授权范围之一进行用户身份验证：
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（仅限“导入模式聊天室”）

Chat 会根据您在请求中使用的身份验证类型，以不同的方式归因消息发送者。

下图显示了使用应用身份验证时，Chat 如何为消息添加属性。Chat 会将该 Chat 应用显示为消息发送者。消息的内容可以包含文本 (text)、卡片 (cardsV2) 和辅助微件 (accessoryWidgets)。

通过应用身份验证发送的邮件

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

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

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

对于 webhook 请求，响应不包含完整消息。除了请求中的信息之外，响应仅填充 name 和 thread.name 字段。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

格式：spaces/{space}

查询参数

参数
threadKey
(deprecated)

string

可选。已弃用：请改用 thread.thread_key。线程的 ID。最多支持 4,000 个字符。如需发起或添加消息串，请创建消息并指定 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 个字符，并且只能包含小写字母、数字和连字符。
  • 在空间内是唯一的。聊天应用无法为不同的消息使用相同的自定义 ID。

如需了解详情，请参阅为消息命名。
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

可选。控制发布消息时的通知行为。如需了解详情，请参阅强制通知或发送静音消息。

请求正文

请求正文包含一个 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 错误。

CreateMessageNotificationOptions

发布消息时通知行为的选项。

JSON 表示法 
{
  "notificationType": enum (NotificationType)
}
字段
notificationType

enum (NotificationType)

相应消息的通知类型。

NotificationType

消息的通知类型选项。

枚举
NOTIFICATION_TYPE_NONE 默认行为。通知行为与人类用户使用 Chat 界面发送消息时的行为类似：不会向人类发件人发送通知。
NOTIFICATION_TYPE_FORCE_NOTIFY

强制通知收件人。这会绕过用户的聊天室通知设置和 Chat“勿扰”设置。此选项不会绕过设备级“勿扰”设置。

需要应用身份验证。
NOTIFICATION_TYPE_SILENT

将通知设为静音，就好像收件人已启用聊天勿扰或已将聊天室设为静音一样。

需要应用身份验证。