Method: spaces.messages.create

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

Метод create() требует либо аутентификации пользователя , либо аутентификации приложения . Chat атрибутирует отправителя сообщения по-разному в зависимости от типа аутентификации, который вы используете в своем запросе.

На следующем изображении показано, как 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 . Пример использования см. в разделе «Начать цепочку сообщений или ответить на нее» .

request Id

string

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

message Reply Option

enum ( MessageReplyOption )

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

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

message Id

string

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

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

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

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

Тело запроса

Тело запроса содержит экземпляр 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

Дополнительную информацию см. в руководстве по авторизации .

Опция ответа сообщения

Указывает, как ответить на сообщение. В будущем могут быть добавлены и другие штаты.

Перечисления
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 .