Google Chat API (chat:v1)

2023-01-10

7 removed methods

Deletions

    Methods

  • ▼ ▲ chat.spaces.webhooks

      Parameters:

        messageReplyOption

          Type: string

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

          • Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

          Location: query

        parent

          Pattern: ^spaces/[^/]+$

          Required: Yes

          Location: path

          Type: string

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

        messageId

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

          Type: string

          Location: query

        requestId

          Type: string

          Location: query

          Description: 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.

        threadKey

          Location: query

          Type: string

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      Flat Path: v1/spaces/{spacesId}/webhooks

      Parameter Order: parent

      Path: v1/{+parent}/webhooks

      HTTP Method: POST

  • ▼ ▲ chat.rooms.conversations.messages

      Parameters:

        messageId

          Type: string

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

          Location: query

        requestId

          Description: 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.

          Type: string

          Location: query

        messageReplyOption

          Location: query

          Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

          • Type: string

        parent

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

          Pattern: ^rooms/[^/]+/conversations/[^/]+$

          Location: path

          Type: string

          Required: Yes

        threadKey

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Location: query

          Type: string

      HTTP Method: POST

      Path: v1/{+parent}/messages

      Parameter Order: parent

      Flat Path: v1/rooms/{roomsId}/conversations/{conversationsId}/messages

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

  • ▼ ▲ chat.rooms.messages

      Flat Path: v1/rooms/{roomsId}/messages

      Parameter Order: parent

      HTTP Method: POST

      Parameters:

        messageId

          Location: query

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

          Type: string

        requestId

          Type: string

          Description: 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.

          Location: query

        parent

          Location: path

          Required: Yes

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

          Type: string

          Pattern: ^rooms/[^/]+$

        threadKey

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Type: string

          Location: query

        messageReplyOption

          Type: string

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Location: query

          Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

          • Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      Path: v1/{+parent}/messages

  • ▼ ▲ chat.rooms.webhooks

      Parameters:

        messageReplyOption

          Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

          Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

          • Location: query

          Type: string

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

        parent

          Required: Yes

          Pattern: ^rooms/[^/]+$

          Location: path

          Type: string

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

        messageId

          Location: query

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

          Type: string

        threadKey

          Type: string

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Location: query

        requestId

          Type: string

          Location: query

          Description: 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.

      Parameter Order: parent

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      Path: v1/{+parent}/webhooks

      HTTP Method: POST

      Flat Path: v1/rooms/{roomsId}/webhooks

  • ▼ ▲ chat.dms.messages

      Parameter Order: parent

      Flat Path: v1/dms/{dmsId}/messages

      Parameters:

        requestId

          Type: string

          Description: 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.

          Location: query

        parent

          Type: string

          Location: path

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

          Pattern: ^dms/[^/]+$

          Required: Yes

        messageReplyOption

          Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

          Type: string

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Location: query

          Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

        threadKey

          Type: string

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Location: query

        messageId

          Location: query

          Type: string

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      HTTP Method: POST

      Path: v1/{+parent}/messages

  • ▼ ▲ chat.dms.webhooks

      Path: v1/{+parent}/webhooks

      HTTP Method: POST

      Flat Path: v1/dms/{dmsId}/webhooks

      Parameters:

        threadKey

          Location: query

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Type: string

        messageReplyOption

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Location: query

          Type: string

          Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

          • Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

        requestId

          Location: query

          Description: 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.

          Type: string

        parent

          Type: string

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

          Required: Yes

          Location: path

          Pattern: ^dms/[^/]+$

        messageId

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

          Type: string

          Location: query

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      Parameter Order: parent

  • ▼ ▲ chat.dms.conversations.messages

      Flat Path: v1/dms/{dmsId}/conversations/{conversationsId}/messages

      Parameter Order: parent

      HTTP Method: POST

      Description: Legacy path for creating message. Calling these will result in a BadRequest response.

      Path: v1/{+parent}/messages

      Parameters:

        requestId

          Location: query

          Type: string

          Description: 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.

        messageId

          Location: query

          Type: string

          Description: Optional. A custom name for a Chat message assigned at creation. Must start with `client-` and contain only lowercase letters, numbers, and hyphens up to 63 characters in length. Specify this field to get, update, or delete the message with the specified value. For example usage, see [Name a created message](https://developers.google.com/chat/api/guides/crudl/messages#name_a_created_message).

        parent

          Required: Yes

          Location: path

          Pattern: ^dms/[^/]+/conversations/[^/]+$

          Type: string

          Description: Required. The resource name of the space in which to create a message. Format: spaces/{space}

        messageReplyOption

          Location: query

          Enum Descriptions:

        • Default. Starts a thread.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, the message starts a new thread instead.
        • Creates the message as a reply to the thread specified by thread ID or thread_key. If it fails, a NOT_FOUND error is returned instead.

          • Type: string

          Description: Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces.

          Enum:

        • MESSAGE_REPLY_OPTION_UNSPECIFIED
        • REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
        • REPLY_MESSAGE_OR_FAIL

        threadKey

          Type: string

          Description: Optional. Deprecated: Use thread.thread_key instead. Opaque thread identifier. To start or add to a thread, create a message and specify a `threadKey` or the thread.name. For example usage, see [Start or reply to a message thread](/chat/api/guides/crudl/messages#start_or_reply_to_a_message_thread).

          Location: query