Method: spaces.messages.create

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

调用此方法需要进行身份验证,并且支持以下身份验证类型:

  • 对于短信,支持用户身份验证或应用身份验证。
  • 对于卡消息,仅支持应用身份验证。(只有 Chat 应用可以创建卡片消息)。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

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

格式:spaces/{space}

查询参数

参数
threadKey
(deprecated)

string

可选。已废弃:请改用 thread.thread_key。线程的 ID。最多支持 4000 个字符。如要发起消息串或在其中添加消息,请创建消息并指定 threadKeythread.name。如需查看用法示例,请参阅发起或回复消息串

requestId

string

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

messageReplyOption

enum (MessageReplyOption)

可选。指定消息是发起消息串还是回复消息串。仅适用于命名空间。

messageId

string

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

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

  • client- 开头。例如,client-custom-name 是有效的自定义 ID,但 custom-name 不是有效的自定义 ID。
  • 最多包含 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 IDthreadKey
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD 创建消息,作为对 thread IDthreadKey 指定的会话串的回复。如果失败,消息会改为发起新消息串。
REPLY_MESSAGE_OR_FAIL 创建消息,作为对 thread IDthreadKey 指定的会话串的回复。如果使用新的 threadKey,系统会创建一个新线程。如果消息创建失败,系统会改为返回 NOT_FOUND 错误。