A2v10 Platform documentation
UK


Команды типа sendMessage

Любая работа с сообщениями в системе выполняется с помощью подсистемы работы с сообщениями.

Команды sendMessage отправляют сообщения email, sms или другие. Конкретный тип сообщения определяется шаблоном.

Поведение команды определяется параметрами, которые передаются с использованием свойства parameters команды.

Параметры

Имя Тип Описание
template string Обязательно. Имя файла шаблона сообщений.
key string Обязательно. Ключ сообщения в файле шаблона.

Обратите внимание! Параметры команды (то, что используется привязкой [[param]]) это не свойство parameters, а параметры, с которыми команда вызвана с клиента.

В случае успешной отправки возвращается статус и идентификатор сообщения из очереди в виде

{
	"status": "success",
	"id": 1
}

В случае ошибки выбрасывается исключение.

Пример

Пусть, например мы хотим отправить сообщение, которое определено в файле messaging/message c ключом message1. В качестве идентификатора модели передаем Id пользователя.

Серверная команда

"commands": {
"sendMail": {
	"type": "sendMessage",
	"parameters": {
		"template": "messaging/message",
		"key": "message1"
	}
}

Вызов с клиента