NewMessageBody

Объект используется при отправке нового сообщения в чат или каналPOST /messages, редактировании существующего сообщения или поста PUT /messages, а также callback-отправке сообщения пользователю при нажатии им кнопки в чате или канале POST /answers

Параметры объекта содержат: текст и способ его форматирования, вложения, ссылку на связанное сообщение (ответ или пересылка), настройку PUSH-уведомлений для участников чата

text
string Nullable
до 4000 символов

attachments
AttachmentRequest[] Nullable
Вложения сообщения. Если поле пустое или равно null, изменений не произойдёт. Если массив пуст, все вложения будут удалены

type
string

payload
object PhotoAttachmentRequestPayload
Данные для прикрепления изображения (все поля являются взаимоисключающими). Вместе с изображениями можно прикрепить видеофайлы (type: video) и одно вложение с кнопками (type: inline_keyboard). Общее количество вложений не должно превышать общее ограничение — 12. Подробнее — в примерах

url
string Nullableoptional

от 1 символа

Любой внешний URL изображения, которое вы хотите прикрепить

token
string Nullableoptional
Токен существующего вложения

photos
object Nullableoptional
Токены, полученные после загрузки изображений

link
object NewMessageLink Nullable
Ссылка на сообщение в чате или пост в канале. Ссылки на комментарии к постам в каналах не поддержаны

type
enum MessageLinkType

Возможные значения в enum: "forward" "reply"

Тип связанного сообщения:

  • "reply" — ответ на сообщение или комментарий в чате или канале
  • "forward" — пересланное сообщение в чате или канале

Для комментариев поддерживается только тип reply

mid
string
ID исходного сообщения

notify
booleanoptional

По умолчанию: true

Для каналов всегда отправляйте запрос с notify = true или без этого поля. Отключить push-уведомления в каналах нельзя

В групповых чатах и диалогах, если notify = true или поле отсутствует, уведомление отобразится пользователю

При notify = false отображение push-уведомлений зависит от платформы:

  • Десктоп-клиент и веб-приложение на iOS. В диалогах и групповых чатах при notify = false уведомления не отображаются
  • Приложение на Android. В диалогах при notify = false уведомления не отображаются. В групповых чатах при notify = false уведомление не отображаются, только если приложение МАХ свёрнуто или закрыто. Если приложение открыто, пользователь увидит уведомление
  • Веб-приложение. Управление отображением уведомлений с помощью параметра notify не поддержано

format
enum TextFormat Nullableoptional

Возможные значения в enum: "markdown" "html"

Разметка текста сообщения. Подробнее — в разделе Форматирование

Пример объекта

JSON
{
    "text": "string",
    "attachments": [
        {
            "type": "image",
            "payload": {
                "url": "string",
                "token": "string",
                "photos": {
                    "token": "string"
                }
            }
        }
    ],
    "link": {
        "type": "forward",
        "mid": "string"
    },
    "notify": true,
    "format": "markdown"
}