Сервис голосовых рассылок

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

Умный робот стоит дешевле менеджера в десятки раз, а еще он гораздо быстрее – робот может обзвонить 1000 клиентов всего за пару минут.

Еще одно преимущество — посекундная тарификация звонков. Это значит, что, пользователь платит только за то время, которое клиент провел на линии. А тратиться на недоставленные сообщения больше не придется!

Робот способен поддерживать диалог с человеком: генерировать и распознавать речь, дожидаться окончания ответа и реагировать на тишину.

И хотя умный робот — это сложная программа, пользователю не потребуются знание программирования: благодаря удобному интерфейсу, рассылку можно настроить за пару минут. Сервис предназначен только для выполнения бизнес-задач: он не подходит для удовлетворения личных нужд, розыгрышей или мошенничества.

Начало работы

Авторизация
Регистрация
Восстановление пароля

Работа с рассылками

Раздел "Рассылки"
Создание рассылки
Добавление голосового меню
Изменение важных настроек рассылки
Просмотр отчета по рассылке

Работа с аудиороликами

Раздел "Аудиоролики"
Создание аудиоролика

Работа с базами номеров

Раздел "Базы номеров"
Создание базы номеров
Создание базы номеров с переменными

Работа с шаблонами

Пресеты вебхуков
Создание пресета вебхука
Шаблоны рассылок
Создание шаблона рассылки
Шаблоны API
Создание API шаблона
Шаблоны СМС
Создание шаблона СМС

Работа с API и интеграциями

Таблица звонков
Таблица звонков по шаблону
Инструкция по API-интеграции
Эмулятор запросов
Верификационные звонки

Раздел "Помощь"
Раздел "Бонусы"
Дополнительные разделы сервиса

Раздел "Счета"
Раздел "Номера телефонов"
Раздел "Промокоды"
Раздел "Платежи"
Раздел "Черный список"
Раздел "Проверка IP"

Раздел "Профиль"

Начало работы

Для начала работы необходимо пройти страницу Авторизации, либо Зарегистрировать новый аккаунт

Начало работы

Авторизация

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

Вход в личный кабинет

 
Элементы страницы “Вход в личный кабинет”:

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

E-mail
Поле Email — обязательное для заполнения поле, в которое необходимо ввести электронный адрес, указанный при регистрации.
 
Пароль
Поле Пароль — обязательное для заполнения поле, в которое необходимо ввести пароль, указанный при регистрации.
 
Забыли пароль?
Если по какой-то причине Вам не удается ввести верный пароль от личного кабинета на сервисе, для его восстановления нужно нажать на кнопку “Забыли пароль?”. Далее откроется страница “Восстановления пароля”.

Успешная авторизация

Если данные в полях Email и Пароль введены верно (либо авторизация через VK прошла успешно) — откроется Ваш личный кабинет.

Неуспешная авторизация

Если при вводе данных допущена ошибка или пользователь с такими данными еще не зарегистрирован в системе, появится ошибка “Неправильный логин или пароль”.

Начало работы

Регистрация

Это действие, направленное на создание личного кабинета на сервисе. Для начала регистрации Вам нужно нажать кнопку “Регистрация” на начальной странице сервиса. Далее откроется страница “Регистрация”.

Элементы страницы “Регистрация”:

Зарегистрироваться с помощью
VK
Регистрация с VK — при нажатии на иконку Вы будете перенаправлены на страницу подтверждения доступа к аккаунту VK. После этого автоматически будут получены Email и номер телефона, указанные в профиле VK.

E-mail
Поле Email — обязательное для заполнения поле, в которое необходимо ввести Ваш электронный адрес, который впоследствии также будет являться Вашим логином.
 
Номер телефона
Поле Номер телефона — обязательное для заполнения поле, в которое необходимо ввести Ваш номер телефона.
 
Пароль
Поле Пароль — обязательное для заполнения поле, в которое необходимо ввести придуманный Вами пароль.
Также Вы можете автоматически сгенерировать пароль, нажав на кнопку "Сгенерировать пароль". При нажатии на кнопку сгенерированный пароль сразу же будет скопирован в буфер обмена.
 
Вход
Если регистрация была пройдена ранее и теперь Вам необходимо войти в личный кабинет, для авторизации нужно нажать кнопку “Вход”. Далее откроется страница “Вход в личный кабинет”.
 
Договор оферты и политика конфиденциальности
Регистрируясь, Вы соглашаетесь с условиями оферты и политикой конфиденциальности. Для ознакомления со всеми условиями нажмите на гиперссылку “Договор оферты” или "Политика конфиденциальности" под кнопкой "Сгенерировать пароль".

Успешная регистрация

Если данные в полях Email, Номер телефона и Пароль введены корректно (или авторизация с помощью VK прошла успешно) — откроется Ваш личный кабинет.

Неуспешная регистрация

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

Начало работы

Восстановление пароля

Это действие, направленное на восстановление пароля от личного кабинета на сервисе. Для восстановления пароля Вам нужно нажать кнопку “Забыли пароль?” на странице авторизации сервиса. Далее откроется страница “Восстановление пароля”.

 
Элементы страницы “Восстановление пароля”:

Введите Ваш E-mail
Поле Email — обязательное для заполнения поле, в которое необходимо ввести электронный адрес, указанный при регистрации.
 
Войти
Если регистрация пройдена ранее и Вам необходимо войти в личный кабинет, для авторизации нужно нажать кнопку “Войти”. Далее откроется страница “Вход в личный кабинет”.
 
Зарегистрироваться
Если личного кабинета на сервисе нет, для его создания нужно нажать на кнопку “Зарегистрироваться”. Далее откроется страница “Регистрация”.

Успешный запрос на восстановление пароля

Если данные введены верно, то на указанный Email придет письмо со ссылкой на восстановление пароля.

Неуспешный запрос на восстановление пароля

Если при вводе данных допущена ошибка, либо пользователь с такими данными еще не зарегистрирован в системе, то появится ошибка “Пользователь с таким Email-ом не найден [Введенный email]”.

Работа с рассылками

Раздел "Рассылки"

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

Поиск рассылок

Строка поиска позволяет искать рассылки на сервисе по отдельным параметрам:

ID/№ рассылки;
Название рассылки.

Создать рассылку

При нажатии кнопки "Создать рассылку" открывается страница создания рассылки. На данной странице Вы можете настроить рассылку так, как Вам необходимо и запустить ее.

Фильтры

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

Таблица рассылок

Таблица предназначена для просмотра отчета и выполнения различных действий с любой из созданных рассылок.

Номер

ID/№ созданной рассылки. Для упрощения поиска, и, впоследствии, ускорения решения вопроса оператор может запросить его у Вас.

Дата создания

Дата и время создания рассылки. После даты также отображается её ID/№. Время указано по часовому поясу Вашего личного кабинета, проверить/изменить часовой пояс Вы можете в разделе “Профиль”.

Название

Название созданной рассылки. Ниже отображаются функции, использованные в рассылке (теги рассылки):

Тег: Распознавание — в рассылке использовался тип голосового меню (IVR) - “Слова” (анализ ответов абонента);
Тег: Умная — в рассылке использовалась функция “Умная рассылка”. Число в квадратных скобках (например: [1], [2] и т. д.) указывает на конкретную часть умной рассылки;
Тег: Без CallerId — в рассылке использовалась маршрутизация "Карусель номеров" (тип маршрутизации, при котором система автоматически выбирает номер из пула для каждого звонка без подстановки единого исходящего номера)
Тег: Сгенерированный текст — в рассылке в качестве основного аудиоролика использовался синтез речи (компьютерное озвучивание текста);
Тег: С аудиофайлом — в рассылке в качестве основного аудиоролика использовался загруженный аудиофайл;
Тег: С записью — в рассылке использовалась функция “Записывать разговоры”;
Тег: С интервалом — в рассылке использовалась функция “Ограничить время и дни рассылки”.

Статус

Текущий статус созданной рассылки. Для его обновления необходимо обновить таблицу рассылок, нажав на кнопку “Поиск”, или произвести полное обновление страницы “Рассылки”.

На модерации — рассылка находится на модерации, происходит проверка на наличие запрещенных тематик;
На уточнении — рассылка еще не прошла модерацию, текст рассылки согласуется с руководством;
Принята — рассылка прошла модерацию и вскоре звонки начнут совершаться, а рассылка перейдет в статус “В процессе”;
В процессе — рассылка запустилась, звонки начали совершаться;
Закончена — рассылка закончена, все звонки завершены;
Запланирована — рассылка запланирована и запустится автоматически в указанное время (дата и время старта отображены в столбце "Время начала");
На паузе — рассылка поставлена на паузу вручную или системой автоматически, совершение звонков приостановлено;
Пауза — вне временного интервала — рассылка не попадает во временной диапазон, установленный в функции "Ограничить время и дни рассылки". Рассылка будет запущена в следующие часы/дни, попадающие под установленные настройки.
Остановлена — рассылка полностью остановлена, звонки больше не совершаются;
Отклонена — рассылка была отклонена в момент проверки. В столбце “Комментарий” красным цветом указана причина отклонения рассылки;
Ошибка — рассылка не была создана из-за неизвестных ошибок при её запуске.

Время начала

Время и дата, когда рассылка началась или должна будет начаться.
В случае запланированной рассылки — отображается дата и время планирования по часовому поясу, указанному в Вашем личном кабинете.
В случае автоматической паузы рассылки — отображается комментарий "Пауза - вне временного интервала". Рассылка будет запущена в следующие часы/дни, попадающие под настройки функции "Ограничить время и дни рассылки".

Размер

Статистика по рассылке: Количество номеров в телефонной базе рассылки / количество номеров в стоп-листе / количество ответивших номеров / количество лидов / количество неответивших номеров / количество номеров в процессе на звонок.

Скорость рассылки

Количество звонков в час, поступающих на номера из базы.

Стоимость

Стоимость рассылки на текущий момент.

Комментарий

Созданный комментарий к рассылке:

Черным цветом отображены комментарии, созданные Вами;
Красным цветом отображены системные комментарии, обычно это комментарии с причиной отклонения рассылки.

Отчет и управление рассылкой

Кнопки дополнительных действий:

Отчет — открывает новую страницу с подробной информацией по выбранной рассылке;
Отменить последнюю умную рассылку — отменяет только последнюю часть умной рассылки;
Отменить все умные рассылки — отменяет все последующие части умных рассылок — повторные звонки на номера, которые не ответили в основной рассылке не будут совершены;
Освободить номер — освобождает исходящий номер от рассылки. После освобождения номера на него не получится перезвонить и прослушать сценарий рассылки повторно;
Прослушать записи — открывает диалоговое окно, в котором возможно прослушать все аудиоролики в выбранной рассылке;
Скачать записи — скачивает все записи звонков по выбранной рассылке (актуально при использовании функции "Записывать разговоры");
Комментарий — открывает диалоговое окно, в котором возможно указать комментарий для выбранной рассылки;
Скопировать — копирует все параметры и базу номеров по выбранной рассылке в новую рассылку с возможностью редактирования настроек перед запуском;
Умное копирование — копирует все основные параметры, без учета номеров на которые был совершен успешный звонок по выбранной рассылке (в том числе без учета перезвонивших), в новую рассылку, с возможностью редактирования настроек перед запуском;
Изменить время отправки — открывает диалоговое окно, в котором возможно выбрать новую дату и время для старта рассылки (актуально при использовании функции "Запланировать рассылку" и статусе рассылки "Запланирована");
Изменить скорость — открывает диалоговое окно, в котором возможно выбрать другую скорость для рассылки (актуально при статусе рассылки "На паузе");
Пауза — приостанавливает рассылку. Снова запустить рассылку Вы можете нажав на кнопку “Старт“;
Старт — возобновляет рассылку, находящуюся в статусе “На паузе”;
Стоп — остановка рассылки, без возможности возобновить ее;
Удалить — удаление рассылки, без возможности её восстановления.

Работа с рассылками

Создание рассылки

Страница необходима для создания рассылки и настройки ее параметров.

Для создания рассылки достаточно:

Добавить базу номеров, на которые будут совершены вызовы;
Добавить аудиоролик для рассылки;
Добавить голосовое меню (необязательно, но тогда ответы абонентов фиксироваться не будут).

Добавление базы номеров для рассылки

Для загрузки базы номеров доступно три источника:

Буфер обмена

С помощью данного источника Вы можете вставить номера телефонов из буфера обмена.

Номера должны быть в формате +7(xxx)xxx-xx-xx, 7xxxxxxxxxx , 80000000000 или 8(000)000-00-00 и располагаться друг под другом.
Если система обнаружит некорректные номера, отобразится ошибка “Неверный формат номеров (Очистить)” — при нажатии на слово “Очистить”, Вы можете удалить некорректные номера в открывшемся диалоговом окне.

Ручной ввод

С помощью данного источника Вы можете ввести номера вручную. Если нужно добавить больше одного номера, нажмите на кнопку “Добавить номер телефона”. Для удаления введенного номера, нажмите на знак “Корзина” рядом с введенным номером.

База

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

Выбрать ранее созданную базу номеров в выпадающем списке (из раздела “Базы номеров”);
Добавить базу номеров. При нажатии кнопки откроется диалоговое окно “Создание базы номеров”;
Выбрать отдельные номера для выбранных баз. При нажатии на кнопку откроется диалоговое окно “Фильтрация баз номеров”, с помощью которого Вы можете отфильтровать номера базы по определенным регионам или часовым поясам;
Вычесть базы. При нажатии на кнопку откроется выпадающий список, в котором Вы можете выбрать базу для исключения ее из рассылки;
Добавить номера к базам. При нажатии на кнопку, откроется поле, в которое Вы можете вставить дополнительные номера к уже готовой базе через буфер обмена.

Добавление аудиоролика для рассылки

Для добавления аудиоролика доступно четыре источника:

Источник аудиоролика “Текст”

Благодаря данному источнику Вы можете создать аудиоролик просто набрав текст.

По умолчанию аудиоролик будет воспроизводиться мужским голосом. Голос можно поменять на женский — для этого в поле “Голос” нужно изменить значение на “Ж”, кликнув на переключатель.

При нажатии на кнопку “Прослушать предварительно” формируется аудиоролик, который можно прослушать и скачать.

Источник аудиоролика “Микрофон”

Данный источник позволит Вам создать аудиоролик, записав его с помощью микрофона на компьютере или с помощью гарнитуры.

После нажатия на кнопку “Начать запись” в всплывающем окне браузера необходимо разрешить использование микрофона.

Источник аудиоролика “Аудиофайл”

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

Поддерживаемый формат файлов: mp3, m4a, ogg.

Источник аудиоролика “Сохраненные”

Используя данный источник, Вы можете выбрать ранее созданный аудиоролик (из раздела “Аудиоролики”). Для выбора аудиоролика необходимо выбрать искомый аудиоролик из выпадающего списка.

Рядом с прошедшими модерацию аудиороликами присутствует пометка "(отмодерировано)".

Запуск рассылки

После того как Вы добавили базу номеров и аудиоролик для рассылки, Вы можете ее запустить, нажав на кнопку “Запустить рассылку”.

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

В случае, когда необходимо настроить или изменить дополнительные параметры рассылки (к примеру изменить исходящий номер или настроить запланированную рассылку), Вам нужно нажать на кнопку “Показать важные настройки”. Подробнее с важными настройками рассылки Вы можете ознакомиться в разделе “Изменение важных настроек рассылки”.

Работа с рассылками

Добавление голосового меню

Для создания сценария голосового меню (IVR) Вам необходимо нажать на кнопку “Добавить голосовое меню“. После нажатия откроется редактор сценария с автоматически созданными блоками.

Создание сценария

Для редактирования или добавления нового блока голосового меню достаточно:

Выбрать тип голосового меню;
Выбрать ключевую цифру/слово;
Указать действие для блока голосового меню.

Выбор типа голосового меню

Существует 2 типа голосового меню:

Цифры

При выборе данного типа голосового меню алгоритм будет срабатывать после нажатия на цифру в тоновом режиме. Для выбора необходимой цифры Вам нужно нажать на нее в выпадающем списке.

Нажать на цифру абонент может в любой момент воспроизведения аудиоролика.

При активации опции “Оставаться на линии” алгоритм будет воспроизведён вне зависимости от того, совершил действие абонент или нет — после завершения времени на распознавание ответа (7 секунд).

Слова

Для распознавания конкретных слов, которые сказал абонент в звонке, Вам необходимо вписать эти слова в поле “Ключевые слова”, чтобы они были зафиксированы в статистике, а также для того, чтобы после распознавания этих слов сработал алгоритм.

Важно! Распознавание слов, в отличие от нажатия на цифру в тоновом режиме, начинается только после завершения воспроизведения аудиоролика

Существуют готовые шаблоны для автозаполнения ключевых слов — для их использования нажмите на кнопку “Согласие”, “Отказ”, “Перезвонить” или “Автоответчики".
Максимальное количество символов — 500.
Для ввода собственных ключевых слов используйте кириллицу.
Все числа необходимо указывать цифрами.
При добавлении группы ключевых слов через буфер обмена используйте символы «. , ; | \ /» для разделения.

При активации опции “Любое слово” алгоритм будет воспроизведён вне зависимости от того, были ли распознаны ключевые слова после завершения времени на распознавание ответов. Все, что сказал абонент за время распознавание ответа (7 секунд) будет зафиксировано в отчете по рассылке.

Выбор действия для блока голосового меню

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

Аудиоролик

После ответа абонента будет воспроизведен указанный аудиоролик. Способы его загрузки аналогичны способам добавления аудиоролика при создании рассылки.

Звонок менеджеру

После ответа абонента звонок будет переведён на введенный Вами номер в поле “Телефон менеджера для звонка”.

Также реализована возможность добавления ролика для менеджера — при его добавлении перед соединением с абонентом менеджеру будет проигран ролик. Способы его загрузки аналогичны способам добавления аудиоролика при создании рассылки.
Это удобно в том случае, если менеджеру поступают звонки из разных источников. Стоит учитывать, что клиент будет ожидать на линии в течение проигрывания аудиоролика для менеджера.

С момента переключения звонка на менеджера тарификация ведется в двойном объеме, поскольку создается дополнительное соединение.

Отправить СМС

После ответа абонента ему будет отправлено СМС-сообщение. Можно использовать как уже созданный шаблон СМС, так и ввести текст СМС вручную.

Отправить email

После ответа абонента Вам будет отправлено письмо на Email. Информация по каждому абоненту, совершившему целевое действие в голосовом меню, будет отправлена отдельным письмом.

Внутри блока голосового меню Вы можете указать:

Email, куда должны прийти все письма / переменную из базы, в которой указан email, куда должно прийти письмо относительно номера абонента в базе;
Заголовок Email сообщения;
Текст Email сообщения.

В заголовке и тексте Email можно использовать переменные из базы.

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

phone — номер абонента;
answers — ответ абонента в голосовом меню;
datetime — дата и время звонка;
duration — длительность звонка.

Отправить отчет по рассылке на email

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

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

Пример: за 3 минуты 3-ое абонентов нажали "1" в рассылке. В письме будет результат 3-ех звонков.

В черный список

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

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

Вебхук

После ответа абонента на указанный URL будет отправлен POST-запрос в формате json, в который будут добавлены указанные Вами параметры (из полей при добавлении параметров), а также параметры по умолчанию.

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

Параметры, которые передаются автоматически по вебхуку в блоке голосового меню:
{
"call": {
"phone": 79999999999, // номер телефона абонента
"answer": "1" // ответ пользователя
}
}

Ничего не делать

После ответа абонента на блок голосового меню звонок будет автоматически завершен.

Аналогично с остальными действиями, при выборе действия "Ничего не делать" — ответы абонентов будут зафиксированы в отчете по рассылке.

Дополнительные настройки голосового меню

Подсценарий

Функционал позволяет отметить блок IVR как подсценарий, в случаях, когда необходимо использовать определенную ветку голосового меню несколько раз.

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

Важно! В подсценарий также будут входить все его дочерние блоки.

После того, как подcценарий создан, он станет доступен для выбора при создании нового блока IVR после любого неконечного блока IVR при нажатии на кнопку “+“ (например, подсценарий нельзя добавить ниже блока с действием “Ничего не делать”) .
При нажатии на “+“ отобразятся действия, которые можно проделать с блоком: создать новый блок IVR или добавить подсценарий. В списке отобразятся все созданные подсценарии.

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

Отключить чекбокс подсценария нельзя. Убрать его можно только удалив.

Использовать функцию повтора IVR

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

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

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

Теги для блоков голосового меню

Теги позволяют увидеть, до какой части сценария дошел абонент.

Запишите нужные Вам теги в поле “Теги для блоков голосового меню” при создании рассылки, чтобы далее маркировать этими тегами отдельные блоки сценария рассылки. Один тег можно присвоить к разным блокам.

Добавленный тег Вы можете отметить как “Лид”. Если абонент пройдет через блок с тегом, который был отмечен как “Лид” — он будет считаться лидом. Количество лидов будет отображаться в статистике по рассылке одним общим числом.

После того, как Вы добавили необходимые Вам теги, они станут доступны для выбора при создании или редактировании блока голосового меню.

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

Взаимодействие с блоками голосового меню

Добавление нового блока голосового меню

Для того, чтобы добавить новый блок голосового меню, Вам необходимо нажать на знак “+”.

Редактирование блока голосового меню

Для того, чтобы отредактировать блок голосового меню, Вам необходимо нажать на него.

Удаление блока блока голосового меню

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

При удалении блока голосового меню при его редактировании, будут удалены блоки, которые находятся ниже выбранного.

Перемещение блока голосового меню

Если ключевые слова пересекаются в двух блоках IVR, то по умолчанию действие будет выполняться по левому блоку. Он является приоритетным. Если Вам необходимо сделать правый блок приоритетным, а IVR уже настроен, то Вы можете не переделывать блоки, а использовать функцию “Переместить вправо/влево”. Для этого Вам необходимо нажать на знак “Стрелки” при наведении на блок.

Копирование и вставление блока голосового меню

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

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

Работа с рассылками

Изменение важных настроек рассылки

Важные настройки

Дополнительные настройки для корректировки рассылки. Для открытия меню необходимо нажать на текст “Показать важные настройки”.

Название рассылки

Имя рассылки внутри сервиса. По умолчанию в названии рассылки указываются время и дата создания рассылки по локальному времени Вашего компьютера. Название можно изменить при необходимости.

Номер отправителя

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

Если в рассылке используется общий или арендованный системный номер, то все, кто перезвонит по этому номеру, услышат ролик из созданной Вами рассылки.

Типы номеров:

Личные номер — Ваш номер, который Вы добавили и подтвердили на сервисе в качестве исходящего.

Перезвонив на личный номер телефона, абонент попадает напрямую на владельца номера без прослушивания аудиообращения!

Общие номера - номера, доступные всем пользователям сервиса. Данный тип номеров привязывается к рассылке до момента ее окончания, далее номер может занять другой пользователь.
Дежурные номера - номера, которые могут использовать одновременно сколько угодно человек. На данный тип номеров нельзя перезвонить.
Арендные номера - общие номера, которые взяты в аренду. Отличие от общих номеров в том, что их не может занять никто кроме Вас до момента окончания аренды.

Язык рассылки

Выбор языка для рассылки. На выбранном Вами языке будет генерироваться текст аудиоролика и распознаваться речь абонентов в голосовом меню.

К примеру:
Если Вам необходимо создать рассылку на англоязычную аудиторию, Вам необходимо выбрать язык рассылки "English (US)” для того, чтобы текст озвучивался роботом на английском языке, а также чтобы распознавание в голосовом меню с типом “Слова” сработало корректно.

Скорость рассылки

Скорость, с которой будут совершаться звонки во время рассылки. Можно выбрать любую скорость от 80 до 5800 звонков в час (по умолчанию, скорость может быть и выше).

Скорость рассылки никак не влияет на конечную стоимость.

Примеры рассылок с распознаванием

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

Загрузить из шаблона

Данная функция предоставляет возможность вставить настройки из созданного ранее шаблона. Шаблоны можно редактировать и удалять в разделе «Шаблоны» - «Шаблоны рассылок».

Автоматическое определение тишины

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

Запланировать рассылку

Возможность начать рассылку в назначенное время по часовому поясу, указанному в Вашем профиле. Для изменения часового пояса, по которому будет запланирована рассылка, нажмите на знак “Карандаш”.

При планировании рассылок с общих номеров, база номеров в рассылке должна быть больше 50 номеров.

Ограничить время и дни рассылки

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

Ограничения функции “Ограничить время и дни рассылки”:

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

Умная рассылка

Умная рассылка позволит дозвониться до большего количества людей.
По окончании рассылки, через то время, которое Вы выставили (в минутах), начнется новая рассылка с именем «ЧАСТЬ 2 [название рассылки]», в которой робот обзвонит тех, кто не взял трубку (и не перезвонил в случае общего номера телефона отправителя). Скорость новой рассылки будет такая же, как и у первой части.

Время ожидания ответа

Функция позволяет настроить время, в течение которого будет длиться звонок до поднятия трубки абонентом. По умолчанию время ожидания ответа 30 секунд.

Записывать разговоры

Функция позволяет записать все разговоры в звонке.
После окончания рассылки можно прослушать записи разговоров в отчете по рассылке, но записи звонков хранятся всего 2 недели.
Данная функция увеличивает стоимость рассылки на 20%.

Вебхук по окончании звонка

Возможность получить результаты всех звонков по вебхуку. В случае, если необходимо отправлять вебхуки по окончании звонка только ответившим абонентам, нажмите на галочку слева от поля “Только по ответившим на звонок абонентам”.

На указанный URL будет отправлен POST-запрос в формате json, в который будут добавлены указанные параметры (поле webhookParameters), а также параметры по умолчанию.

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

Вебхук по окончанию рассылки

По окончании рассылки на указанный URL будет отправлен POST-запрос в формате json, в котором будут следующие ключи: ID рассылки, Название рассылки и Статус рассылки.

Создание шаблонов

После завершения настройки рассылки можно создать шаблон или API-шаблон этой рассылки.

Создание шаблона предоставляет возможность сохранить данную рассылку как шаблон, чтобы использовать в будущем. Данные для шаблона будут взяты из ранее заполненных Вами полей при создании рассылки. Название шаблона будет взято из поля «Название рассылки».

Создание шаблона API предоставляет возможность сохранить данную рассылку как шаблон для звонков по API.

Работа с рассылками

Просмотр отчета по рассылке

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

Общая информация по рассылке

В данном разделе отображается статистика звонков:

Сделано звонков — общее количество исходящих вызовов;
Номеров в стоп-листе — количество номеров, внесенных в черный список в личном кабинете;
Результативные звонки — количество звонков, на которые ответили абоненты + количество перезвонивших абонентов;
Исходящие вызовы — количество исходящих звонков;
Перезвонили — количество перезвонивших абонентов на номер, указанный в рассылке.

Также в данном разделе есть возможность выгрузить отчеты по рассылке:

Скачать отчет — выгрузка отчета по совершенным звонкам и перезвонам;
Скачать не ответивших — выгрузка базы номеров абонентов, которые не ответили на звонок;
Скачать не обзвоненных — выгрузка базы номеров абонентов, которым звонок не поступал (в случаях когда рассылка в статусе на паузе/остановлена).

Параметры рассылки отображают:

Статус рассылки;
Стоимость рассылки;
Тип рассылки;
Информацию о функционале, который был использован в рассылке;
Скорость рассылки;
Номер отправителя;
Добавленную и итоговую базу номеров;
Дату создания, старта и окончания рассылки.

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

Статистика по звонкам

В данном разделе отображаются все совершенные звонки и информация по ним.
В случае, если использовалась функция IVR, в столбце “Ответ“ будет отображаться ответ абонента.

С помощью фильтров Вы можете выбрать определенный ответ/тег абонентов и отобразить звонки с данным ответом. Также есть возможность выгрузить отчет по звонкам с определенным ответом/тегом нажав “Скачать отчет по этапу IVR“.

Перезвонившие

Раздел полностью аналогичен “Статистике по звонкам“, разница только в том, что в “Перезвонивших” отображаются абоненты, которые перезвонили на номер из рассылки.

Работа с аудиороликами

Раздел "Аудиоролики"

Страница предназначена для создания, поиска, удаления аудиороликов и отправки их на модерацию.

Поиск аудиороликов

Строка поиска - представляет собой функционал по поиску аудиороликов по отдельным параметрам аудиороликов:

ID/№ аудиоролика
название аудиоролика

Массовый запрос модерации аудиороликов

Выделив несколько аудиороликов, Вы можете массово отправить их на модерацию. Для этого Вам необходимо нажать “Запрос модерации”, и в случае если ролики соответствуют правилам сервиса, они перейдут в статус “Отмодерирован”.

Используя аудиоролики со статусом “Отмодерирован” Вы можете запускать рассылки не ожидая последующей модерации.

Создать аудиоролик

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

Таблица аудиороликов

Таблица предназначена для просмотра аудиороликов и выполнения различных действий с любым из созданных аудиороликов.

№	ID/№ созданного аудиоролика. Для упрощения поиска и впоследствии более быстрого решения Вашего вопроса, сотрудники компании могут запросить его у Вас.
Дата создания	Дата и время создания аудиоролика. Время указано по часовому поясу Вашего личного кабинета, проверить/изменить часовой пояс возможно в разделе “Профиль”.
Название	Название созданного аудиоролика.
Статус	Текущий статус созданного аудиоролика. Для его обновления Вам необходимо обновить таблицу рассылок, нажав на кнопку “Поиск” или произвести полное обновление страницы “Рассылки”. Готов - аудиоролик готов к использованию в рассылках, но еще не отмодерирован. Рассылки с подобными аудиороликами проходят обязательную модерацию; Отклонен - аудиоролик был отклонен в момент проверки модераторами сервиса; На модерации - аудиоролик отправлен на модерацию; Отмодерирован - аудиоролик отмодерирован и готов к использованию в рассылках. Рассылки с подобными роликами не проходят обязательную модерацию.
Аудиозапись	Аудиозапись созданного аудиоролика
Комментарий	Созданный комментарий к аудиоролику: Красным цветом отображены системные комментарии, обычно это комментарии с причиной отклонения аудиоролика.
Управление	Кнопки дополнительных действий: Запрос модерации - запрос модерации аудиоролика (для изменения его статуса на “Отмодерирован”); Редактирование - изменение названия аудиоролика; Удалить - удаление аудиоролика.

Работа с аудиороликами

Создание аудиоролика

Страница предназначена для создания создания аудиороликов, для дальнейшего использования их на сервисе

Создание аудиороликов

При нажатии на кнопку “Создать аудиоролик” произойдет перенаправление на страницу создания аудиороликов.
Здесь можно изменить название аудиоролика (по умолчанию названием ролика будет дата и время его создания) и выбрать язык на котором будет создан аудиоролик. Далее Вы можете загрузить аудиоролик любым наиболее удобным для Вас способом.

Для создания аудиоролика доступно три источника загрузки:

Источник аудиоролика “Текст”

Благодаря данному источнику Вы можете создать аудиоролик просто набрав текст.

Источник аудиоролика “Микрофон”

Данный источник позволит Вам создать аудиоролик, записав его помощью микрофона на компьютере или гарнитуре.

Источник аудиоролика “Аудиофайл”

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

Поддерживаемый формат файлов: mp3, m4a.

После загрузки аудиоролика одним из вышеописанных способов, Вы можете создать дополнительный аудиоролик. Для этого Вам необходимо нажать на кнопку “Добавить еще аудиоролик” (Вы можете загрузить не более 20 аудиороликов за раз), после чего нажать на “Создать аудиоролик”.
После их создания они попадут в таблицу раздела “Аудиоролики”.

Работа с базами номеров

Раздел "Базы номеров"

Данный раздел необходим для создания баз номеров для использования их в рассылках.

Поиск баз

Строка поиска — представляет собой функционал по поиску баз по отдельным параметрам базы:

ID/№ базы
название базы

Создать базу

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

Фильтры баз

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

Список баз

Таблица предназначена для просмотра и выполнения различных действий с любой из созданных баз.

Управление

Данный раздел предназначен для взаимодействия с уже созданной базой. Вы можете выполнить с базой следующие действия:

Редактировать — изменить название базы и добавить комментарий к ней;

Добавить номера — добавить номера к выбранной базе;

Удалить номера — удалить номера из выбранной базы;

Скачать — скачать файл базы в формате .CSV;

Вычесть базы — удалить из выбранной базы дубликаты номеров из другой базы, добавленной на сервис;

Удалить — удалить выбранную базу.

Работа с базами номеров

Создание базы номеров

Для создания базы номеров Вам необходимо перейти в раздел “Базы номеров“, после чего нажать кнопку “Создать базу“, либо нажать на знак “+“ в боковом меню.

Далее перед Вами откроется страница создания базы.

Название

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

Способы создания базы

Буфер обмена

Используя данный способ, Вы можете вставить номера в поле формате:

+7(xxx)xxx-xx-xx, 7xxxxxxxxxx , 8xxxxxxxxxx или 8(xxx)xxx-xx-xx

Ручной ввод

С помощью данного способа Вы можете внести номера в специальное поле вручную.

Для того, чтобы добавить дополнительные номера, нажмите на кнопку “Добавить номер” — появится еще одно поле для ввода. Чтобы удалить номер, необходимо нажать на “Корзину“ справа от номера.

Файл базы

Также Вы можете загрузить базу номеров файлом. База номеров должна быть в формате XLS, XLSX, CSV. Максимальный размер загружаемой базы - около 250000 номеров.

Номера в базе должны быть в формате 7xxxxxxxxxx, +7(xxx)xxx-xx-xx , 8xxxxxxxxxx или 8(xxx)xxx-xx-xx и находиться друг под другом. В одной ячейке должен быть только один номер.

После того, как база добавлена, при необходимости можно указать комментарий к ней, а также добавить еще одну базу.

Далее Вам необходимо нажать кнопку “Создать базу“ и база номеров будет создана.

Работа с базами номеров

Создание базы номеров с переменными

Базы номеров с переменными

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

Для этого необходимо загрузить базу способом “Файл базы“.

После того как файл выбран, нажмите кнопку “Предпросмотр базы”.

Здесь Вы можете настроить переменные, которые впоследствии возможно будет использовать в рассылках.

Например: Вы можете добавить столбец “Имя” и “Дата“ к каждому номеру в базе, после чего использовать их в рассылках, создавая тем самым уникальное обращение к каждому клиенту . Функционал предоставляет как уже готовые решения (Телефон, Email, Имя, Фамилия, Отчество, Дата рождения), так и пользовательские. После завершения настроек, нажимаем “ОК”.

Далее нажмите “Создать базу”, после чего будет создана база с переменными.

Использование переменных из базы номеров

Чтобы использовать переменные из базы номеров, необходимо выбрать источник аудиоролика “Текст”.
Далее введите текст аудиоролика, и в местах, где необходимо использовать переменные, нажмите на кнопку “ПЕРЕМЕННЫЕ“ и укажите ту переменную, которая Вам необходима.

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

Работа с шаблонами

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

Работа с шаблонами

Пресеты вебхуков

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

Поиск пресетов

Строка поиска представляет собой функционал по поиску пресетов по следующим параметрам:

название;
URL-адрес.

Создать пресет

Для начала работы с данным разделом, необходимо нажать кнопку “Создать пресет“.

Управление пресетом

В столбце “Управление“ доступны 2 функции:

Редактировать — внести изменения в существующий пресет;
Удалить — удалить выбранный пресет.

Работа с шаблонами

Создание пресета вебхука

Обязательные параметры

После нажатия кнопки “Создать пресет“ перед Вами откроется окно настроек создаваемого пресета.

В первую очередь необходимо указать название пресета и URL-адрес, на который будет отправляться вебхук.

Часто используемые параметры

Ниже идет список часто используемых параметров (заполнять все поля необязательно).

Кастомные параметры

Для добавления дополнительных параметров нажмите:
- “Добавить заголовки“, если Вам необходимо принимать информацию вебхука в заголовке;
- “Добавить параметры“, если Вам необходимо принимать вебхук стандартно.

Продвинутые параметры

Для создания более сложного запроса доступны Продвинутые параметры. После включения данного функционала, откроется поле “Тело запроса“, в которое нужно внести необходимые Вам параметры.

Завершение создания

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

Работа с шаблонами

Шаблоны рассылок

Поиск шаблонов

Строка поиска представляет собой функционал по поиску шаблонов по их названию.

Создать шаблон

Для начала работы с данным разделом нажмите кнопку “Создать шаблон“.

Таблица шаблонов

Таблица предназначена для просмотра всех шаблонов рассылок и взаимодействия с любым из них.

Управление шаблоном

После того как шаблон уже создан, в блоке “Управление” есть ряд возможностей для взаимодействия с шаблоном:

Открыть — внести изменения и запустить рассылку, не изменяя сам шаблон;
Редактировать — изменить настройки шаблона;
Скопировать в API шаблон — создать API шаблон с аналогичными настройками;
Удалить — удалить выбранный шаблон.

Работа с шаблонами

Создание шаблона рассылки

После нажатия кнопки “Создать шаблон“ перед Вами откроется страница Создание рассылки.

Когда настройка шаблона закончена, можно выбрать один из двух вариантов:

Создать шаблон;
Сохранить шаблон и запустить рассылку.

Работа с шаблонами

Шаблоны API

Поиск шаблонов

Строка поиска представляет собой функционал по поиску шаблонов по следующим параметрам:

ID шаблона;
название.

Создать шаблон

Для начала работы с данным разделом Вам необходимо нажать кнопку “Создать шаблон“.

Таблица шаблонов

Таблица предназначена для просмотра всех шаблонов API и взаимодействия с любым из них.

Управление шаблоном

После того как шаблон уже создан, в блоке “Управление” есть ряд возможностей для взаимодействия с шаблоном:

Редактировать — внести изменения в существующий шаблон. После изменений необходимо нажать кнопку “Сохранить“ для того, чтобы изменения вступили в силу;
Скопировать — скопировать уже существующий шаблон. Далее Вы сможете поменять параметры API-шаблона, если это потребуется;
Открыть IVR — просмотреть сценарий голосового меню выбранного шаблона;
Удалить — удалить выбранный шаблон.

Работа с шаблонами

Создание API шаблона

После нажатия кнопки “Создать шаблон“ перед Вами откроется страница создания API шаблона, меню будет схоже с тем, что представлено на странице Создание рассылки.

Когда настройка шаблона завершена, нажмите “Создать шаблон“, после чего он будет отображен в таблице шаблонов.

Работа с шаблонами

Шаблоны СМС

Поиск шаблонов

Строка поиска представляет собой функционал по поиску шаблонов по следующим параметрам:

название;
текст СМС.

Создать шаблон

Для начала работы с данным разделом Вам необходимо нажать кнопку “Создать шаблон“.

Фильтры

Фильтры предоставляют возможность отсортировать шаблон по дате и статусу. Если фильтр Вам больше не нужен, его можно сбросить.

Таблица шаблонов

Таблица предназначена для просмотра всех шаблонов рассылок и взаимодействия с любым из них.

Управление шаблоном

После того как шаблон уже создан, в блоке “Управление” есть ряд возможностей для взаимодействия с шаблоном:

Редактировать — изменить название шаблона и его текст;
Удалить — удалить выбранный шаблон;
Запрос модерации — отправить шаблон на модерацию. После проверки, можно запускать рассылки с данным сообщением не ожидая модерации, в случае если аудиоролики в рассылке также будут отмодерированы.

Работа с шаблонами

Создание шаблона СМС

После нажатия кнопки “Создать шаблон“ перед Вам откроется меню создания шаблона СМС.

Для создания Вам необходимо указать название шаблона и текст СМС и нажать кнопку “Создать шаблон“, после чего шаблон будет отображен в таблице раздела "Шаблоны СМС".

Работа с API и интеграциями

API-сервис голосовых рассылок используется для автоматических звонков из приложений, которыми Вы пользуетесь: это могут быть CRM-системы, интернет-магазины, 1C:Предприятие и так далее.
Чтобы начать пользоваться API, прочитайте Инструкция по API-интеграции, сгенерируйте API-ключ и протестируйте все с помощью Эмулятор API-запросов.

Работа с API и интеграциями

Таблица звонков

Раздел предоставляет статистику по совершенным API-звонкам с возможностью просмотра информации по конкретным номерам.

Получить запрос по ID звонка

При нажатии кнопки “Получить запрос по ID звонка” откроется диалоговое окно “Проверка JSON запроса”, где можно ввести ID API-звонка и получить полное отправленное тело запроса в формате JSON.

Поиск API звонков

Строка поиска представляет собой функционал по поиску звонков по входящему номеру телефона.

Скачивание отчета API-звонков

При нажатии кнопки “Скачать” откроется диалоговое окно “Скачать API звонки”, где Вы можете выставить необходимый период и скачать отчет в формате CSV со всеми звонками за указанный период.

Настройки API

При нажатии кнопки перед Вами откроется диалоговое окно “Настройки API”, где Вы можете скопировать или сгенерировать API-ключ и посмотреть текущие лимиты API-звонков (лимит звонков на один номер в сутки и количество запросов в минуту).

Фильтры

С помощью данного функционала Вы можете отобрать API-звонки по определенным параметрам, что облегчит поиск необходимых вызовов.

Таблица API-звонков

Таблица предназначена для просмотра отчета по созданным API-звонкам.

ID	ID/№ созданного API звонка. Для упрощения поиска, и, впоследствии, ускорения решения вопроса оператор может запросить его у Вас.
Номер телефона	Номер, на который был совершен звонок.
Дата создания	Дата и время создания API-звонка. Время указано по часовому поясу Вашего личного кабинета, проверить/изменить часовой пояс Вы можете в разделе “Профиль”.
Запланированная дата рассылки	Дата и время планирования API-звонка. Время указано по часовому поясу Вашего личного кабинета, проверить/изменить часовой пояс Вы можете в разделе “Профиль”.
Номер отправителя	Номер, с которого был совершен звонок.
Стоимость	Итоговая стоимость звонка.
Комментарий	Созданный комментарий к API-звонку.
Метка	IP-адрес, с которого был совершен запрос.
Запись звонка	Аудиозапись записанного разговора. Данный функционал является дополнительной услугой и для его включения в API, необходимо прописать в теле запроса параметр “needRecording”: 1.
Управление	Кнопки дополнительных действий: Подробности — получить дополнительную информацию о звонке; Изменить комментарий — изменить комментарий у API-звонка; Получить запрос — получить полное тело отправленного запроса в формате JSON. Функция аналогична получению запроса по ID звонка.

Работа с API и интеграциями

Таблица звонков по шаблону

Раздел полностью идентичен разделу “Таблица звонков”, единственное отличие заключается в том, что в данном разделе отображаются API-звонки отправленные с использованием шаблона API.

Работа с API и интеграциями

Инструкция по API-интеграции

Страница предназначена для ознакомления со всеми возможными запросами API и их параметрами. Все API-запросы отправляются простыми HTTPS запросами. Все ответы на запросы возвращаются в формате json-строки.

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

2. Вы связываетесь со своим менеджером, и вам убирают модерацию на некоторые загруженные вами аудиоролики.

Если не снять модерацию со всего аккаунта или рассылаемых аудиороликов, звонки не будут запускаться.

Варианты запросов

Запрос на звонок

URL: https://{domain}/apiCalls/create

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
phone	string(11)	Номер вызываемого абонента	Да, если нет phones	В запросе должен присутствовать или номер вызываемого абонента (phone)
phones	array	Массив номеров вызываемых абонентов	Да, если нет phone	В запросе должен присутствовать или номер вызываемого абонента (phone)
outgoingPhone	string(11)	Номер, с которого поступает вызов	Да, если dutyPhone отсутствует или равен 0	Номер должен быть добавлен и подтвержден в личном кабинете
dutyPhone	0 или 1	Случайным образом выбрать номер, с которого поступает вызов, из списка дежурных номеров	Да, если outgoingPhone отсутствует
plannedAt	date_format:U	Дата планирования сообщения	Нет
smartDelay	integer	Время в минутах, через которое будет запускаться повторный обзвон базы (минимум 15, максимум 90 минут)	Нет	Эта функция позволяет дозвониться до большего количества людей. После окончания звонка, спустя выбранное время, начнется новый звонок, в котором будет обзвон тех, кто не взял трубку.
needRecording	0 или 1	Записывать звонок или нет	Нет	По умолчанию звонок не записывается. Аудиозапись будет доступна по адресу recordPath (Информация о звонке)
webhookUrl	string(255)	URL, на который будет отправляться информация о звонке при изменении его статуса	Нет	На данный URL будет отправлен POST-запрос с данными в формате json с адреса 82.202.206.194, формат данных представлен в ответе на запрос в разделе 'Запрос информации о звонке'. Запрос будет отправляться каждую минуту до трех раз или пока не будет получен HTTP-code 200
webhookParameters	string	Json-строка, параметры из этой строки будут добавлены в запрос. Пример:{"user_parameter1": "value1", "user_parameter2": "value2"}	Нет
webhookHeaders	string	Json-строка, параметры из этой строки будут добавлены в запрос. Пример:{"user_header1": "value1", "user_header2": "value2"}	Нет
record	object
record.id	integer	аудиозаписи	Да (если нет text)	Аудиозапись можно добавить в личном кабинете и посмотреть ее id в разделе аудиозаписи
record.text	string(1024)	Текст для генерации аудиоролика	Да (если нет id)	Генерация стоит 40 копеек, и для совершения звонков с генерацией голоса нужно договориться с менеджером об отключении модерации аккаунта
record.gender	0 или 1	Определяет пол голоса для генерируемого текста	Да	0 - женский, 1 - мужской, по умолчанию - 0
ivrs	array	Список обработчиков нажатия цифр	Нет
ivrs.*.digit	integer(0-9)	Обрабатываемая цифра	Нет	Если цифра пустая, то будет выполняться условие 'Оставаться на линии' - действие, которое выполнится, если никакое другое действие не будет выбрано
ivrs.*.keyWords	string	Список ключевых слов через разделитель '\|'	Нет
ivrs.*.needBlock	integer(0-1)	Добавление в ЧС при нажатии	Нет
ivrs.*.record.id	integer	аудиозаписи	Нет
ivrs.*.managerPhone	string(11)	Номер для переадресации при нажатии	Нет
ivrs.*.smsText	string(70)	Текст СМС для отправки абоненту	Нет
ivrs.*.smsTemplateId	integer	ID шаблона СМС	Нет	Используемый шаблон СМС должен быть отмодерирован. Если указываете ID шаблона СМС, то текст смс (ivrs.*.smsText) подставляется автоматически
ivrs*.webhookUrl	string	При данном действии на указанный URL будет отправлен POST-запрос в формате json с адреса 82.202.206.194, в который будут добавлены указанные вами параметры (поле webhookParameters), а также параметры по умолчанию. Параметры по умолчанию: call — объект, содержащий информацию о звонке, в нем содержатся следующие поля: phone — строка, содержащая номер телефона, на который был совершен звонок, answer — число или строка, содержащая ответ абонента (например, 1 — в случае, если абонент нажал «1», или «да», если абонент ответил да) Пример тела запроса: {"call": {"phone": "10000000000", "answer": 1}, "user_parameter1": "value1", "user_parameter2": "value2"}	Нет
ivrs*.webhookParameters	string	Json-строка, параметры из этой строки будут добавлены в запрос. Пример:{"user_parameter1": "value1", "user_parameter2": "value2"}	Нет
ivrs*.webhookHeaders	string	Json-строка, параметры из этой строки будут добавлены в запрос. Пример:{"user_header1": "value1", "user_header2": "value2"}	Нет
ivrs.*.anyWord	integer(0-1)	Использовать для распознавания любые фразы от пользователя или нет	Нет	Можно использовать, если ivrs..keyWords и ivrs..digit пусты
ivrs.*.recognitionTimeout	integer(1-15)	Настраиваемый период времени ответа пользователя.	Нет	Может использоваться, если ivrs.*.anyWord=1. По умолчанию значение 7 секунд.
ivrs.*.recognize	integer(0-1)	Распознавать ответ от пользователя или нет.	Нет
ivrs.*.record.source	string	Источник ролика	Нет	Источник аудио: text - текст, file - для записей микрофона и аудиофайлов.
ivrs.*.smsChannel	string	Канал отправки СМС сообщения	Нет	По умолчанию СМС сообщения отправляются с VIRTA
ivrs.*.emailTimeout		Интервал отправки письма в минутах	Нет
ivrs.*.ivrs	array	Список обработчиков нажатия цифр	Нет	Можно добавлять несколько уровней вложенности в дерево звонка
isManagerDeliveryPhone	integer(0-1)	Использовать номер отправителя, при связи с менеджером	Нет
endOfSpeech	integer(0-1)	Автоматически определять конец речи пользователя или нет	Нет
lang	string(5)	Код языка в формате «ru-RU»	Нет	По умолчанию у вас стоит язык, установленный как язык по умолчанию для вашего партнера. Чтобы получить список возможных языков, отправьте GET-запрос на их получение (метод описан в пункте 7)
voiceDetection	integer(0-1)	Автоматически определять перебивание робота абонентом или нет	Нет
startTime	string	Начало допустимого временного интервала	Нет	В формате 00:00
endTime	string	Конец допустимого временного интервала	Нет	В формате 00:00
plannedAtTimeZone	integer(0-1)	Нужно ли учитывать часовой пояс абонента	Нет	Если не использовать этот параметр, то для создания звонков будет использоваться часовой пояс клиента из личного кабинета на сервисе.
excludeWeekends	integer(0-1)	Исключить выходные дни	Нет	Использовать вместе параметры weekdays и excludeWeekends нельзя. Также, эти два параметра не будут давать никакого эффекта без параметров startTime и endTime.
weekdays	array	Дни недели для совершения звонка	Нет	В формате [1, 2, 3, 4, 5], где 1 - это понедельник и тд.
answerTimeout	integer(15-60)	Время ожидания ответа в секундах	Нет	По умолчанию 30 секунд

Примеры запросов на PHP:

Пример запроса с использованием загруженного аудиоролика и IVR

    <?php
        if( $curl = curl_init() ) {
            $jsonstr = '{"apiKey": "nWvGmHIvkj1tM323tsEgfdRYkagGi********", "phone":"99999999999", "outgoingPhone":"99999999999", "record":{"id":1},
                        "ivrs":[{"digit": 1,"needBlock": 0,"record": {"id": 1342}}, {"digit": 2,"needBlock": 0,"managerPhone": "99999999998"}]}';
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/create');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $jsonstr);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Пример запроса с использованием генерации текста и IVR

    <?php
        if( $curl = curl_init() ) {
            $jsonstr = '{"apiKey": "nWvGmHIvkj1tM323tsEgfdRYkagGi********", "phone":"99999999999", "outgoingPhone":"99999999997",
                        "record":{"text":"Текст для генерации аудиоролика"},"ivrs":[{"digit": 1,"needBlock": 0,"smsText": "текст СМС"}]}';
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/create');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $jsonstr);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Пример запроса с использованием технологии распознавания голоса

    <?php
        if( $curl = curl_init() ) {
            $jsonstr = '{"apiKey": "nWvGmHIvkj1tM323tsEgfdRYkagGi********", "phone":"99999999999", "outgoingPhone":"99999999997",
                        "record":{"text":"Текст для генерации аудиоролика"},
                        "ivrs":[{"keyWords":"Да|нет|не знаю","smsText": "текст СМС", "record": {"text": "Текст аудиоролика"}},
                        {"record": { "text": "Текст аудиоролика"}}]}';
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/create');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $jsonstr);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Примеры запросов на 1С:

Пример запроса с использованием загруженного аудиоролика и IVR

    Соединение = Новый HTTPСоединение("{domain}/apiCalls/",,,,,, Новый ЗащищенноеСоединениеOpenSSL());
    Запрос = Новый HTTPЗапрос("create");
    Запрос.Заголовки.Вставить("Content-Type", "application/json");
    Запрос.Заголовки.Вставить("accept", "application/json");
    Запрос.УстановитьТелоИзСтроки("{""apiKey"": ""nWvGmHIvkj1tM323tsEgfdRYkagGi********"", ""phone"":""99999999999"", ""outgoingPhone"":""99999999997"",
        ""record"":{""id"":1},
        ""ivrs"":[{""digit"": 1,""needBlock"": 0,""record"": {""id"": 1342}},{""digit"": 2,""needBlock"": 0,""managerPhone"": ""99999999998""}]}",
        "utf-8", ИспользованиеByteOrderMark.НеИспользовать);
    Ответ = Соединение.ОтправитьДляОбработки(Запрос);
    ТелоОтвет = Ответ.ПолучитьТелоКакСтроку();

Пример запроса с использованием генерации текста и IVR

    Соединение = Новый HTTPСоединение("{domain}/apiCalls/",,,,,, Новый ЗащищенноеСоединениеOpenSSL());
    Запрос = Новый HTTPЗапрос("create");
    Запрос.Заголовки.Вставить("Content-Type", "application/json");
    Запрос.Заголовки.Вставить("accept", "application/json");
    Запрос.УстановитьТелоИзСтроки("{""apiKey"": ""nWvGmHIvkj1tM323tsEgfdRYkagGi********"", ""phone"":""99999999999"", ""outgoingPhone"":""99999999997"",
        ""record"":{""text"":""Текст для генерации аудиоролика""}, ""ivrs"":[{""digit"": 1,""needBlock"": 0,""smsText"": ""text sms""}]}",
        "utf-8", ИспользованиеByteOrderMark.НеИспользовать);
    Ответ = Соединение.ОтправитьДляОбработки(Запрос);
    ТелоОтвет = Ответ.ПолучитьТелоКакСтроку();

Пример запроса с использованием генерации текста и IVR

    Соединение = Новый HTTPСоединение("{domain}/apiCalls/",,,,,, Новый ЗащищенноеСоединениеOpenSSL());
    Запрос = Новый HTTPЗапрос("create");
    Запрос.Заголовки.Вставить("Content-Type", "application/json");
    Запрос.Заголовки.Вставить("accept", "application/json");
    Запрос.УстановитьТелоИзСтроки("{""apiKey"": ""nWvGmHIvkj1tM323tsEgfdRYkagGi********"", ""phone"":""99999999999"", ""outgoingPhone"":""99999999997"",
        ""record"":{""text"":""Текст для генерации аудиоролика""},
        ""ivrs"":[{
            ""keyWords"":""Да, нет, не знаю"",
            ""smsText"":""текст СМС"",
            ""record"": { ""text"": ""Текст аудиоролика""}
        }, {""record"": { ""text"": ""Текст аудиоролика""}}]}",
        "utf-8", ИспользованиеByteOrderMark.НеИспользовать);
    Ответ = Соединение.ОтправитьДляОбработки(Запрос);
    ТелоОтвет = Ответ.ПолучитьТелоКакСтроку();

Ответ на запрос

    {
        "id":<id звонка>,
        "createdAt":<время создания, UNIX timestamp>
        "plannedAt": <запланированная дата звонка, UNIX timestamp>,
        "smartDelay": <время в минутах, через которое запустится повторный обзвон базы>,
        "needrecording": <необходимость записывать звонок>,
        "phone": <номер телефона>,
        "recordCost": <суммарная стоимость аудиороликов, созданных в данном запросе>
    }

Запрос информации о звонке

URL для API-звонков: https://{domain}/apiCalls/get

URL для API-звонков по шаблону: https://{domain}/apiCalls/getWithTemplates

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
apiCallIdList	array	Список id звонков	Да	Отправлять запрос на получение информации можно не более, чем о 5000 звонках

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....' //Ваш API-ключ
        );

        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/get?apiCallIdList[]=1');
            // curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/getWithTemplates?apiCallIdList[]=1'); // для API-звонков по шаблону
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:


    {
        "id":<id звонка>,
        "createdAt":<время создания, UNIX timestamp>,
        "smartDelay": <время в минутах, через которое запустится повторный обзвон базы>,
        "prevCallId":<ID первоначального звонка умной рассылки>,
        "needRecording":<включена или выключена запись звонка>,
        "plannedAt":<запланированная дата звонка, UNIX timestamp>,
        "webhookUrl":<URL, на который будет отправляться информация о звонке при изменении его статуса>,
        "webhookSent":<был ли отправлен вебхук по окончании звонка>,
        "templateId":<id шаблона, (только для API-звонков по шаблону)>,
        "amoscriptId":<id amoscript-а>,
        "webhookParameters":<параметры вебхука по окончании звонка>,
        "webhookTry":<номер попытки отправки вебхука>,
        "recognitionGroupId":<id из таблицы направления генерации>,
        "generateGroupId":<id из таблицы направления распознавания>,
        "calls":[{
            "phone":<номер телефона>,
            "ivrDigit":<нажатая цифра>,
            "startedAt":<время начала набора, UNIX timestamp>,
            "answeredAt":<время ответа, UNIX timestamp>,
            "managerStartedAt":<время начала набора менеджера, UNIX timestamp>,
            "managerAnsweredAt":<время ответа менеджера, UNIX timestamp>,
            "finishedAt":<время окончания, UNIX timestamp>,
            "toBlock":<занесен или не занесен в черный список>,
            "status":<статус звонка>,
            "nextCallId":<ID повторного звонка умной рассылки>,
            "hangupCause": <код завершения>,
            "managerStatus":<статус звонка менеджеру>,
            "recordFilePath":<ссылка на аудиоролик>,
            "cost":<стоимость звонка, руб.>,
            "createdAt":<время создания, UNIX timestamp>,
            "updatedAt":<время обновления, UNIX timestamp>,
            "label": <метка, по умолчанию - ip клиента>,
            "ivrAnswers":<ответы на ivr, разделённые символом |>
            "ivrIdList":<id действий, произведённых по ответу пользователя>,
            "comment":<комментарии>,
        }]
    }

Статусы звонка:

processed - в процессе обработки
created - создан, но не начат
finished - закончен, и разговор состоялся
canceled - закончен, и разговор не состоялся
answered - в процессе разговора
started - начат

ivrAnswer может быть равным -1, это означает, что человек остался на линии и не повесил трубку. Отображается при выборе функции «Оставаться на линии», либо при использовании функции «Повтор IVR»

Создание аудиоролика

URL: https://{domain}/apiCalls/createRecord

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
name	string	Название аудиоролика	Да
source	‘text' или 'file'	Тип источника аудиоролика	Да
file	file	Звуковой файл	Да, если source='file'
text	string	Текст для генерации ролика	Да, если source='text'

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
                        'source' => 'text', //Тип аудиоролика
                        'text' => 'Hello world' //Содержание аудиоролика
                        'name' => 'TestRecord' //Название аудиоролика
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/createRecord');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "id":<id аудиоролика>,
        "createdAt":<время создания, UNIX timestamp>,
        "needModeration":<включена или выключена модерация>,
        "moderatorComment":<комментарий модератора>,
        "name":<имя аудиоролика>,
        "path":<ссылка на аудиоролик>,
        "status":<статус аудиоролика>,
        "recordText":<текст для генерации аудиоролика>,
        "cost":<стоимость аудиоролика>
    }

Удаление аудиоролика

URL: https://{domain}/apiCalls/removeRecord

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
idList	array	Идентификатор аудиоролика	Да

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
            'idList' => [123], //Идентификатор
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/removeRecord');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "id":<id звонка>,
        "createdAt":<время создания, UNIX timestamp>
        "name":<имя аудиоролика>,
        "path":<ссылка на аудиоролик>,
        "moderatorComment": <комментарий модератора>
        "needModeration": <включена или выключена модерация>,
        "status": <статус звонка>,
        "deletedAt": <время удаления, UNIX timestamp>
    }

Информация о пользователе

URL: https://{domain}/apiCalls/userInfo

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/userInfo');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "id":<id пользователя>,
        "balance":<текущий баланс>
    }

Получить список исходящих номеров

URL: https://{domain}/apiCalls/getPhones

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
all	boolean	true или false	Нет	По умолчанию false

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
            'all' => true
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/getPhones');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "status": success,
        "data": [{"id": <id номера>,
        "phone": <номер телефона>,
        "isSystem": <true или false>,
        "overall": <если номер общий - 1, личный - 0>}]
    }

Получить коды доступных языков

URL: https://{domain}/apiCalls/getAvailableLanguages

Метод: GET

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/getAvailableLanguages');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "status": success,
        "data": [{"id": <id языка>,
        "name": <название языка>,
        "defaultLangCode": <код языка>}]
    }

Верификация клиента по номеру методом FlashOnCall

URL: https://{domain}/apiVerificationPhones/confirmPhone

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
phone	string(11)	Номер вызываемого абонента	Да	В запросе должен присутствовать или номер вызываемого абонента (phone)
pin	string	Последние 4 цифры номера, с которого будет совершен верификационный звонок	Да	Данные 4 цифры будут являться кодом

Пример на PHP:

    <?php
        $requestArray = array(
            'apiKey' => '*******....', //Ваш API-ключ
            'phone' => '99999999999',
            'pin' => '1234',
        );
        $json = json_encode($requestArray);
        if( $curl = curl_init() ) {
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiVerificationPhones/confirmPhone');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "status": success,
        "data": done
    }

Обновление времени отправки звонка

URL: https://{domain}/apiCalls/update

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
callList	array	Список звонков для переноса	Да
callList.*.id	integer	id запланированного звонка	Да
callList.*.replannedAt	date_format:U	Новое время для звонка	Да

Пример на PHP:

    <?php
        if ($curl = curl_init()) {
            $requestArray = array(
                'apiKey' => '*******....', // Ваш API-ключ
                'callList' => array(
                    array(
                        'id' => 123, // Идентификатор первого звонка
                        'replannedAt' => 12345 // Количество секунд Unix timestamp
                    ),
                    array(
                        'id' => 321, // Идентификатор второго звонка
                        'replannedAt' => 54321 // Количество секунд Unix timestamp
                    )
                ),
            );
            $json = json_encode($requestArray);
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/update');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

    {
        "status": success,
            "data": {  // список id обновленных роликов
                "callIdList": [
                    123,
                    321
                ]
            }
    }

Удаление запланированного звонка

URL: https://{domain}/apiCalls/remove

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
idList	array	Идентификатор звонка	Да
isTemplate	integer(0-1)	Является ли звонок API-шаблоном	Нет	Если звонок был создан из шаблона, то указание этого параметра обязательно, иначе звонок не сможет быть удален

Пример на PHP:

Пример запроса массового удаления API звонков

    <?php
        if ($curl = curl_init()) {
            $requestArray = array(
                'apiKey' => '*******....', // Ваш API-ключ
                'idList' => array(123, 321), // Список идентификаторов звонков
        );
            $json = json_encode($requestArray);
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/remove');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Пример запроса удаления одного API звонка

    <?php
        if ($curl = curl_init()) {
            $requestArray = array(
                'apiKey' => '*******....', // Ваш API-ключ
                'id' => 123, // Идентификатор звонка
                );
            $json = json_encode($requestArray);
            curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/remove');
            curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
            curl_setopt($curl, CURLOPT_POST, true);
            curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
            curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
            curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
            $out = curl_exec($curl);
            echo $out;
            curl_close($curl);
        }
    ?>

Ответ на запрос:

Ответ массового удаления API звонков

    {
        "status": success,
        "data": {   // список id удаленных звонков
            "callIdList": [
                    123,
                    321
            ]
        }
    }

Ответ удаления одного API звонка

    {
        "status": success,
        "data": []
    }

Запрос на получение списка шаблонов API звонков

URL: https://{domain}/apiCalls/getTemplates

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
onlyModerated	boolean	0 - выдает все шаблоны, 1 - только отмодерированные	Нет	Отображать только отмодерированные шаблоны или нет

Запрос на создание API звонка с использованием шаблона

URL: https://{domain}/apiCalls/createWithTemplate

Метод: POST

Параметры:

Имя	Тип	Значение	Обязательный	Примечание
apiKey	string	API-ключ	Да	API-ключ нужно запросить у менеджера или партнера
phone	string(11)	Номер вызываемого абонента	Да, если нет phones	В запросе должен присутствовать или номер вызываемого абонента (phone)
phones	array	Массив номеров вызываемых абонентов	Да, если нет phone	В запросе должен присутствовать или номер вызываемого абонента (phone)
templateId	integer	id шаблона	Да	Шаблон можно добавить в личном кабинете и посмотреть его id в разделе «Шаблоны API»
plannedAt	date_format:U	Дата планирования сообщения	Нет
variables	array	Переменные	Нет	В variables указываются переменные для номеров, указанных в phones. Для каждого из указанных номеров переменные будут подставлены индивидуально. Переменные указываются в текстовом (сгенерированном) аудиоролике

Пример на PHP:

$requestArray = array(
        'apiKey' => '*******....', //Ваш API-ключ
        'phones' => [
            '79993331122',
            '79993332211',
        ],
        'templateId' => 1,
        'variables' => array(
            '79993331122' => array(
                'Elena' => '{name}',
                '40%' => '{var1}',
            ),
            '79993332211' => array(
                'Oleg' => '{name}',
                '25%' => '{var1}',
            )
        )
    );

    $json = json_encode($requestArray);
    if( $curl = curl_init() ) {
        curl_setopt($curl, CURLOPT_URL, 'https://{domain}/apiCalls/createWithTemplate');
        curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
        curl_setopt($curl, CURLOPT_POST, true);
        curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
        curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'accept: application/json'));
        curl_setopt($curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
        $out = curl_exec($curl);
        echo $out;
        curl_close($curl);
    }

Ответ на запрос:

                       
    {
        "status": "success",
        "data": [
            {
                "id": 1,
                "phone": "79993331122",
                "templateId": 1,
                "phoneInfo": "{\"name\":\"Elena\",\"var1\":\"40%\"}",
                ...
            },
            {
                "id": 2,
                "phone": "79993332211",
                "templateId": 1,
                "phoneInfo": "{\"name\":\"Oleg\",\"var1\":\"25%\"}",
                ...
            }
        ]
    }

Работа с API и интеграциями

Эмулятор запросов

Раздел используется для создания API-запросов при помощи интерфейса сервиса. С помощью данного раздела Вы можете протестировать API-звонки.

Внимание! При генерации запроса звонок будет отправлен абоненту.

На странице “Эмулятор API-запросов” Вы можете увидеть свой API-ключ, а также скопировать его, нажав кнопку “Скопировать”. Для генерации нового API-ключа необходимо нажать кнопку “Сгенерировать API-ключ”.

Для генерации доступно 4 типа запроса:

Создание звонка

Для создания API-звонка через “Эмулятор запросов” необходимо:

Ввести номер вызываемого абонента;
Выбрать номер отправителя;
Выбрать заранее отмодерированный аудиоролик через источник аудиоролика “Сохраненные”;
При необходимости указать дополнительные настройки, к примеру: вебхук по окончании звонка или голосовое меню.

После нажатия на кнопку “Сгенерировать запрос” сформируется тело запроса в формате JSON и ответ сервера на запрос.

Получение информации о звонке

Для получения подробной информации по совершенному API-звонку необходимо ввести один или несколько ID/№ совершенного API-звонка из раздела “Таблица звонков”.

После нажатия на кнопку “Сгенерировать запрос” сформируется тело запроса в формате JSON и ответ сервера на запрос. Если Вы указали несколько ID API-звонков, они будут разделены массивами.

Получение информации о пользователе

Данный запрос предназначен для получения информации по личному кабинету. Обычно его используют для проверки баланса через API.

Создание аудиоролика

Данный запрос предназначен для создания аудиороликов через API. Для генерации аудиоролика достаточно выбрать источник аудиоролика и добавить аудиоролик любым наиболее удобным для Вас способом.

Все созданные аудиоролики через запрос “Создание аудиоролика” попадут в общую таблицу раздела “Аудиоролики”.

При нажатии на кнопку “Сгенерировать запрос” сформируется тело запроса в формате JSON и ответ сервера на запрос.

Работа с API и интеграциями

Верификационные звонки

Страница предназначена для просмотра статистики по верификационным звонкам, которые были сформированы через API-запрос “Верификация клиента по номеру методом FlashOnCall”.

Поиск верификационных звонков

Строка поиска представляет собой функционал по поиску верификационных звонков по входящему номеру телефона.

Скачивание отчета по верификационным звонкам

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

Фильтры верификационных звонков

С помощью фильтра Вы можете отобрать звонки по определенным параметрам.

Таблица “Верификационные звонки”

Таблица предназначена для просмотра отчета по созданным верификационным звонкам через API.

Номер абонента

Номер, на который был совершен верификационный звонок.

Время звонка

Дата и время создания верификационного звонка. Время указано по часовому поясу Вашего личного кабинета, проверить/изменить часовой пояс Вы можете в разделе “Профиль”.

Статус

Итоговый статус верификационного звонка. Существуют следующие статусы верифицикационного звонка:

Успешно;
В процессе;
Ошибка.

Раздел "Помощь"

В данном разделе Вы можете найти информацию об основном функционале сервиса.

Навигация по окну создания рассылок

В разделе описан пошаговый алгоритм создания рассылки с подробным описанием каждой функции.

Нажав на кнопку “Создать новую рассылку“ , Вы можете перейти на страницу создания рассылок.

Часто задаваемые вопросы

В разделе собраны часто задаваемые вопросы пользователей и ответы на них.

В строке поиска Вы можете ввести ключевые слова для более быстрого поиска ответа на вопрос.

Как создать рассылку

В разделе находится видеоинструкция по созданию рассылки, в которой пошагово показано, как создается рассылка.

Раздел "Бонусы"

В данном разделе Вы можете получить информацию о реферальной программе.

Условия реферальной программы

На странице отображается Ваша реферальная ссылка, а также основная информация об условиях реферальной программы.

Рефералы и оплаты

В таблице представлена информация о всех Ваших рефералах и их оплатах.
Приглашенные пользователи делятся на рефералов первого и второго уровня. Рефераломи первого уровня будут те пользователи, кого Вы пригласили; в свою очередь, рефералами второго уровня будут те пользователи, кого пригласили Ваши рефералы.
Далее Вы можете увидеть информацию о самих рефералах, а именно: дату регистрации, почту и телефон.

В оплатах содержится информация о пополнениях рефералов (дата пополнения, email, бонус ― сумма которая была зачислена на баланс пользователя в процентном соотношении от суммы пополнения реферала).

Дополнительные разделы сервиса

Раздел "Счета"

Раздел служит для просмотра ранее созданных счетов для оплаты, а также для создания нового счета.

На странице отображается таблица с информацией о сформированных Вами счетах для оплаты. У каждого счета указан номер, дата создания, сумма. При нажатии на кнопку “Скачать” скачивается документ формата PDF.

Составление счета

Под таблицей с информацией о счетах есть блок для составления счёта ― "Оплата по счету в банке".
Для составления счёта необходимо ввести ИНН банка и нажать кнопку “Составить счёт”. Далее откроются дополнительные поля, в которых нужно проверить корректность уже заполненных полей, а также заполнить пустые поля. При нажатии на кнопку “Выписать счёт” скачивается сформированный счёт, а в таблице появляется запись о новом счёте.

Дополнительные разделы сервиса

Раздел "Номера телефонов"

Раздел используется для работы с исходящими номерами для рассылок.

Поиск номеров

Строка поиска представляет собой функционал по поиску номеров.

Создание исходящего номера

Для создания исходящего номера Вам необходимо нажать кнопку “Создать исходящий номер”.

Далее перед Вами откроется страница “Создание исходящего номера” с полем для ввода номера телефона. Необходимо ввести номер и нажать кнопку “Создать”. В течение минуты Вам поступит звонок ― необходимо взять трубку и нажать цифру "1" на телефоне.

Фильтры номеров

С помощью данного функционала Вы можете отобрать номера по определенному типу и статусу, что облегчит поиск необходимых.

Виды номеров

Общие номера — номера, доступные всем пользователям. Данные номера привязывается к рассылке до ее окончания, далее номер может занять другой пользователь;
Свободные номера — общие номера, не занятые в рассылках на данный момент;
Дежурный номер — номер, который могут использовать одновременно несколько пользователей. На данный тип номеров нельзя перезвонить;
Арендные номера — общие номера, которые были взяты пользователем в аренду. Данные номера не может занять никто другой до момента окончания аренды;
Личный номер — номер, который пользователь сам добавляет на сервис. При перезвоне на данный номер абоненты будут попадать напрямую на пользователя.

Дополнительные разделы сервиса

Раздел "Промокоды"

Раздел используется для активации полученного промокода.

Промокод — специальный код, при активации которого начисляются средства на Ваш счёт.

Для активации промокода, Вам необходимо ввести его в поле "Введите промокод" и нажать кнопку “Активировать”. При успешной активации появится уведомление с указанием суммы начисления.
Если промокод не применился, появится уведомление об ошибке. Также уведомление об ошибке может появиться при попытке активировать промокод, использованный ранее.

Дополнительные разделы сервиса

Раздел "Платежи"

Раздел используется для просмотра истории зачислений на Ваш лицевой счёт.

Поиск платежей

Строка поиска представляет собой функционал поиска по сумме платежа. Если введённая сумма была зачислена на Ваш счет, то в результате она отобразится в таблице.

Фильтры

Функционал позволяет найти платежи по заданной дате.

Для использования фильтра необходимо открыть выпадающее окно, нажав кнопку “Фильтры”.

Дополнительные разделы сервиса

Раздел "Черный список"

Чёрный список позволяет ограничить создание звонков на конкретные номера телефонов. Сформировать чёрный список возможно как самостоятельно в данном разделе, так и автоматически посредством выполнения условия в звонке с IVR.

Поиск номеров

Строка поиска представляет собой функционал по поиску номеров.

Скачать

Для скачивания чёрного списка номеров Вам необходимо нажать кнопку “Скачать”.

После нажатия скачается документ в формате CSV с номерами, добавленными в чёрный список.

Удалить

Для удаления всех номеров из чёрного списка нажмите кнопку “Удалить” под строкой поиска и согласитесь на удаление в всплывающем окне.

Если Вам необходимо удалить конкретные номера, поставьте галочку слева от необходимых номеров, нажмите кнопку “Удалить” под строкой поиска и согласитесь на удаление в всплывающем окне.

Добавление номера

Для добавления номеров в чёрный список нажмите на кнопку “Добавить номера”. Далее перед Вами появится всплывающее окно “Добавление номеров в стоп-лист”.

Добавить номера можно тремя способами:

Ручной ввод;
Буфер обмена;
Файл базы.

После выбора способа ввода, внесения номеров и нажатия на кнопку “Сохранить” номера отобразятся в чёрном списке.

Дополнительные разделы сервиса

Раздел "Проверка IP"

Белый список IP-адресов позволяет указать список IP-адресов, с которых возможен вход в личный кабинет. При попытке входа с адреса, которого нет в списке, отобразится ошибка "Доступ запрещен".

Добавить

Для добавления IP-адреса в белый список Вам необходимо ввести адрес в поле “IP-адрес” и нажать кнопку “Добавить”. Добавленный адрес отобразится в таблице.
Текущий IP-адрес Вы можете увидеть под полем добавления.

Удалить

Для удаления IP-адреса из белого списка Вам необходимо нажать на кнопку “Удалить”, которая находится в столбце “Управление” слева от IP-адреса.

Поиск

Строка поиска представляет собой функционал поиска IP-адреса. Если введённый IP-адрес находится в белом списке, то он отобразится в результате поиска.

Раздел "Профиль"

Для перехода в раздел Вам необходимо кликнуть на пункт “Профиль” в боковой панели.
Также перейти в раздел “Профиль” можно через выпадающее меню, которое Вы можете открыть, нажав на Ваш логин в правом верхнем углу.

Профиль

В данном разделе отображается подробная информация о Вашем аккаунте.

При нажатии кнопки "Изменить" появляется возможность редактировать телефон, часовой пояс, электронную почту и телефон для уведомлений.

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

Смена пароля

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

Текущий тариф

В данном блоке Вы можете ознакомиться с текущим тарифным планом и посмотреть стоимость той или иной услуги.

Уведомление о низком балансе

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

Уведомлять по email — активация уведомлений по электронной почте (письма будут приходить на email для уведомлений, указанный в профиле);
Уведомлять по CMC — активация уведомлений по CMC (СМС будут приходить на номер для уведомлений, указанный в профиле);
Поле “Минимальная сумма” — сумма, при которой срабатывает уведомление;
Кнопка “Сохранить” — сохранение внесенных Вами изменений.

Настройки голосовых рассылок

Ограничение времени и дней новых рассылок — функция дает возможность ограничить поступление звонков абонентам по времени и дате.
Заданные Вами настройки в профиле будут автоматически применены во всех новых рассылках.

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

Распознавание речи — здесь Вы можете настроить способы распознавания голоса для разных языков. Для этого необходимо открыть выпадающий список у выбранного языка, выбрать нужный пункт и нажать кнопку “Сохранить”.

Настройки системы пополнения

С помощью системы автопополнения Вы можете пополнять баланс автоматически.

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

Также необходимо выбрать платежный метод и далее подтвердить карту.

Реферальная система

В данном разделе Вы можете найти и скопировать свою реферальную ссылку.
Для получения подробной информации о реферальной системе необходимо перейти в раздел "Бонусы".

API

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