messages.send
Метод отправляет сообщение.
Параметры
integer
Обязательный параметр. Идентификатор пользователя, которому отправляется сообщение. Вместо него можно использовать peer_id.
integer
Обязательный параметр. Уникальный (в привязке к идентификатору приложения и идентификатору отправителя) идентификатор, предназначенный для предотвращения повторной отправки одного и того же сообщения. Сохраняется вместе с сообщением и доступен в истории сообщений. Возможные значения:
- •
0— проверка на уникальность не нужна. - •Любое другое число в пределах
int32— проверка на уникальность нужна.
Переданный в запросе random_id используется для проверки уникальности сообщений в заданном диалоге за последний час (но не более 100 последних сообщений).
integer
Необязательный параметр. Идентификатор получателя сообщения:
- •Для пользователя —
ИДЕНТИФИКАТОР_ПОЛЬЗОВАТЕЛЯ. - •Для групповой беседы —
2000000000 + ИДЕНТИФИКАТОР_БЕСЕДЫ. - •Для сообщества —
-ИДЕНТИФИКАТОР_СООБЩЕСТВА.
string
Необязательный параметр. Идентификаторы получателей сообщения, перечисленные через запятую. Максимальное количество идентификаторов — 100.
Примечание. Доступно только для ключа доступа сообщества.
string
Необязательный параметр. Короткий адрес пользователя. Пример: persik_ryzhiy.
positive
Необязательный параметр. Идентификатор беседы, в которую отправляется сообщение.
string
Необязательный параметр. Идентификаторы получателей сообщения, перечисленные через запятую. Максимальное количество идентификаторов — 100.
Примечание. Доступно только для ключа доступа сообщества.
string
Необязательный параметр. Текст личного сообщения. Обязательный параметр, если не задан параметр attachment.
Макс. длина = 9000
string
Необязательный параметр. Географическая широта в градусах. Диапазон значений: от -90 до 90.
string
Необязательный параметр. Географическая долгота в градусах. Диапазон значений: от -180 до 180.
string
Необязательный параметр. Объект или несколько объектов, приложенных к записи. Обязательный параметр, если не задан параметр message.
К записи можно приложить медиа или ссылку на внешнюю страницу. Если объектов несколько, укажите их через запятую ,.
Формат описания медиавложения: {type}{owner_id}_{media_id}, где:
- •
type— тип медиавложения:- •
photo— фотография. - •
video— видеозапись. - •
audio— аудиозапись. - •
doc— файл. - •
wall— запись на стене. - •
market— товар. - •
poll— опрос. - •
question— вопрос.
- •
- •
owner_id— идентификатор владельца медиавложения. Идентификатор сообщества должен начинаться со знака-. - •
media_id— идентификатор медиавложения.
Если прикрепляется медиавложение, которое принадлежит другому пользователю, добавьте к формату описания медиавложения ключ доступа: {type}{owner_id}_{media_id}_{access_key}.
Макс. длина = 9000
integer
Необязательный параметр. Идентификатор сообщения, на которое требуется ответить.
integer
Необязательный параметр. Идентификаторы пересылаемых сообщений, перечисленные через запятую. Пересылаемые сообщения отправителя будут отображаться в теле сообщения у получателя.
Ограничения:
- •Не более 100 значений на верхнем уровне.
- •Максимальный уровень вложенности — 45.
- •Максимальное количество пересылаемых сообщений — 500.
text
Необязательный параметр. JSON-объект со следующими полями:
- •
owner_id— владелец сообщений. Укажите это поле, если вы хотите переслать сообщения из сообщества в личный диалог. - •
peer_id— идентификатор места, из которого необходимо переслать сообщения. - •
conversation_message_ids— массивconversation_message_idсообщений, которые необходимо переслать. В параметр можно передать сообщения, которые:- •Находятся в личном диалоге с ботом.
- •Являются исходящими сообщениями бота.
- •Написаны после того, как бот вступил в беседу и появился доступ к сообщениям.
- •
- •
message_ids— массив идентификаторов сообщений. - •
is_reply— ответ на сообщения. Укажите это поле, если вы хотите ответить на сообщения в том чате, в котором находятся сообщения. При этом вconversation_message_idsилиmessage_idsдолжен находиться только один элемент.
positive
Необязательный параметр. Идентификатор стикера.
integer
Необязательный параметр. Идентификатор сообщества для сообщений сообщества с ключом доступа пользователя.
text
Необязательный параметр. Объект, описывающий клавиатуру бота.
text
Необязательный параметр. Объект, описывающий шаблон сообщения.
text
Необязательный параметр. Полезные данные.
text
Необязательный параметр. Объект в формате JSON, описывающий источник пользовательского контента для чат-ботов.
checkbox
Необязательный параметр. Информация о том, создать ли сниппет ссылки из сообщения. Возможные значения:
- •
1— не создавать сниппет ссылки из сообщения. - •
0— создать сниппет ссылки из сообщения.
checkbox
Необязательный параметр. Информация о том, отключить ли уведомление об упоминании в сообщении. Возможные значения:
- •
1— отключить уведомление об упоминании в сообщении. - •
0— не отключать уведомление об упоминании в сообщении.
string
Необязательный параметр. Строка, описывающая интенты.
positive
Необязательный параметр. Число, которое будет использоваться для работы с интентами в будущем.
Результат
Метод возвращает идентификатор отправленного сообщения. Если передан параметр peer_ids, метод возвращает массив объектов. Поля объекта:
Поле | Тип | Описание |
|---|---|---|
peer_id | integer | Идентификатор назначения. |
message_id | integer | Идентификатор сообщения. |
conversation_message_id | integer | Идентификатор сообщения в диалоге. |
error | string | Сообщение об ошибке, если сообщение не было доставлено получателю. |
Пример ответа:
{
"response":5
}
Коды ошибок
В ходе выполнения могут произойти общие ошибки
