Campaign setup

Календарь

Прежде чем переходить к настройкам исходящей кампании, необходимо создать календарь, по которому будет работать данная кампания. Календарь создается в разделе Calendars web-клиента Webitel. В календаре указывается дата начала и завершения кампании, часовой пояс, время работы в зависимости от дня недели, а так же, праздничные дни:

Image Removed

Calendar

Before proceeding to the settings of the outbound campaign, you must create a calendar on which the campaign will work. The calendar is created in the Calendars section of the Webitel web client. The calendar contains the start and end date of the campaign, the time zone, the time of work depending on the day of the week, as well as holidays:

Image Added

General settings

In the Dialer section, create a new campaign with the Voice Broadcasting type

Общие настройки

В разделе Dialer создаем новую кампанию с типом Voice Broadcasting.

After specifying the name of the campaign and selecting the previously created calendar, go to the block with parameters Указав название автоинформатора и выбрав предварительно созданный календарь, переходим к блоку с параметрами (Parameters).

JSON Scheme

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

Image Removed

Cause

На вкладке Cause указываются коды завершения вызова из списка и как дайлер должен обрабатывать эти коды.

Image Removed

• Error - получив один из этих кодов, дайлер немедленно прекращает дозваниваться абоненту.
• Retry - получив один из этих кодов, дайлер продолжает дозваниваться абоненту, в рамках заданного количества попыток.
• OK - успешное завершение работы дайлера по данному абоненту.
• Minus - коды из данного списка не влияют на количество попыток дозвона. Получая данный ответ, дайлер не прекращает дозвон и не увеличивает количество выполненных попыток.

Загрузка абонентов

Абоненты могут быть добавлены в кампанию с помощью web-клиента Webitel, импортом из CSV файла, либо с использованием REST API интерфейса.

Image Removed

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

JSON Scheme

After successfully dialing one of the subscribers in the campaign, the dealer performs the scheme from the Callflow tab. You can use any elements of routing, refer to variables that set globally on a campaign, or on a specific subscriber.

Image Added

Cause

On the Cause tab, call completion codes are listed from the list and how the dealer must handle these codes.

Image Added

• Error - having received one of these codes, the dialer stops calling the subscriber immediately.
• Retry - having received one of these codes, the dialer continues to dial to the subscriber within the specified number of attempts.
• OK - successful completion of the dialer for this subscriber.
• Minus - codes from this list do not affect the number of dialing attempts. Receiving this answer, the dialer does not stop dialing and does not increase the number of attempts made.

Upload subscribers

Subscribers can be added to the campaign using the Webitel web client, importing from a CSV file, or using the REST API interface.

Image Added

Dialing the numbers specified in the subscriber cards is performed using standard outbound routing

Upload using Web client

Just press the green "Add" button and enter the customer data for the call:

Image Added

• Name - Arbitrary subscriber name
• Priority - The priority of processing this subscriber by the dealer from the list of all subscribers.
• Expire - If the subscriber was not processed before the specified time and date, it is automatically excluded from further dialing with the termination code MEMBER_EXPIRED
• Communications - A list of telephone numbers where you can reach this subscriber. Please note that within the same campaign, the numbers cannot be the same for different subscribers.
• Variables - Individual variables for a given subscriber. They also get into the call channel and can be used in the

Загрузка с помощью web-клиента

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

Image Removed

• Name - Произвольное название абонента
• Priority - Приоритет обработки этого абонента дайлером из списка всех абонентов.
• Expire - Если абонент не был обработан до указанного времени и даты, то он автоматически исключается из дальнейшего прозвона с кодом завершения MEMBER_EXPIRED
• Communications - Список номеров телефонов, по которым можно дозвониться этому абоненту. Обратите внимание, что в рамках одной кампании не могут быть одинакове номера у разных абонентов.
• Variables - Индивидуальные переменные для данного абонента. Так же попадают в канал звонка и могут использоваться в JSON Scheme.
• Run after adding members - Если включен этот параметр, то после добавления нового абонента, кампания автоматически запуститься в работу.

Загрузка с помощью CSV файла

Для загрузки списка абонентов из файла CSV, воспользуйтесь кнопкой "Загрузить".

Image Removed

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

•  - If this option is enabled, after adding a new subscriber, the campaign will automatically start.

Upload using CSV file

To upload the list of subscribers from a CSV file, use the "Upload" button.

Image Added

In the file pre-processing window, you can specify the character set, the separator used, ignore the first line. For the necessary columns from the file, specify the destination of loading in the subscriber's card fields.

Upload using REST API

The list of clients to be dialed is transmitted via a JSON file using the POST method to the Webitel server.

Request example

Загрузка с помощью REST API

Список клиентов для прозвона передается с помощью JSON файла методом POST на сервер webitel.

Пример запроса:

POST /api/v2/dialer/571f2e2e6ea6478aba60581a/members?autoRun=true HTTP/1.1

Content-Type: application/json
X-Access-Token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NDIwMDIxNzkzNTh9
X-Key: 8fd26a17-eb28-4c74-aa6f-a3794f4f466c

{
	"name":"Мирный Евгений",
	"priority": 0,
	"timezone":"",
	"variables": {
		"debt": 20000,
		"language":"русский",
		"productID":"8fd26a17-eb28-4c74-aa6f-a3794f4f466c"
	},
    "communications":[
		{
			"number":"099998888",
			"priority":1
		}, {
			"number":"3434534534534",
			"priority":2
		}
	]
}

Body JSON

"communications": [
	{
		number: "+380890000000", 
		priority: 2
	},{
		number: "0910000000", 
		priority: 1
	}
]

"variables": {
	"language": "ru",
	"productID": "8fd26a17-eb28-4c74-aa6f-a3794f4f466c"
}

Campaign start and stop

After completing all the presets, the campaign can be started by pressing the RUN button. When the dialer processes the entire subscriber list or ends the “before” period specified in the calendar, the campaign will automatically stop. You can also stop a campaign by pressing the STOP button

Запуск и остановка кампании

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