Перейти к содержимому
API

Новое сообщение

POST/messages

Метод для отправки сообщения в беседу или канал, личного сообщения пользователю или комментария в тред.

При использовании entity_type: "discussion" (или просто без указания entity_type) допускается отправка любого chat_id в поле entity_id. То есть, сообщение можно отправить зная только идентификатор чата. При этом, вы имеете возможность отправить сообщение в тред по его идентификатору или личное сообщение по идентификатору пользователя.

Для отправки личного сообщения пользователю создавать чат не требуется. Достаточно указать entity_type: "user" и идентификатор пользователя. Чат будет создан автоматически, если между вами ещё не было переписки. Между двумя пользователями может быть только один личный чат.

Тело запроса

application/json
message
object
*
Собранный объект параметров создаваемого сообщения
entity_type
string
Тип сущности
Возможные значения
discussion
Беседа или канал
thread
Тред
user
Пользователь
entity_id
integer, (int32)
*
Идентификатор сущности
content
string
*
Текст сообщения
files[]
array of objects
Прикрепляемые файлы
key
string
*
Путь к файлу, полученный в результате POSTзагрузки файла
name
string
*
Название файла, которое вы хотите отображать пользователю (рекомендуется писать вместе с расширением)
file_type
string
*
Тип файла
Возможные значения
file
Файл
image
Изображение
size
integer, (int32)
*
Размер файла в байтах, отображаемый пользователю
width
integer, (int32)
Ширина изображения в px (используется в случае, если file_type указан как image)
height
integer, (int32)
Высота изображения в px (используется в случае, если file_type указан как image)
buttons[][]
array of arrays of objects
Массив строк, каждая из которых представлена массивом кнопок. Максимум 100 кнопок у сообщения, до 8 кнопок в строке.
text
string
*
Текст, отображаемый на кнопке
Длина:
<= 255 символов
url
string
Ссылка, которая будет открыта по нажатию кнопки
data
string
Данные, которые будут отправлены в исходном вебхуке по нажатию кнопки
Длина:
<= 255 символов
parent_message_id
integer, (int32)
Идентификатор сообщения. Указывается в случае, если вы отправляете ответ на другое сообщение.
display_avatar_url
string
Ссылка на специальную аватарку отправителя для этого сообщения. Использование этого поля возможно только с access_token бота.
Длина:
<= 255 символов
display_name
string
Полное специальное имя отправителя для этого сообщения. Использование этого поля возможно только с access_token бота.
Длина:
<= 255 символов
skip_invite_mentions
boolean
Пропуск добавления упоминаемых пользователей в тред. Работает только при отправке сообщения в тред.
По умолчанию:
false

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
data
object
*
Сообщение
id
integer, (int32)
*
Идентификатор сообщения
entity_type
string
*
Тип сущности, к которой относится сообщение
Возможные значения
discussion
Беседа или канал
thread
Тред
user
Пользователь
entity_id
integer, (int32)
*
Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя)
chat_id
integer, (int32)
*
Идентификатор чата, в котором находится сообщение
content
string
*
Текст сообщения
user_id
integer, (int32)
*
Идентификатор пользователя, создавшего сообщение
created_at
string, (date-time)
*
Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
url
string
*
Прямая ссылка на сообщение
files[]
array of objects
*
Прикрепленные файлы
id
integer, (int32)
*
Идентификатор файла
key
string
*
Путь к файлу
name
string
*
Название файла с расширением
file_type
string
*
Тип файла
Возможные значения
file
Обычный файл
image
Изображение
url
string
*
Прямая ссылка на скачивание файла
width
nullableinteger, (int32)
Ширина изображения в пикселях
height
nullableinteger, (int32)
Высота изображения в пикселях
buttons[][]
array of arrays of objects
*
Массив строк, каждая из которых представлена массивом кнопок
text
string
*
Текст, отображаемый на кнопке
Длина:
<= 255 символов
url
string
Ссылка, которая будет открыта по нажатию кнопки
data
string
Данные, которые будут отправлены в исходном вебхуке по нажатию кнопки
Длина:
<= 255 символов
thread
nullableobject
*
Тред сообщения
id
integer, (int64)
*
Идентификатор созданного треда (используется для отправки POSTновых комментариев в тред)
chat_id
integer, (int64)
*
Идентификатор чата треда (используется для отправки POSTновых комментариев в тред и получения GETсписка комментариев)
message_id
integer, (int64)
*
Идентификатор сообщения, к которому был создан тред
message_chat_id
integer, (int64)
*
Идентификатор чата сообщения
updated_at
string, (date-time)
*
Дата и время обновления треда (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
forwarding
nullableobject
*
Информация о пересланном сообщении
original_message_id
integer, (int32)
*
Идентификатор оригинального сообщения
original_chat_id
integer, (int32)
*
Идентификатор чата, в котором находится оригинальное сообщение
author_id
integer, (int32)
*
Идентификатор пользователя, создавшего оригинальное сообщение
original_created_at
string, (date-time)
*
Дата и время создания оригинального сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
original_thread_id
nullableinteger, (int32)
*
Идентификатор треда, в котором находится оригинальное сообщение
original_thread_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому был создан тред, в котором находится оригинальное сообщение
original_thread_parent_chat_id
nullableinteger, (int32)
*
Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение
parent_message_id
nullableinteger, (int32)
*
Идентификатор сообщения, к которому написан ответ
display_avatar_url
nullablestring
*
Ссылка на аватарку отправителя сообщения
display_name
nullablestring
*
Полное имя отправителя сообщения
Новое сообщение
Ответ 201