Method: spaces.messages.create

Создает сообщение в чате Google. Пример см. в разделе «Отправка сообщения» .

Поддерживаются следующие типы аутентификации :

  • Аутентификация приложения с указанием области авторизации:
    • 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 в качестве отправителя сообщения. Содержимое сообщения может включать текст ( text ), карточки ( cardsV2 ) и дополнительные виджеты ( accessoryWidgets ).

Сообщение отправлено с аутентификацией приложения.

На следующем изображении показано, как Chat присваивает сообщениям атрибуты при использовании аутентификации пользователя. Chat отображает пользователя как отправителя сообщения и присваивает сообщению имя приложения Chat. Содержимое сообщения может содержать только текст ( text ).

Сообщение отправлено с аутентификацией пользователя.

Максимальный размер сообщения, включая его содержимое, составляет 32 000 байт.

В случае запросов через веб-перехватчик ответ не содержит полного сообщения. В ответ, помимо информации, содержащейся в запросе, заполняются только поля name и thread.name

HTTP-запрос

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

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Имя ресурса пространства, в котором будет создано сообщение.

Формат: spaces/{space}

Параметры запроса

Параметры
threadKey
(deprecated)

string

Необязательный параметр. Устарело: используйте thread.thread_key вместо него. Идентификатор потока. Поддерживает до 4000 символов. Чтобы начать поток или добавить сообщение, создайте сообщение и укажите threadKey или thread.name . Пример использования см. в разделе «Начало или ответ на поток сообщений» .

requestId

string

Необязательно. Уникальный идентификатор запроса для этого сообщения. Указание существующего идентификатора запроса возвращает сообщение, созданное с этим идентификатором, вместо создания нового сообщения.

messageReplyOption

enum ( MessageReplyOption )

Необязательный параметр. Указывает, начинает ли сообщение обсуждение или отвечает на него. Поддерживается только в именованных пространствах.

При ответе на действия пользователя это поле игнорируется. Для взаимодействий в рамках одной ветки обсуждения ответ создается в той же ветке. В противном случае ответ создается в новой ветке обсуждения.

messageId

string

Необязательно. Пользовательский идентификатор для сообщения. Позволяет приложениям чата получать, обновлять или удалять сообщения без необходимости хранить присвоенный системой идентификатор в имени ресурса сообщения (представленном в поле name сообщения).

Значение этого поля должно соответствовать следующим требованиям:

  • Начинается с client- . Например, client-custom-name — это допустимый пользовательский идентификатор, а custom-name — нет.
  • Содержит до 63 символов и только строчные буквы, цифры и дефисы.
  • Уникален в пределах одного пространства. Приложение для чата не может использовать один и тот же пользовательский идентификатор для разных сообщений.

Подробности см. в разделе «Назовите сообщение» .

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 )

Тип уведомления для сообщения.

Тип уведомления

Типы уведомлений для сообщений.

Перечисления
NOTIFICATION_TYPE_NONE Поведение по умолчанию. Поведение уведомлений аналогично тому, как если бы пользователь отправил сообщение через интерфейс чата: уведомление отправителю не отправляется.
NOTIFICATION_TYPE_FORCE_NOTIFY

Принудительное уведомление получателей. Эта опция обходит настройки уведомлений в пространстве и настройки режима «Не беспокоить» в чате . Данная опция не обходит настройки режима «Не беспокоить» на уровне устройства.

Требуется аутентификация приложения .

NOTIFICATION_TYPE_SILENT

Отключите уведомление, как если бы у получателей был включен режим «Не беспокоить» в чате или они отключили звук в этом пространстве.

Требуется аутентификация приложения .