- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization Scopes
- MessageReplyOption
Creates a message. For example usage, see Create a message.
Requires authentication. Fully supports service account authentication.
Supports user authentication as part of the Google Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.messages
or chat.messages.create
authorization scope.
Because Chat provides authentication for webhooks as part of the URL that's generated when a webhook is registered, webhooks can create messages without a service account or user authentication.
HTTP request
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the space in which to create a message. Format: spaces/{space} |
Query parameters
Parameters | |
---|---|
threadKey |
Optional. Deprecated: Use |
requestId |
Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. |
messageReplyOption |
Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. |
messageId |
Optional. A custom name for a Chat message assigned at creation. Must start with |
Request body
The request body contains an instance of Message
.
Response body
If successful, the response body contains a newly created instance of Message
.
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.bot
https://www.googleapis.com/auth/chat.messages
https://www.googleapis.com/auth/chat.messages.create
For more information, see the Authorization guide.
MessageReplyOption
Specifies how to reply to a message. More states may be added in the future.
Enums | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED |
Default. Starts a thread. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Creates the message as a reply to the thread specified by thread ID or threadKey . If it fails, the message starts a new thread instead. |
REPLY_MESSAGE_OR_FAIL |
Creates the message as a reply to the thread specified by thread ID or threadKey . If it fails, a NOT_FOUND error is returned instead. |