messages.send
Отправляет сообщение.
Этот метод можно вызвать с ключом доступа пользователя, полученным в Standalone-приложении через Implicit Flow.
Требуются права доступа: messages.
Этот метод можно вызвать с ключом доступа сообщества.
Требуются права доступа: messages.
Параметры
string
Идентификатор пользователя, которому отправляется сообщение.
string
Число в пределах int32
— уникальный (в привязке к API_ID и ID отправителя) идентификатор, предназначенный для предотвращения повторной отправки одинакового сообщения. Сохраняется вместе с сообщением и доступен в истории сообщений.
Переданный в запросе random_id
используется для проверки уникальности, проверяя в заданном диалоге сообщения за последний час (но не более 100 последних сообщений).
string
Идентификатор назначения.
Для пользователя:
- •
id
пользователя.
Для групповой беседы:
- •
2000000000
+id
беседы.
Для сообщества:
- •
-id
сообщества.
string
Идентификаторы получателей сообщения (при необходимости отправить сообщение сразу нескольким пользователям). Доступно только для ключа доступа сообщества. Максимальное количество идентификаторов: 100.
string
Короткий адрес пользователя (например, illarionov
).
string
Идентификатор беседы, к которой будет относиться сообщение.
string
Идентификаторы получателей сообщения (при необходимости отправить сообщение сразу нескольким пользователям). Доступно только для ключа доступа сообщества. Максимальное количество идентификаторов: 100.
string
Текст личного сообщения. Обязательный параметр, если не задан параметр attachment
.
string
Уникальный идентификатор, предназначенный для предотвращения повторной отправки одинакового сообщения.
string
Географическая широта (от -90 до 90).
string
Географическая долгота (от -180 до 180).
string
Медиавложения к личному сообщению, перечисленные через запятую. Каждое прикрепление представлено в формате:
<type><owner_id>_<media_id>
<type>
— тип медиавложения:
- •
photo
— фотография; - •
video
— видеозапись; - •
audio
— аудиозапись; - •
doc
— документ; - •
wall
— запись на стене; - •
market
— товар; - •
poll
— опрос.
<owner_id>
— идентификатор владельца медиавложения (обратите внимание, если объект находится в сообществе, этот параметр должен быть отрицательным).
<media_id>
— идентификатор медиавложения.
Например:
photo100172_166443618
Параметр является обязательным, если не задан параметр message
.
В случае, если прикрепляется объект, принадлежащий другому пользователю следует добавлять к вложению его access_key в формате <type><owner_id>_<media_id>_<access_key>
, Например:
video85635407_165186811_69dff3de4372ae9b6e
string
Идентификатор сообщения, на которое требуется ответить.
string
Идентификаторы пересылаемых сообщений, перечисленные через запятую. Перечисленные сообщения отправителя будут отображаться в теле письма у получателя. Не более 100 значений на верхнем уровне, максимальный уровень вложенности — 45, максимальное количество пересылаемых сообщений — 500.
Например:
123,431,544
string
JSON-объект со следующими полями:
- •
owner_id
— владелец сообщений. Стоит передавать, если вы хотите переслать сообщения из сообщества в диалог; - •
peer_id
— идентификатор места, из которого необходимо переслать сообщения; - •
conversation_message_ids
— массивconversation_message_id
сообщений, которые необходимо переслать. В массивconversation_message_ids
можно передать сообщения:- •находящиеся в личном диалоге с ботом;
- •являющиеся исходящими сообщениями бота;
- •написанными после того, как бот вступил в беседу и появился доступ к сообщениям.
- •
- •
message_ids
— массив id сообщений; - •
is_reply
— ответ на сообщения. Стоит передавать, если вы хотите ответить на сообщения в том чате, в котором находятся сообщения. При этом вconversation_message_ids
илиmessage_ids
должен находиться только один элемент.
string
Идентификатор стикера.
string
Идентификатор сообщества (для сообщений сообщества с ключом доступа пользователя).
string
Объект, описывающий клавиатуру бота.
string
Объект, описывающий шаблон сообщения.
string
Полезная нагрузка.
string
Объект в формате JSON, описывающий источник пользовательского контента для чат-ботов.
string
1
— не создавать сниппет ссылки из сообщения.
string
1
- отключить уведомление об упоминании в сообщении.
string
Строка, описывающая интенты.
string
Параметр зарезервирован для использования в будущем. Число, которое будет использоваться для работы с интентами.
Результат
После успешного выполнения возвращает идентификатор отправленного сообщения.
Если передан параметр peer_ids
, возвращает массив объектов, каждый из которых содержит поля:
- •
peer_id
— идентификатор назначения; - •
message_id
— идентификатор сообщения; - •
conversation_message_id
— идентификатор сообщения в диалоге; - •
error
— сообщение об ошибке, если сообщение не было доставлено получателю.
Коды ошибок
В ходе выполнения могут произойти общие ошибки.