Метод для редактирования сообщения или комментария.
Для редактирования сообщения вам необходимо знать его id
и указать его в URL
запроса. Все редактируемые параметры сообщения указываются в теле запроса.
Строка content
и массив files
являются обязательными параметрами при редактировании сообщения. Если массив присылается пустым, то вложения сообщения (если они были) удаляются.
Запрос
|
|||
---|---|---|---|
message | object* | Собранный объект параметров редактируемого сообщения | |
content | string* | Текст сообщения | |
files | array of objects* | Прикрепляемые файлы | |
key | string* | Путь к файлу, полученный в результате загрузки файла (каждый файл в каждом сообщении должен иметь свой уникальный key, не допускается использование одного и того же key в разных сообщениях) | |
name | string* | Название файла, которое вы хотите отображать пользователю (рекомендуется писать вместе с расширением) | |
file_type | string* | Тип файла: файл (file), изображение (image) | |
size | integer* | Размер файла в байтах, отображаемый пользователю | |
buttons | array of array of objects | Массив строк, каждая из которых представлена массивом кнопок. Подробнее о том, как формировать строки кнопок и какие есть ограничения вы можете прочитать в статье. Для удаления кнопок у сообщения пришлите пустой массив. | |
text | string* | Текст, отображаемый на кнопке пользователю | |
url | string** | Ссылка, которая будет открыта по нажатию кнопки | |
data | string** | Данные, которые будут отправлены в исходящем вебхуке по нажатию кнопки | |
Ответ
|
|||
data | object | Созданное сообщение | |
id | integer | Идентификатор созданного сообщения | |
entity_type | string | Тип сущности, к которой относится сообщение: беседа/канал (discussion), тред (thread) или пользователь (user) | |
entity_id | integer | Идентификатор сущности, к которой относится сообщение (беседы/канала, треда или пользователя) | |
chat_id | integer | Идентификатор чата, в котором находится сообщение | |
content | string | Текст сообщения | |
user_id | integer | Идентификатор пользователя, создавшего сообщение | |
created_at | string | Дата и время создания сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
files | array of objects | Прикреплённые файлы | |
id | integer | Идентификатор файла | |
key | string | Путь к файлу | |
name | string | Название файла | |
file_type | string | Тип файла: файл (file), изображение (image) | |
url | string | Прямая временная ссылка на скачивание файла | |
buttons | array of array of objects | Массив строк, каждая из которых представлена массивом кнопок. | |
text | string | Текст, отображаемый на кнопке пользователю | |
url | string | Ссылка, которая будет открыта по нажатию кнопки | |
data | string | Данные, которые будут отправлены в исходящем вебхуке по нажатию кнопки | |
thread | object или null | Тред сообщения. Возвращается как null, если у сообщения нет комментариев. | |
id | integer | Идентификатор треда | |
chat_id | integer | Идентификатор чата треда (используется для отправки новых комментариев в тред и получения списка комментариев) | |
forwarding | object или null | Информация о пересылаемом сообщении. Возвращается как null, если это сообщение не является пересылаемым с сохранением автора. | |
original_message_id | integer | Идентификатор оригинального сообщения | |
original_chat_id | integer | Идентификатор чата, в котором находится оригинальное сообщение | |
author_id | integer | Идентификатор пользователя, создавшего оригинальное сообщение | |
original_created_at | integer | Дата и время создания оригинального сообщения (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ | |
original_thread_id | integer или null | Идентификатор треда, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
original_thread_message_id | integer или null | Идентификатор сообщения, к которому был создан тред, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
original_thread_parent_chat_id | integer или null | Идентификатор чата сообщения, к которому был создан тред, в котором находится оригинальное сообщение. Возвращается как null, если оригинальное сообщение не является комментарием в треде. | |
parent_message_id | integer или null | Идентификатор сообщения, к которому написан ответ. Возвращается как null, если сообщение не является ответом. | |
Возможные ошибки запроса (errors code)
|
|||
blank | Поле не может быть пустым | ||
exclusion | Поле имеет недопустимое значение | ||
not_found | Не удалось найти | ||
|
{
"message": {
"content": "Вот попробуйте написать правильно это с первого раза: Будущий, Полощи, Прийти, Грейпфрут, Мозаика, Бюллетень, Дуршлаг, Винегрет.",
"files": []
}
}
{
"data": {
"id": 7231942,
"entity_type": "discussion",
"entity_id": 17452,
"chat_id": 17452,
"content": "Вот попробуйте написать правильно это с первого раза: Будущий, Полощи, Прийти, Грейпфрут, Мозаика, Бюллетень, Дуршлаг, Винегрет.",
"user_id": 65,
"created_at": "2022-06-08T09:32:57.000Z",
"files": [],
"buttons": [],
"thread": null,
"forwarding": null,
"parent_message_id": null
}
}