SMS Send

Модуль предназначен для отправки СМС уведомлений о заказе и о смене статуса заказа, как зарегистрированным покупателям, так и администратору (только при заказе, в форме краткого отчета).

По сути модуль предназначен для интеграции вашего магазина на ImageCMS Shop (в редакциях Pro и Premium, от версии 4.10 и выше) со сторонним сервисом epochtasms, по средством которого собственно и осуществляется рассылка сообщений. Следовательно, для функционирования модуля, необходима регистрация, пополнение баланса на сервисе epochtasms, согласно выбранному тарифу и последующая настройка модуля в системе (указание полученных API key).


Модуль является платным. Стоимость модуля, в момент написания статьи, составляет 25$. Приобрести модуль, можно на странице модуля, в маркетплейсе. Подробнее о приобретении модуля - смотрите в пункте "1.1 Покупка модуля".

1. Начало работы с модулем

1.1 Покупка модуля

Для приобретения данного модуля вам необходимо связаться с вашим менеджером или приобрести его в нашем магазине дополнений. Стоимость модуля, в момент написания статьи, составляет 25$.

При условии покупки модуля, мы предлагаем бесплатную установку модуля на ваш магазин. Если вы приобретали модуль через менеджера или через маркетплейс, просим связаться с менеджером и обсудить с ним данный момент.

Внимание!

Установка модуля подразумевает только установку модуля в системе и при этом не подразумевает точных настроек функционала.

Однако, если вам необходимы данные опции, вы можете заказать их у вашего менеджера (услуги будут предоставляться на платной основе). После оплаты заказа модуль будет доступен для скачивания в вашем личном кабинете на imagecms.net.

К началу

1.2. Установка модуля

Рекомендуем заказать установку модуля нашим специалистам - эта услуга является бесплатной при условии, что в системе не содержится сторонних доработок или функционала, который может конфликтовать с данным модулем. Для этого свяжитесь с вашим менеджером.

Однако, если вы желаете самостоятельно установить модуль, руководствуйтесь следующей инструкцией:

Шаг 1: Скачайте архив модуля из вашего личного кабинета на imagecms.net, в разделе “Мои дополнения”:

Внимание!
Перед установкой модуля обязательно создайте полный бекап системы и базы данных.

Шаг 2: Распакуйте содержимую в архиве папку sendsms посредством FTP-клиента на сервер, в директорию \application\modules

Примечание:
После загрузки папки модуля на сервер, проставьте права на папку модуля 755 рекурсивно - на все вложенные файлы и папки.

Шаг 3: Перейдите в админ-профиль к списку модулей

Осуществите переход в админ-профиле “Модули” → “Все модули” → вкладка “Установить модули”:

Шаг 4: Клик по ссылке “Установить”

В открывшемся списке модулей должен отображаться модуль “SMS Send”, необходимо осуществить клик по ссылке "Установка" напротив данного модуля:


После этого начнется автоматический процесс установки, во время которого модуль автоматически пропишет новые таблицы в базе данных и создаст поля в админ-профиле.

Примечание:
Если после загрузки папки в директорию \application\modules модуль не отображается в списке, то: Попробуйте очистить кеш из админ-панели и обновить список модулей, доступных для установки Проверьте права на папку модуля - права должны быть 755 рекурсивно - на все вложенные файлы и папки.

Шаг 5: После завершения установки - очистите кеш из админ панели

К началу

1.3. Модуль в админ-профиле

Изначально, модуль находится в списке модулей: "Модули" - "Все модули" - "SMS Send":

Если у вас установлен данный модуль, но он не отображается в выпадающем меню, вам необходимо выбрать пункт главного меню пользователя "Модули", а в нем - подпункт "Все модули".

Далее, из открывшегося списка надо выбрать "SMS Send". Чтобы вывести модуль в список выпадающего меню, нужно перевести графический переключатель напротив данного модуля в положение "Активно" (колонка - “Показывать в меню”).

К началу

1.4. Модуль на сервере

К началу

Все файлы модуля физически находятся на сервере в папке sendsms, которая должна находится в директории \application\sendsms:

1.5. Модуль в базе данных

После инсталляции, модуль создает необходимую для работы таблицу в базе данных. Это таблица mod_sendsms которая состоит из колонок:

  • id - колонка, которая содержит уникальный идентивикатор шаблона уведомления;
  • locale - колонка, которая данные о локали шаблона сообщения, например ua или ru;
  • settings - содержит непосредственно сам текст шаблона сообщения, в кодированом виде.

Также модуль создает строку в таблице components - в данной строке содержатся настройки модуля в админ профиле и полученные API key от epochtasms

К началу

1.6. Гарантии разработчиков

Пользователям ImageCMS, которые приобрели модуль “SMS Send”, мы, как разработчики данного продукта, предоставляем гарантию на данный функционал сроком на 1 месяц в следующем порядке:

  • При приобретении модуля через менеджера и установке модуля нашими специалистами - гарантия предоставляется на 30 дней с момента завершения интеграции и принятия клиентом работ.
  • При приобретении модуля через маркетплейс и самостоятельной установке - гарантия предоставляется на 30 дней с момента покупки модуля.
Внимание!

Гарантия не распространяется и не покрывает следующего:

  • Исправления ошибок, допущенных администратором при самостоятельной установке и администрировании модуля.
  • Проблем и ошибок в работе модуля, которые возникли из-за правки модуля сторонними специалистами.
  • Проблем, возникающих из-за несоответствия хостинга требованиям системы. Исправление ошибок и конфликтов, которые вызваны:
    • Сторонними сервисами и дополнениями, установленными на сайте.
    • Индивидуальными доработками стандартного функционала и/или шаблона.

Также гарантия, как таковая, не покрывает проблем и ошибок, вызванных изменениями в работе рассылки со стороны ePochta - в таких случаях решение проблемы предоставляется через обновление модуля (или индивидуальной правкой, на платной основе)

В случае обнаружения ошибки, исправление которой не описано в данном документе, просим создать отдельное обращение в службу тех поддержки, при этом четко описав проблему и предоставить пошаговую инструкцию для воссоздания проблемы.

К началу

2. Настройки модуля

Настройки модуля SMS Send распределены по нескольких функциональных элементах, доступных в форме модуля. При осуществлении настроек, рекомендуем придерживаться порядка, описанного в документации

2.1.Параметры - настройка подключения к сервису epochtasms

Кнопка “Параметры” находится в верхнем правом углу окна:

После клика по ней - откроется всплывающее окно, содержащее следующее поля:

  • API key private - поле, для указания приватного ключа
  • API key public - поле, для указания публичного ключа
  • Название компании - в данное поле, подтягивается название, предварительно созданное на стороне сервиса ePochta

Примечание:

API key private и public - необходимо предварительно создать в личном кабинете ePochta

Подробную информацию, по созданию API key - ищите в документации ePochta

К началу

2.2. Регистрация Имени - настройка информации об отправителе

Кнопка “Регистрация имени”, так же находится в верхнем правом углу окна:

После клика по ней - откроется всплывающее окно, содержащее следующее поля:

  • Отправитель - поле, в котором следует указать дназвание магазина, или имя, от которого будут проходить смс оповещения (настройка необходимая для функционарования модуля)
  • Страна Отправителя - поле, в котором, из выпадающего списка необходимо выбрать страну, в которой зарегистрирован и осуществляет деятельность магазин (настройка необходимая для функционарования модуля)
Внимание!
Без настройки в поле "Отправитель" - модуль работать не будет.

К началу

2.3. Журнал

В настройках модуля доступна вкладка “Журнал” - в последующем, после настроек ,запуска и функционирования модуля, на даной вкладке будет отображаться краткий отчет об отправленных смс сообщениях.

К началу

3. Работа с модулем

Под работой с модулем, подразумевается настройка шаблонов уведомлений как покупателям, так и для администратора. Все эти настройки находятся на вкладке “Параметры”:

Также, на вкладке “Параметры”, после подключения необходимых API и пополнения - будет отображен ваш текущий баланс:

3.1. Шаблон сообщения при заказе (покупателю)

Создать шаблон уведомления для покупателя, при совершении заказа, можно в поле "Шаблон сообщения при заказе":

При создании шаблона, вы можете использовать обычный текст, так и переменные, которые будут подтягивать в сообщение соответствующие данные:

  • %id% - ID заказа
  • %user_id% - Идентификатор пользователя
  • %key% - Ключ заказа
  • %user_full_name% - Имя пользователя
  • %user_email% - E-mail пользователя
  • %user_phone% - Телефон пользователя
  • %user_deliver_to% - Адрес доставки
Примечание:

Просим учесть, что фактических ограничений по количеству символов нет (сам шаблон сообщения может содержать произвольное количество знаков), однако рекомендуем придерживатся примерного размера (для уже готового, с выведенным значением переменных в тексте сообщения):

  • на кириллице - 70 символов;
  • на латинице - 160 символов.

В случае, если размер готового сообщения будет превышен - сервисом рассылки, оно расценено как два смс сообщения

Создать сообщение с вложенным файлом - возможности нет

К началу

3.2. Шаблон сообщения при смене статуса заказа (покупателю)

Создать шаблон уведомления для покупателя, при изменении статуса заказа, можно в поле "Шаблон СМС при смене статуса заказа":

При создании шаблона, вы можете использовать обычный текст, так и переменные, которые будут подтягивать в сообщение соответствующие данные:

  • %id% - ID заказа
  • %user_id% - Идентификатор пользователя
  • %key% - Ключ заказа
  • %user_full_name% - Имя пользователя
  • %user_email% - E-mail пользователя
  • %user_phone% - Телефон пользователя
  • %user_deliver_to% - Адрес доставки
  • %order_status% - Статус заказа
Примечание:

Просим учесть, что фактических ограничений по количеству символов нет (сам шаблон сообщения может содержать произвольное количество знаков), однако рекомендуем придерживатся примерного размера (для уже готового, с выведенным значением переменных в тексте сообщения):

  • на кириллице - 70 символов;
  • на латинице - 160 символов.

В случае, если размер готового сообщения будет превышен - сервисом рассылки, оно расценено как два смс сообщения

Создать сообщение с вложенным файлом - возможности нет.

К началу

3.3. Шаблон сообщения при заказе для администратора

Для отчетности, администратор может создать шаблон смс уведомления, которое будет оповещать его о создании нового заказа. Согдать данный шаблон можно в поле “Шаблон сообщения при заказе для администратора”:

При создании шаблона, вы можете использовать обычный текст, так и переменные, которые будут подтягивать в сообщение соответствующие данные:

  • %id% - ID заказа
  • %user_id% - Идентификатор пользователя
  • %key% - Ключ заказа
  • %user_full_name% - Имя пользователя
  • %user_email% - E-mail пользователя
  • %user_phone% - Телефон пользователя
  • %user_deliver_to% - Адрес доставки
Примечание:

Для того, чтобы оповещение смс администратора работало - необходимо также:

  • В ячейке "Отправлять уведомление администратору" - определить значение "выбрано";
  • В поле "Телефон администратора" - указать номер мобильного телефона администратора, в международном формате.

К началу

3.4. Перевод шаблонов

Если вы используете мультиязычный магазин, на ImageCMS Premium, вы можете осуществиь перевод шаблонов сообщений при помощи кнопки переключения языков, в верхнем правом углу формы:

К началу

4. Частые вопросы

Ошибка Wrong public key в разделе Регистрация Имени (данные об отправителе)

Подобная ошибка свидетельствует о том, что не указаны API key (private и public) в разделе “Параметры”. Данная настройка должна быть первостепенной

Покупатель не получил СМС, средства с баланса списаны

Скорее всего, при оформлении заказа, пользователь указал некорректный или стационарный номер. В таком случае, смс ему будет отправлено, т.к. фильтры номеров, в сервисе ePochta не предусмотрены.

Статистика по рассылкам будет доступна в личном кабинете на сайте ePochta

Для получения более подробной информации, просим обратиться к службе тех поддержки ePochta

Можно ли добавлять в шаблон смс сообщения дополнительные объекты?

К сожалению подобной технической возможности, прикреплять к смс сообщению файлы (картинку, счет и т.д.) - нет.

К началу