Плейсхолдеры для описания Правила обработки события
Для каждого существующего в системе События уведомления существует набор Плейсхолдеров, который позволяет извлекать определенную информацию из базы данных и автоматически вставлять извлеченные данные в заранее определенное место. Тем самым Плейсхолдер обеспечивает автоматическое заполнение форм и сообщений.
В таблице ниже приведен список Событий и соответствующих им Плейсхолдеров, которые могут быть использованы для описания Правила обработки данного события.
| Событие | Плейсхолдер | Описание | Тип | Пример |
|---|---|---|---|---|
Общее для всех событий | owner.status | статус владельца Клиента | string | owner.status = "active" |
owner.country | 2-буквенный код страны (ISO), к которой принадлежит владелец Клиента (например, BY для Республики Беларусь) | string | owner.country = "BY" | |
owner.city | название города, к которой принадлежит владелец Клиента | string | owner.city = "Minsk" | |
| current_date | текущая дата | date | current_date | |
Клиент изменен (Account changed) Недостаточно средств на балансе (Low balance) Создание сервера (Create instance) Сброс пароля сервера (Reset instance password) | account.type_id | ID Типа клиентов | integer | account.type_id = 1 |
| account.type_key | ключ Типа клиентов | string | account.type_key = "business" | |
| account.class_id | id Правила обслуживания Клиента | integer | account.class_id = 1 | |
| account.class_key | ключ Правила обслуживания Клиента | string | account.class_key = "manual" | |
| account.billing_day | Финансовый день, установленный в Правиле предоставления Тарифного плана, на который подписан Клиент; порядковый номер дня в месяце | integer | account.billing_day = 30 | |
| account.financial_blocking_threshold | integer | account.financial_blocking_threshold = 100 | ||
| account.balance | Баланс клиента | integer | account.balance = 1000 | |
| account.balance.was | предыдущее значение Баланса клиента.
| integer | account.balance.was = 100 | |
| account.status | статус Клиента | string | account.status = "inactive" | |
| account.status.was | предыдущий статус Клиента
| string | account.status.was = "inactive" | |
| account.country | 2-буквенный код страны (ISO), к которой принадлежит Клиент (например, BY для Республики Беларусь) | string | account.country = "BY" | |
| account.city | название города, к которой принадлежит Клиент | string | account.city = "Minsk" | |
| Недостаточно средств на балансе (Low balance) | account.regular_sending | Плейсхолдер используется для задания условий отправки уведомлений о низком Балансе.
| boolean | "account.regular_sending = true" |
| account.has_endless_trial_subscriptions | параметр используется для установки типа Подписок для которых необходимо отправлять СМС уведомления (пробная Подписка/ коммерческая Подписка) Если "account.has_endless_trial_subscriptions = true" СМС уведомление о низком Балансе отправляется только при наличии хотя бы одной активной коммерческой Подписки, работающей по потребленным ресурсам (IaaS). | boolean | "account.has_endless_trial_subscriptions = true" | |
Закрытие Акта (Invoice closed) | invoice.status | статус Акта | string | invoice.status = "open" |
Ручная операция (Manual Operation) | operation.id | ID Ручной операции | integer | operation.id = 1 |
| operation.status | статус Ручной операции | string | operation.status = "approval_required" | |
Приглашение пользователя (User invitation) | - | - | - | - |
Платеж получен (Payment has been received) | account.type_key | ключ Типа клиентов | string | account.type_key = "business" |
| account.class_key | ключ Правила обслуживания Клиента | string | account.class_key = "manual" | |
| account.billing_day | Финансовый день - число месяца, в которое производится формирование Актов (см. Управление Актами) и изменение статуса Списаний (см. Просмотр Списаний) для Клиента (данный параметр может иметь значение от 1 до 31, определяющее день месяца) | integer | account.billing_day = 30 | |
| account.financial_blocking_threshold | integer | account.financial_blocking_threshold = 100 | ||
| account.balance | Баланс клиента | integer | account.balance = 1000 | |
| account.status | статус Клиента | string | account.status = "inactive" | |
| account.country | название страны, к которой принадлежит Клиент | string | account.country = "Belarus" | |
| account.city | название города, к которой принадлежит Клиент | string | account.city = "Minsk" | |
| payment.total | общая сумма Платежа (Итого), | integer | payment.total = 100 | |
| payment.status | статус Платежа | string | payment.status = "completed" | |
Запрос сброса пароля (Password reset request) Подтверждение email (Verify email) | user.id | ID Пользователя | integer | user.id = 1 |
До окончания периода подписки После окончания периода подписки Подписка переведена из пробного статуса в платный Подписка изменена (Subscription changed) | account.type_key | ключ Типа клиента | string | account.type_key = "business" |
| account.class_key | ключ Правила обслуживания Клиента | string | account.class_key = "manual" | |
| account.billing_day | Финансовый день - число месяца, в которое производится формирование Актов (см. Управление Актами) и изменение статуса cписаний (см. Просмотр Списаний) для Клиента (данный параметр может иметь значение от 1 до 31, определяющее день месяца) | integer | account.billing_day = 30 | |
| account.financial_blocking_threshold | Денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение Разрешенного периода отрицательного баланса | integer | account.financial_blocking_threshold = 100 | |
| account.balance | Баланс клиента | integer | account.balance = 1000 | |
| account.status | статус Клиента | string | account.status = "inactive" | |
| account.country | название страны, к которой принадлежит Клиент | string | account.country = "Belarus" | |
| account.city | название города, к которой принадлежит Клиент | string | account.city = "Minsk" | |
| plan.id | ID Тарифного плана | integer | plan.id = 1 | |
| plan.status | статус Тарифного плана | string | plan.status = "completed" | |
| plan_category.key | ключ Категории тарифных планов | string | plan_category.key = "streaming" | |
| plan_period.duration_value | длительность периода Подписки на Тарифный план | integer | plan_period.duration_value = 30 | |
| plan_period.duration_type | единицы измерения длительности периода Подписки на Тарифный план (год, месяц, день) | string | plan_period.duration_type = "months" | |
| plan_period.trial | является ли период Тарифного плана пробным | boolean | plan_period.trial = "false" | |
| plan_period.setup_fee | стоимость установки Подписки на период Тарифного плана | integer | plan_period.setup_fee = 100 | |
| plan_period.recurring_fee | абонентская плата за Подписку на период Тарифного плана | integer | plan_period.recurring_fee = 100 | |
| plan_period.renewal_fee | стоимость продления Подписки на период Тарифного плана | integer | plan_period.renewal_fee = 100 | |
| subscription.id | ID Подписки | integer | subscription.id = 1 | |
| subscription.status | статус Подписки | string | subscription.status = "active" | |
| subscription.status.was | предыдущий статус Подписки | string | subscription.status.was="installing" | |
| subscription.auto_renewal | включена ли опция "Автопродление" в Подписке | boolean | subscription.auto_renewal = "true" | |
| subscription.days_left | количество дней до даты истечения Подписки | integer | subscription.days_left = 7 | |
| subscription.days_passed | количество дней, прошедших со дня создания Подписки | integer | subscription.days_passed = 15 | |
| subscription.plan_class | ID Правила предоставления Тарифного плана | integer | subscription.plan_class = 1 | |
| subscription.trial.status | является ли Подписка пробной Плейсхолдер может быть применен при настройке События уведомлений для События "Подписка изменена" (“Subscription changed”). В этом случае при изменении периода Тарифного плана Подписок, подпадающих под правила События уведомлений, с пробного на полный (с trial на no-trial), должно направляться соответствующее Уведомление согласно настройкам События. | string | subscription.trial.status = "trial" subscription.trial.status = "no-trial" | |
| subscription.renewal_amount | Сумма для пополнения Баланса клиента, необходимая для успешного автоматического продления Услуги | number | subscription.renewal_amount = 123.4 | |
| product.id | ID Продукта Тарифного плана, на который оформлена Подписка (см. Изменение общей информации о Тарифном плане) | integer | product.id = 1 | |
| product.name | Имя Продукта Тарифного плана, на который оформлена Подписка (см. Изменение общей информации о Тарифном плане) | integer | product.name = "Default" | |
Заказ изменен (Order changed) Заказ создан (Order created) | order.id | ID Заказа | integer | order.id = 1 |
| order.plans_ids | ID заказанных Тарифных планов | integer | order.type = "SalesOrder" and (order.plans_ids include? 2000030) | |
| order.status | статус Заказа | string | order.status = "waiting for payment" | |
| order.status.was | предыдущий статус Заказа | string | order.status.was = "provisioning" | |
| order.total | общая стоимость Заказа | integer | order.total = 100 | |
| order.type | тип Заказа | string | order.type = "RenewalOrder" | |
| order.renewal_point | установлено ли значение в поле Точка автоматического продления (в днях) на странице Подписки | boolean | order.renewal_point = "true" | |
| product.id | ID Продукта Тарифного плана на который оформлена Подписка, включенная в Заказ (см. Просмотр информации о Заказе) | integer | product.id = 1 | |
| product.name | Название Продукта Тарифного плана на который оформлена Подписка, включенная в Заказ (см. Просмотр информации о Заказе) | integer | product.name = "Default" | |
Обещанный платеж создан (Guaranteed payment created) Обещанный платеж изменен (Guaranteed payment changed) | account.type_id | ID Типа клиентов | integer | account.type_id = 1 |
| account.type_key | ключ Типа клиентов | string | account.type_key = "business" | |
| account.class_id | ID Правила обслуживания Клиента | integer | account.class_id = 1 | |
| account.class_key | ключ Правила обслуживания Клиента | string | account.class_key = "manual" | |
| guaranteed_payment.status.was | предыдущий статус Обещанного платежа | string | guaranteed_payment.status.was = "provided" | |
| guaranteed_payment.status | статус Обещанного платежа | string | guaranteed_payment.status = "revoked" | |
| Обещанный платеж истекает (Guaranteed payment will expire) | guaranteed_payment.days_left | количество дней до истечения Обещанного платежа | integer | guaranteed_payment.days_left = 1 |
| Финансовый день наступает (Billing day is coming) | billing_day | дата Финансового дня, для которого было вызвано Событие | integer | billing_day = 5 |
| billing_day_left | количество дней, которое осталось до Финансового дня, для которого было вызвано Событие В Финансовый день, для которого было вызвано Событие, возвращает не 0, а количество дней до следующего Финансового дня | integer | billing_day_left = 7 | |
| billing_day_open_charges_amount | сумма Cписаний со статусом Открыто для активных Подписок с типами биллинга CSP месячный, Оплата в полном объеме, G-Suite, которые будут закрыты или заблокированы в Финансовый день, для которого было вызвано Событие | number | billing_day_open_charges_amount = 120.1 | |
| plan_ids | массив ID Тарифных планов активных Подписок Клиента | array(int) | plan_ids = [200023, 200024] | |
| product_ids | массив ID Продуктов Тарифных планов, на которые оформлены активные Подписки Клиента | array(int) | product_ids = [100022, 100023] | |
| product_names | массив названий Продуктов Тарифных планов, на которые оформлены активные Подписки Клиента | array(str) | product_names include? "Default" | |
| monthly_billing | флаг, указывающий на то, что у Клиента есть не удаленные Подписки с типами биллинга CSP месячный, Оплата в полном объеме, G-Suite, для которых актуален Финансовый день, для которого было вызвано событие | boolean | monthly_billing = "true" | |
| account.type_key | ключ Типа Клиента | string | account.type_key = "personal" | |
| account.class_key | ключ Правила обслуживания Клиента | string | account.class_key = "default" | |
| account.balance | доступный Баланс Клиента | number | account.balance = 58.5 | |
| account.financial_blocking_threshold | денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение Разрешенного периода отрицательного баланса | number | account.financial_blocking_threshold = 10000 | |
Период отсрочки Платежа истекает (Payment due date is coming) | payment.days_left | количество дней до истечения Периода отсрочки Платежа, за которое будет отправлено Уведомление | integer | payment.days_left = 5 |
Порог срабатывания финансовой блокировки изменен (Credit hold threshold was changed) Приближается финансовая блокировка клиента (Account credit hold is coming) | account.financial_blocking_threshold | денежный лимит, в пределах которого баланс клиента может быть отрицательным без перехода в статус Финансовая блокировка в течение Разрешенного периода отрицательного баланса | integer | account.financial_blocking_threshold = 100 |
Кредитный лимит для постоплатной подписки изменен (Credit limit for postpaid subscription was changed) | subscription_postpay.credit_limit | величина задолженности по Подписке, при превышении которой только данная Подписка по модели Постоплата будет остановлена. | integer | subscription_postpay.credit_limit = 100 |
| Приближение к кредитному лимиту постоплатной подписки (Credit limit for postpaid subscription is approaching) | subscription_postpay.current_debt | текущая задолженность по Подписке, рассчитанная как сумма всех Списаний по данной Подписке за текущий Финансовый период в статусе Заблокировано | integer | subscription_postpay.current_debt = 100 |
| Финансовый день наступил (Billing day has come) | previous_billing_period_start_day | дата начала предыдущего финансового периода относительно финансового дня, для которого было вызвано Событие | date ДД.ММ.ГГГГ | 01.01.2019 |
| previous_billing_period_end_day | дата окончания предыдущего финансового периода относительно финансового дня, для которого было вызвано Событие | date ДД.ММ.ГГГГ | 01.01.2019 | |
| manager_accounts | множество Клиентов менеджера | object | ||
| manager_accounts[].id | ID Клиента | integer | 220001 | |
| manager_accounts[].primary_name | Название Клиента | string | ООО "Компания" | |
| manager_accounts[].type_key | ключ Типа Клиента | string | Personal | |
| manager_accounts[].class_key | ключ Правила обслуживания клиента | string | Default | |
| manager_accounts[].balance | текущий Баланс Клиента | number | 58.5 | |
| manager_accounts[].financial_blocking_threshold | величина Порога срабатывания финансовой блокировки Клиента, заданная на уровне Правила обслуживания или переопределенная на уровне Клиента | number | 10000 | |
| manager_accounts[].subscriptions[] | множество Подписок клиента менеджера | array | ||
| manager_accounts[].subscriptions[].id | ID Подписки Клиента | integer | 320001 | |
| manager_accounts[].subscriptions[].name | название Подписки Клиента | string | Microsoft Azure | |
| manager_accounts[].subscriptions[].payment_model | Модель оплаты подписки. Возможные значения prepay (Предоплата) или postpay (Постоплата). | string | postpay | |
| manager_accounts[].subscriptions[].payment_model_parameters[] | Массив параметров. Возвращается только для подписок payment_model = postpay.
| array | "credit_limit": 4963.0, "current_debt": 500.11 | |
| manager_accounts[].subscriptions[].plan_category_key | ключ Категории тарифного плана, который используется для проверки, что у Килента, для которого вызвано событие, есть не удаленные Подписки на Тарифный план указанной Категории. | string | azure | |
| manager_accounts[]. subscriptions[].closed_charges_amount | сумма Cписаний со статусом Закрыто для Подписки, которые были закрыты за предыдущий финансовый период | number | 12000.15 |
Если параметр "regular_sending" не задан, отправка уведомлений осуществляется дважды: при выполнении биллинг процесса и в момент изменения Баланса.