SMS-ассистент — документация для разработчиков
ИНТЕГРАЦИЯ С ДРУГИМИ СЕРВИСАМИ
Интеграция с МойСклад
ИНТЕГРАЦИЯ ВОЗМОЖНА ТОЛЬКО ДЛЯ РЕЗИДЕНТОВ РЕСПУБЛИКИ БЕЛАРУСЬ
Подключение, если у вас ЕЩЁ НЕТ аккаунта в сервисе SMS-ассистент
1
В вашем аккаунте в МоёмСкладе в правом верхнем углу выберите раздел «Приложения»:
2
Найдите приложение «Сервис рассылок SMS-assistent.by» и нажмите кнопку [Установить]:
3
В открывшемся модальном окне нажмите кнопку [Установить] ещё раз:
4
Нажмите кнопку [Настроить]:
5
На следующем шаге на вкладке «Подключение» в пункте «Подключение, если у вас ЕЩЁ НЕТ аккаунта в сервисе SMS-ассистент», введите ваши данные и нажмите кнопку [Активировать демо-режим]:
Заявки обрабатываются в рабочее время клиентской поддержки. При указании несуществующего/недействующего УНП, или УНП компании, которая находится в стадии ликвидации, а также некорректных телефона и/или e-mail, в регистрации будет отказано
6
После нажатия кнопки [Активировать демо-режим] появится следующее уведомление:
7
Подождите нескольких минут и нажмите кнопку [Обновить]. Если ваш запрос на активацию демо-режима обработался корректно, то вы увидите следующее сообщение:
8
В течение максимум 30 минут в рабочее время клиентской поддержки вам будет создан аккаунт в системе SMS-ассистент с 10 бесплатными SMS, и на указанный вами контактный телефон придёт SMS с логином и паролем для входа в ваш аккаунт:
9
Получение такого SMS говорит о том, что для вас создан демо-аккаунт. Нажмите «Обновить»:
10
Вы увидите информацию по вашему аккаунту в сервисе SMS-ассистент и это означает, что подключение готово:
Подключение, если у вас УЖЕ ЕСТЬ аккаунт в сервисе SMS-ассистент
Для начала вам необходимо зайти в ваш личный кабинет сервиса SMS-ассистент (логин и пароль отправлялись вам при регистрации на телефон в виде SMS). Если вы забыли ваши персональные данные, то вы можете их восстановить. Для этого на странице авторизации в программу воспользуйтесь опцией «Забыли логин и/или пароль?».
1
Активируйте API, как описано здесь.
2
Проверьте регистрацию вашего имени отправителя, как описано здесь.
В «МоёмСкладе» вы также сможете увидеть список доступных для использования имён отправителя (альфа-имён). Сделать рассылку можно будет только с ними.
В «МоёмСкладе» вы также сможете увидеть список доступных для использования имён отправителя (альфа-имён). Сделать рассылку можно будет только с ними.
3
Настройте безопасность, как описано здесь.
4
В разделе «Мои настройки» → вкладка «Интеграция» → блок «Интеграция с сервисом „МойСклад“» сгенерируйте токен для доступа к API sms-assistent.by:
5
В вашем аккаунте в МоёмСкладе в правом верхнем углу выберите раздел «Приложения»:
6
Найдите приложение «Сервис рассылок SMS-assistent.by» и нажмите кнопку [Установить]:
7
В открывшемся модальном окне нажмите кнопку [Установить] ещё раз:
8
Нажмите кнопку [Настроить]:
9
На следующем шаге на вкладке «Подключение» в пункте «Подключение, если у вас УЖЕ ЕСТЬ аккаунт в сервисе SMS-ассистент», введите сгенерированный токен для доступа к API sms-assistent.by и нажмите кнопку [Сохранить]:
10
Вы увидите информацию по вашему аккаунту в сервисе SMS-ассистент и это означает, что подключение готово:
Использование двух способов отправки SMS из сервиса «МойСклад»
Отправить SMS из МоегоСклада можно двумя способами:
- В ручном режиме через карточку контрагента, заказа покупателей или отгрузки.
- В автоматическом режиме при наступлении события в сервисе «МойСклад», например, при создании документа или при изменении его статуса.
Отправка SMS в ручном режиме
Приведён пример для отправки SMS из карточки заказа покупателей. Из карточки контаргента или отгрузки отправка происходит аналогичным образом
1
Зайдите в заказ покупателя и проделайте следующие шаги:
2
В случае успешной отправки сообщения, вы получите уведомление: «Сообщение успешно отправлено»
3
В случае ошибки отправки SMS, вы получите уведомление с описанием ошибки
Отправка SMS в автоматическом режиме при наступлении события
Существует возможность автоматически отправлять SMS при наступлении двух событий:
- Создании документа
- Изменении статуса документа
чёрный — обязательные параметры
серый — необязательные параметры
1
Настройка находится в разделе «Приложения» → «Сервис рассылок SMS-assistent.by» на вкладке «Настройка автоматической отправки SMS». Для создания настройки необходимо нажать [Создать настройку]:
1
Ниже описаны все поля, которые используются при создании/редактировании настройки для автоматической отправки SMS:
Наименование
Введите наименование настройки для вашего удобства
Активность
Если установлена данная галочка, то будет выполняться автоматическая отправка SMS согласно сделанным настройкам
Реакция на
На данный момент доступны документы:
- Заказ покупателя
- Отгрузка
- Счет покупателя
- Заказ поставщика
- Счет поставщика
- Приемка
- Приходный ордер
- Входящий платеж
- Расходный ордер
- Исходящий платеж
Действие
Создание — означает, что отправка SMS будет происходить при создании документа
Изменение статуса — означает, что отправка SMS будет происходить при изменении статуса документа
Изменение статуса — означает, что отправка SMS будет происходить при изменении статуса документа
На статус
Если выбран статус документа, то это является дополнительным условием для срабатывания автоматической отправки SMS. Например, при реакции на создание документа будет отправляться SMS только в том случае, если у созданного документа будет указан статус такой же, как в этом поле, а при реакции на изменение статуса документа, SMS будет отправлено только в том случае, если статус документа изменится на тот, который указан в этом поле
Дополнительно учитывать наличие следующих значений в дополнительных полях документа
Из документа вы сможете использовать для настроек автоматической отправки SMS три вида пользовательских поля:
В настройках документа они выглядят так:
- Тип «Справочник» служебный. Выбираются данные из служебного справочника [Сотрудники].
- Тип «Справочник» пользовательский. Выбираются данные из созданного вами справочника.
- Тип «Строка».
В настройках документа они выглядят так:
Выставляя в настройке нужные параметры дополнительных полей, для срабатывания автоматической отправки SMS будет также учтено совпадение данных документа с параметрами, выставленными вами в настройке
Изменить статус на
Если после создания рассылки SMS вам необходимо автоматически изменить статус документа, то выберите здесь статус, на который нужно его изменить. Статус будет меняться только в том случае, если рассылка корректно создалась
Отправитель
Подтягивается из вашего личного кабинета SMS-ассистента. Как проверить какие имена отправителей доступны смотрите здесь
Телефон получателя
Возможно использовать четыре варианта телефонов получателей или сочетания их, указанные через запятую:
- Телефон контрагента из документа. Для этого пропишите в это поле тег: {tel}
- Телефон сотрудника, указанного в документе. Для этого пропишите в это поле тег: {tel_user}
- Фиксированный номер телефона. Для этого пропишите в это поле номер телефона, обязательно с кодом мобильного оператора. SMS будут приходить только на этот номер
- Телефон, прописанный в дополнительном поле. Для этого пропишите в это поле тег: {doc_param.string.Наименование_поля}
Отложенная отправка
Применяется в том случае, если необходимо отправить SMS не сразу после наступления события, а через определённое время. Для этого вам необходимо активировать настройку и указать количество дней, через которые будет отправлено SMS и время, когда будет отправлено SMS
Шаблон SMS
Если в личном кабинете SMS-ассистента у вас есть заранее созданные шаблоны SMS, то вы можете вставить текст одного из них, выбрав нужный вам шаблон из списка
Текст сообщения
Введите текст сообщения. В текст сообщения возможно вставить различные теги, с помощью которых в текст SMS будут автоматически подставляться данные соответствующих полей из МоегоСклада. Доступные теги для подстановки указаны под этим полем.
Обратите внимание на подсчёт символов и количество SMS. Оно отображается в режиме реального времени при наборе текста SMS
Обратите внимание на подсчёт символов и количество SMS. Оно отображается в режиме реального времени при наборе текста SMS
2
После создания настройки, вы можете её изменить или удалить:
Экспорт данных контрагентов из «МоегоСклада» в «SMS-ассистент»
Для использования полного функционала сервиса SMS-асистента при массовых рассылках и для дальнейшего полноценного анализа отправленных SMS, целесообразнее сделать копию ваших контактов из МоегоСклада в SMS-ассистент, и производить рассылку непосредственно из личного кабинета SMS-ассистента. Для этого на вкладке «Экспорт данных»:
1
Выберите группу адресной книги, предварительно созданную в сервисе SMS-ассистент. Все контрагенты будут скопированы в неё. Если вам необходимо «разнести» ваших контрагентов по разным группам по определённому полю в МоёмСкладе, например, по статусу, то на этом этапе выберите любую группу, а в п.3 укажите по какому полю в МоёмСкладе необходимо определять или создавать группы
2
Выберите вариант проверки на дубликаты:
- Проверить на дубликаты после импорта «вручную» — в этом случае проверка на повторяющиеся номера осуществляться не будет, будут импортированы все корректные номера телефонов контрагентов
- Добавить только новых абонентов (проверка по группе, в которую импортируются абоненты) — если у вас в группе ещё нет абонентов, то из файла будет добавлена каждый первый уникальный номер телефона. Если в группе абоненты есть, то в неё будут добавлены только новые номера телефонов
- Добавить только новых абонентов (Проверка по всей Адресной книге) — если у вас в адресной книге ещё нет абонентов, то из файла будет добавлена каждый первая новый телефон. Если в Адресной книге абоненты есть, то в неё будут добавлены только новые номера телефонов
- Обновить абонентов — при нахождении в группе абонента с таким же номером, как импортируемый, данные по этому абоненту будут обновлены
3
При необходимости импортирования не только номеров телефона, но и других данных контрагента из МоегоСклада, необходимо заполнить «Необязательные настройки экспорта». Можно заполнять любое количество полей:
Ещё в этом разделе