{toc}
h1. Описание системы отправки сообщений
Система отправки сообщений Carbon Billing 5 поддерживает 4 метода отправки:
* SMS
* E-mail
* Carbon Manager
* Winpopup
Для её работы следует настроить шаблоны и параметры отправки, для каждого метода свои.
Отправка для Carbon Manager и Winpopup были сделаны для совместимости с предыдущими версиями Carbon Billing. Их настройка в настоящей статье не рассматривается, при необходимости - обратитесь в техподдержку.
h1. Настройка системы и методов отправки
h2. Включение системы отправки сообщений
Для работы системы отправки сообщений, следует включить этот сервис в настройках биллинга
Для этого необходимо перейти в "Управление абонентами и тарифами - настройки - настройки(в файле) - настройки демона отправки сообщений" и выставить флаг в поле "Включить отправку сообщений"
!demon.png|border=1,width=800!
h2. Настойка SMS-шлюза
Вторым шагом будет настройка sms-шлюза.
!0.png|border=1,width=800!
Производим настройку адреса и параметров отправки сообщения
!1.png|border=1,width=600!
За настройку отправки СМС сообщений в Carbon Billing 5 отвечают следующие параметры:
* Тихий час - период времени, когда сообщения не отправляются абонентам.
* Заголовок сообщения - указывается тема письма.
* Адрес СМС шлюза - используется при СМС рассылке.
* Post параметры - параметры для СМС рассылки. %sms%-телефон рассылки, %text% -сообщение.
{note:title=Важно:}
Для настройки отправки смс, у вашего смс шлюза должна быть возможность отправки смс путем вставки запроса в адресную строку браузера
{note}
Пример:
*company* \- название вашей компании
*company123* \- пароль, выданный смс-шлюзом
*79991231122* \- номер для тестовой отправки, на который придет смс
*Тест отправки* \- текст для отправки, указывается без кавычек
Соответственно в строке браузера для тестирования должно быть следующее:
{code}
http://smsc.ru?charset=utf-8&login='company'&psw='company123'&phones=79991231122&mes=Тест отправки
{code}
Соответственно "Адрес СМС шлюза" это то, что {color:#000000}у провайдера шлюза указано{color} {color:#ff0000}слева{color} от символа "?", и "Post параметры СМС шлюза" это то что {color:#ff0000}справа{color}{color:#000000}, при этом переменные{color} {color:#000000}обозначаются как{color} {color:#008000}%(sms)s - номер телефона{color} {color:#008000}и %(text)s - текст сообщения{color}{color:#000000}.{color}
{note}Для того, чтобы корректно работал шаблон сообщений "Отправлять за n дней", необходимо в настройках сообщений оператора связи указать параметр "Предупреждать о лимите за n дней" {note}
h2. Пример оператора смс-шлюза
Вот один из примеров оператора смс-шлюза, который можно настроить в Carbon Billing 5 [http://smsc.ru/|http://smsc.ru/?pp328703/]
*Пример параметров для smsc*
Адрес СМС шлюза:
{code}
http://smsc.ru
{code}
Post параметры:
{code}
charset=utf-8&login='Ваш логин'&psw='Ваш пароль'&phones=%sms%&mes=%text%
{code}
*Пример параметров для Простор СМС*
Адрес СМС шлюза:
{code}
http://gate.prostor-sms.ru/send/
{code}
Post параметры:
{code}
login='Ваш логин'&password='Ваш пароль'&phone=%sms%&text=%text%
{code}
h2. Настройка отправки Email
Для того, чтобы сообщения отправлялись, следует указать "Email для оповещений" в карточке оператора связи.
Например: info@provider.name
h1. Настойка шаблонов сообщений
!2.png|border=1,width=600!
Для каждого типа сообщения надо создать свой шаблон
!3.png|border=1,width=600!
Пример ниже:
Галочка *Отправлять сообщение* отвечает за то нужно отправлять сообщение или нет. Эту галочку можно также поставить в самом шаблоне при редактировании.
h2. Возможные переменные
В шаблонах можно использовать следующие параметры:
%(contract_number)s - номер договора;
%(balance)s - текущий баланс;
Для округления баланса до целого значения используйте параметр %(balance).f
%(currecy)s - валюта сокращение (например руб.);
%(text)s - передаваемый текст (сообщение непосредственно конкретному абоненту);
%(operator_name)s - имя оператора связи(по умолчанию "Лучший провайдер");
%(allow_limit)s - сумма, которая указана в пороге включения(тариф);
%(gen_pwd)s - созданный через админ. панель пароль(не существует, если пароль изменен через ЛК);
%(login)s - логин абонента;
%(tarif_name)s - тариф абонента;
%(plan_comment)s - описание тарифа (например скорость, указывается руками);
%(recomend_pay_sum)5.2f - рекомендуемый платеж
%(recomend_pay_sum_post)5.2f - рекомендуемый платеж постоплата
%(minimal_pay_sum)5.2f - минимальный платеж для разблокировки
А также любые поля абонента, тарифа, счета. Названия переменных можно взять из описания моделей в [CarbonBilling:API REST v2.0]
*Текст заголовка* \- тема e-mail или заголовок смс.
*Текст шаблона* \- непосредственно отправляемый текст.
h2. Тип сообщения. События.
Каждый шаблон сообщения может быть отправлен по любому из выбранных событий:
* *Подключение услуги* \- приходит абоненту при подключении услуги;
* *Положительный баланс* \- приходит абоненту при переходе абонента в положительный баланс(ниже порога отключения абонента);
* *Отрицательный баланс* \- приходит абоненту при переходе абонента в отрицательный баланс(выше порога отключения абонента);
* *Выставлен счет* \- приходит абоненту при выставлении счета абоненту (используется чаще для юр.лиц). Для того, чтобы отправка счета выполнялась вручную из вкладки "Операции", шаблон с данным типом должен быть включен. Вместе со счетом юр.лицам отправляется ещё и акт. Отправка акта выполняется с помощью этого же шаблона сообщений(Выставлен счет);
* *Зачисление денег* \- приходит абоненту при поступлении средств на счет (при условии что в настройках абонента стоят галочки Юр.лицо и Отправлять Счет/Акт, а также Настройки - Число месяца выставления счетов на предоплату);
* *Ручная отправка сообщения* \- при ручной отправке;
* *Занесено в Аудит* \- при занесении информации в Аудит;
* *Достигнут порог предупреждения* \- при достижении порога предупреждения (порог предупреждения из опций тарифа);
* *Сообщение из HelpDesk* \- при создании заявки от абонента в HelpDesk (приходит инженерам Helpdesk);
* *Сообщение из CRM* \- при создании задачи в CRM (приходит ответственному исполнителю).
* *Отправлять за n дней* \- за n дней до даты указанной в карточке абонента в поле "Хватит денег до"
h2. Способы отправки сообщений
В настоящее время поддерживаются 4 способа отправки сообщений пользователям:
!mess3_80.png|border=1!
* Письмо на e-mail;
* SMS сообщение на телефон;
* Всплывающее сообщение в Carbon Agent;
* Передача сообщения по winpopup (редко используется).
Если не выбрать конкретный вид сообщения, то рассылка будет вестись всеми доступными средствами.
h3. Отправитель
Поле отправитель зависит от типа сообщения:
* Если сообщение системное, например у пользователя кончились деньги на счёте, то в поле отправитель будет указан e-mail, принадлежащий Оператору связи.
* Если сообщение отправлялось вручную с помощью веб-интерфейс администратора Carbon Billing 5, то отправителем будет указан e-mail администратора системы, который это сообщение отправил;
* Если данные поля не заполнены, отправителем будет почта вида root@www.example.com, где www.example.com - доменное имя главного внешнего интерфейса.
h1. Отправка сообщений
Для отправки сообщений непосредственно одному из абонентов необходимо зайти в раздел Абоненты, выбрать абонента, вкладка Отправить сообщения. Выбирается метод отправки и выбирается шаблон сообщения. Для отправки произвольного текста, следует создать шаблон с типом *"Ручная отправка"* и текстом шаблона *%(text)s*
h2. Отладка
Логи работы демона отправки сообщений за текущие сутки находятся в файле
{code}/app/asr_billing/var/log/msgd.log{code}
Логи за прошедшие сутки архивируются в этом же каталоге под названием *msgd.log-<date>.gz*
h1. Описание системы отправки сообщений
Система отправки сообщений Carbon Billing 5 поддерживает 4 метода отправки:
* SMS
* Carbon Manager
* Winpopup
Для её работы следует настроить шаблоны и параметры отправки, для каждого метода свои.
Отправка для Carbon Manager и Winpopup были сделаны для совместимости с предыдущими версиями Carbon Billing. Их настройка в настоящей статье не рассматривается, при необходимости - обратитесь в техподдержку.
h1. Настройка системы и методов отправки
h2. Включение системы отправки сообщений
Для работы системы отправки сообщений, следует включить этот сервис в настройках биллинга
Для этого необходимо перейти в "Управление абонентами и тарифами - настройки - настройки(в файле) - настройки демона отправки сообщений" и выставить флаг в поле "Включить отправку сообщений"
!demon.png|border=1,width=800!
h2. Настойка SMS-шлюза
Вторым шагом будет настройка sms-шлюза.
!0.png|border=1,width=800!
Производим настройку адреса и параметров отправки сообщения
!1.png|border=1,width=600!
За настройку отправки СМС сообщений в Carbon Billing 5 отвечают следующие параметры:
* Тихий час - период времени, когда сообщения не отправляются абонентам.
* Заголовок сообщения - указывается тема письма.
* Адрес СМС шлюза - используется при СМС рассылке.
* Post параметры - параметры для СМС рассылки. %sms%-телефон рассылки, %text% -сообщение.
{note:title=Важно:}
Для настройки отправки смс, у вашего смс шлюза должна быть возможность отправки смс путем вставки запроса в адресную строку браузера
{note}
Пример:
*company* \- название вашей компании
*company123* \- пароль, выданный смс-шлюзом
*79991231122* \- номер для тестовой отправки, на который придет смс
*Тест отправки* \- текст для отправки, указывается без кавычек
Соответственно в строке браузера для тестирования должно быть следующее:
{code}
http://smsc.ru?charset=utf-8&login='company'&psw='company123'&phones=79991231122&mes=Тест отправки
{code}
Соответственно "Адрес СМС шлюза" это то, что {color:#000000}у провайдера шлюза указано{color} {color:#ff0000}слева{color} от символа "?", и "Post параметры СМС шлюза" это то что {color:#ff0000}справа{color}{color:#000000}, при этом переменные{color} {color:#000000}обозначаются как{color} {color:#008000}%(sms)s - номер телефона{color} {color:#008000}и %(text)s - текст сообщения{color}{color:#000000}.{color}
{note}Для того, чтобы корректно работал шаблон сообщений "Отправлять за n дней", необходимо в настройках сообщений оператора связи указать параметр "Предупреждать о лимите за n дней" {note}
h2. Пример оператора смс-шлюза
Вот один из примеров оператора смс-шлюза, который можно настроить в Carbon Billing 5 [http://smsc.ru/|http://smsc.ru/?pp328703/]
*Пример параметров для smsc*
Адрес СМС шлюза:
{code}
http://smsc.ru
{code}
Post параметры:
{code}
charset=utf-8&login='Ваш логин'&psw='Ваш пароль'&phones=%sms%&mes=%text%
{code}
*Пример параметров для Простор СМС*
Адрес СМС шлюза:
{code}
http://gate.prostor-sms.ru/send/
{code}
Post параметры:
{code}
login='Ваш логин'&password='Ваш пароль'&phone=%sms%&text=%text%
{code}
h2. Настройка отправки Email
Для того, чтобы сообщения отправлялись, следует указать "Email для оповещений" в карточке оператора связи.
Например: info@provider.name
h1. Настойка шаблонов сообщений
!2.png|border=1,width=600!
Для каждого типа сообщения надо создать свой шаблон
!3.png|border=1,width=600!
Пример ниже:
Галочка *Отправлять сообщение* отвечает за то нужно отправлять сообщение или нет. Эту галочку можно также поставить в самом шаблоне при редактировании.
h2. Возможные переменные
В шаблонах можно использовать следующие параметры:
%(contract_number)s - номер договора;
%(balance)s - текущий баланс;
Для округления баланса до целого значения используйте параметр %(balance).f
%(currecy)s - валюта сокращение (например руб.);
%(text)s - передаваемый текст (сообщение непосредственно конкретному абоненту);
%(operator_name)s - имя оператора связи(по умолчанию "Лучший провайдер");
%(allow_limit)s - сумма, которая указана в пороге включения(тариф);
%(gen_pwd)s - созданный через админ. панель пароль(не существует, если пароль изменен через ЛК);
%(login)s - логин абонента;
%(tarif_name)s - тариф абонента;
%(plan_comment)s - описание тарифа (например скорость, указывается руками);
%(recomend_pay_sum)5.2f - рекомендуемый платеж
%(recomend_pay_sum_post)5.2f - рекомендуемый платеж постоплата
%(minimal_pay_sum)5.2f - минимальный платеж для разблокировки
А также любые поля абонента, тарифа, счета. Названия переменных можно взять из описания моделей в [CarbonBilling:API REST v2.0]
*Текст заголовка* \- тема e-mail или заголовок смс.
*Текст шаблона* \- непосредственно отправляемый текст.
h2. Тип сообщения. События.
Каждый шаблон сообщения может быть отправлен по любому из выбранных событий:
* *Подключение услуги* \- приходит абоненту при подключении услуги;
* *Положительный баланс* \- приходит абоненту при переходе абонента в положительный баланс(ниже порога отключения абонента);
* *Отрицательный баланс* \- приходит абоненту при переходе абонента в отрицательный баланс(выше порога отключения абонента);
* *Выставлен счет* \- приходит абоненту при выставлении счета абоненту (используется чаще для юр.лиц). Для того, чтобы отправка счета выполнялась вручную из вкладки "Операции", шаблон с данным типом должен быть включен. Вместе со счетом юр.лицам отправляется ещё и акт. Отправка акта выполняется с помощью этого же шаблона сообщений(Выставлен счет);
* *Зачисление денег* \- приходит абоненту при поступлении средств на счет (при условии что в настройках абонента стоят галочки Юр.лицо и Отправлять Счет/Акт, а также Настройки - Число месяца выставления счетов на предоплату);
* *Ручная отправка сообщения* \- при ручной отправке;
* *Занесено в Аудит* \- при занесении информации в Аудит;
* *Достигнут порог предупреждения* \- при достижении порога предупреждения (порог предупреждения из опций тарифа);
* *Сообщение из HelpDesk* \- при создании заявки от абонента в HelpDesk (приходит инженерам Helpdesk);
* *Сообщение из CRM* \- при создании задачи в CRM (приходит ответственному исполнителю).
* *Отправлять за n дней* \- за n дней до даты указанной в карточке абонента в поле "Хватит денег до"
h2. Способы отправки сообщений
В настоящее время поддерживаются 4 способа отправки сообщений пользователям:
!mess3_80.png|border=1!
* Письмо на e-mail;
* SMS сообщение на телефон;
* Всплывающее сообщение в Carbon Agent;
* Передача сообщения по winpopup (редко используется).
Если не выбрать конкретный вид сообщения, то рассылка будет вестись всеми доступными средствами.
h3. Отправитель
Поле отправитель зависит от типа сообщения:
* Если сообщение системное, например у пользователя кончились деньги на счёте, то в поле отправитель будет указан e-mail, принадлежащий Оператору связи.
* Если сообщение отправлялось вручную с помощью веб-интерфейс администратора Carbon Billing 5, то отправителем будет указан e-mail администратора системы, который это сообщение отправил;
* Если данные поля не заполнены, отправителем будет почта вида root@www.example.com, где www.example.com - доменное имя главного внешнего интерфейса.
h1. Отправка сообщений
Для отправки сообщений непосредственно одному из абонентов необходимо зайти в раздел Абоненты, выбрать абонента, вкладка Отправить сообщения. Выбирается метод отправки и выбирается шаблон сообщения. Для отправки произвольного текста, следует создать шаблон с типом *"Ручная отправка"* и текстом шаблона *%(text)s*
h2. Отладка
Логи работы демона отправки сообщений за текущие сутки находятся в файле
{code}/app/asr_billing/var/log/msgd.log{code}
Логи за прошедшие сутки архивируются в этом же каталоге под названием *msgd.log-<date>.gz*