Платформа A2v10 довідкова система
EN


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

Будь-яка робота з повідомленнями в системі виконується за допомогою підсистеми роботи з повідомленнями.

Команди sendMessage надсилають повідомлення email, sms або інші. Конкретний тип повідомлення визначається шаблоном.

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

Параметри

Ім'я Тип Опис
template string Обов'язково. Ім'я файлу шаблону повідомлень.
key string Обов'язково. Ключ повідомлення в файлі шаблону.

Зверніть увагу! Параметри команди (те, що використовується прив'язкою [[param]]) це не властивість parameters, а параметри, з якими команда викликана з клієнта.

В разі успішного надсиланя повертається статус і ідентифікатор повідомлення з черги у вигляді

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

В разі поминки виникає виключення.

Приклад

Нехай, наприклад, ми бажаємо надіслати повідомлення, яке визначено в файлі messaging/message з ключем message1. В якості ідентифікатора моделі передаємо Id користувача.

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

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

Виклик з клієнта