NewMessageBody
Объект используется при отправке нового сообщения в чат или каналPOST /messages, редактировании существующего сообщения или поста PUT /messages, а также callback-отправке сообщения пользователю при нажатии им кнопки в чате или канале POST /answers
Параметры объекта содержат: текст и способ его форматирования, вложения, ссылку на связанное сообщение (ответ или пересылка), настройку PUSH-уведомлений для участников чата
4000 символов
null, изменений не произойдёт. Если массив пуст, все вложения будут удалены
type: video) и одно вложение с кнопками (type: inline_keyboard). Общее количество вложений не должно превышать общее ограничение — 12. Подробнее — в примерах
от 1 символа
Любой внешний URL изображения, которое вы хотите прикрепить
retval. Подробнее — в описании POST /uploads
retval. Подробнее — в описании POST /uploads
type: inline_keyboard). Передача других типов вложений совместно с контактом не поддерживается
Данные для прикрепления кнопок к сообщению Ограничения:
- Максимальное количество кнопок в ряду — 7
- Максимальное количество строк с кнопками — 30
- Если в ряду кнопки с типами:
link,open_app,request_geo_location,request_contact, то максимальное количество кнопок в ряду — три
от 1 символа
Двумерный массив кнопок. Подробнее о типах кнопок и клавиатуре в ботах — в разделе «Клавиатура для чат-бота»
от 1 до 128 символов
Видимый текст кнопки. Чтобы он отображался полностью, рекомендуем не превышать заданное количество символов в зависимости от размещения текста: 20 символов — при одной кнопке в ряду, 10 — при двух, 5 — при трёх, 3 — при четырёх
до 1024 символов
Токен кнопки
2048 символов
true, отправляет местоположение без запроса подтверждения пользователя
Если false, возвращает модальное окно с дополнительным уточнением об отправке местоположения
до 1024 символов
Текст, который будет скопирован
от 1 символа
URL, прикреплённый к сообщению для предпросмотра медиавложения
Возможные значения в enum: "forward" "reply"
Тип связанного сообщения:
"reply"— ответ на сообщение или комментарий в чате или канале"forward"— пересланное сообщение в чате или канале
Для комментариев поддерживается только тип reply
По умолчанию: true
Для каналов всегда отправляйте запрос с notify = true или без этого поля. Отключить push-уведомления в каналах нельзя
В групповых чатах и диалогах, если notify = true или поле отсутствует, уведомление отобразится пользователю
При notify = false отображение push-уведомлений зависит от платформы:
- Десктоп-клиент и веб-приложение на iOS. В диалогах и групповых чатах при
notify = falseуведомления не отображаются - Приложение на Android. В диалогах при
notify = falseуведомления не отображаются. В групповых чатах приnotify = falseуведомление не отображаются, только если приложение МАХ свёрнуто или закрыто. Если приложение открыто, пользователь увидит уведомление - Веб-приложение. Управление отображением уведомлений с помощью параметра
notifyне поддержано
Возможные значения в enum: "markdown" "html"
Разметка текста сообщения. Подробнее — в разделе Форматирование
Пример объекта
{
"text": "string",
"attachments": [
{
"type": "image",
"payload": {
"url": "string",
"token": "string",
"photos": {
"token": "string"
}
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "video",
"payload": {
"token": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "audio",
"payload": {
"token": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "file",
"payload": {
"token": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "sticker",
"payload": {
"code": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "contact",
"payload": {
"name": "string",
"contact_id": 0,
"vcf_info": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "callback",
"text": "string",
"payload": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "link",
"text": "string",
"url": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "request_geo_location",
"text": "string",
"quick": true
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "request_contact",
"text": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "open_app",
"text": "string",
"web_app": "string",
"contact_id": 0,
"payload": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "message",
"text": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "inline_keyboard",
"payload": {
"buttons": [
[
{
"type": "clipboard",
"text": "string",
"payload": "string"
}
]
]
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "location",
"latitude": 0,
"longitude": 0
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}
{
"text": "string",
"attachments": [
{
"type": "share",
"payload": {
"url": "string",
"token": "string"
}
}
],
"link": {
"type": "forward",
"mid": "string"
},
"notify": true,
"format": "markdown"
}