MyOwnConference API

Разделы

Доступ к API
Команд API

Доступ к API

В этом разделе описан:

Ключ доступа
Домен доступа
Формат запросов
Формат ответов
PHP пример
Node.js пример

Ключ доступа

Для получения доступа к API платформы для проведения вебинаров MyOwnConference, используется уникальный ключ, который создается автоматически. Его можно получить в панели управления. Для этого вам необходимо зайти в нее и перейти в раздел «Профиль». Затем найти поле с названием «Ключ API».

Если есть подозрения, что кто-то ещё каким-либо образом получил доступ к вашему API ключу, то его можно сбросить, сгенерировав новый ключ. В этом случае, старый ключ API перестаёт работать автоматически. Для генерации нового ключа API необходимо нажать на кнопку обновления (две стрелочки), которая находится рядом с полем «Ключ API». ‼️ Не давайте свой ключ API никому, кроме программистов или лиц имеющих доступ к вашей панели управления ‼️

‼️‼️‼️ ВСЕ ЗАПРОСЫ К API ЗАПИСЫВАЮТСЯ И СОХРАНЯЮТСЯ В ТЕЧЕНИЕ 365 ДНЕЙ! ПОЭТОМУ, ЛЮБАЯ ПОПЫТКА ДОСТУПА К ИНФОРМАЦИИ НЕ ИЗ ВАШЕЙ УЧЁТНОЙ ЗАПИСИ, НО С ВАШИМ КЛЮЧЁМ API, ПРИВЕДЁТ К АВТОМАТИЧЕСКОЙ БЛОКИРОВКЕ ДОСТУПА К ВАШЕЙ УЧЁТНОЙ ЗАПИСИ! БЕЗ ВОЗВРАТА СРЕДСТВ И ПРИЕМА ЖАЛОБ ‼️‼️‼️

Домен доступа

Все запросы к API отправляются по протоколу HTTPS на специальный домен: api.mywebinar.com.

Формат запроса

Все запросы к API отправляются в JSON формате.

Вы ДОЛЖНЫ отправлять запросы в ЕДИНСТВЕННОЕ поле данных, называемое «request» (без кавычек), используя метод POST. Любой другой способ всегда вернет вам ОШИБКУ! Приведенный ниже исходный код PHP показывает правильную отправку запросов!

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

Для запросов к API используется следующая структура:

Запросы с именованными параметрами parameter=value

"request":
{
	"key": "%--api-key-from-your-profile--%",
	"action": "%--required-api-command--%",
	"params":
	{
		"%--parameter--%": "%--value--%",
		"%--parameter--%": "%--value--%",
		...
		"%--parameter--%": "%--value--%",
	},
},

Запросы в формате списка значений

"request":
{
	"key": "%--api-key-from-your-profile--%",
	"action": "%--required-api-command--%",
	"params":
	{
		"%--value--%",
		"%--value--%",
		...
		"%--value--%",
	},
},

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

%--api-key-from-your-profile--% --- Ключ API.
%--required-api-command--% --- Команда API.
%params% --- Дополнительные параметры команды.

Все параметры в таблице выше являются ОБЯЗАТЕЛЬНЫМИ!

Если дополнительные параметры для поля %params% отсутствуют, используйте пустой массив {}.

Формат ответа

Все ответы на запросы к API всегда возвращаются в формате JSON.

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

Ответ на запрос к API возвращает следующие данные:

Массив запрашиваемых данных, результат запроса.
Или, сообщение об успешном выполнении, в случае отсутствия результата.
Или, сообщение об ошибке с её детальным описанием.

Варианты ответов для примера запроса из пункта 1.3:

Успешное выполнение с возвращением данных

{
	"request":
	{
		"action": "%--required-api-command--%",
		"params":
		{
			"%--parameter--%": "%--value--%",
			"%--parameter--%": "%--value--%",
			...
			"%--parameter--%": "%--value--%"
		},
	},
	"response":
	{
		"%--parameter--%": "%--value--%",
		"%--parameter--%": "%--value--%",
		...
		"%--parameter--%": "%--value--%",
	},
},

Успешное выполнение без возвращения данных

{
	"request":
	{
		"action": "%--required-api-command--%",
		"params":
		{
			"%--parameter--%": "%--value--%",
			"%--parameter--%": "%--value--%",
			...
			"%--parameter--%": "%--value--%",
		},
	},
	"response":
	{
		"success": "%--message--%"
	},
},

Ошибка выполнения запроса с детальным описанием

{
	"request":
	{
		"action": "%--required-api-command--%",
		"params":
		{
			"%--parameter--%": "%--value--%",
			"%--parameter--%": "%--value--%",
			...
			"%--parameter--%": "%--value--%"
		},
	},
	"response":
	{
		"error": "%--message--%"
	},
},

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

%--required-api-command--% --- Команда.
%--value--% --- Передаваемое значение, одно значение из массива значений, результирующее значение в случае если есть результат.
%--message--% --- Сообщение об успешном или нет выполнении команды.

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

Пример на PHP

Ниже можно увидеть рабочий пример запроса к API на языке программирования PHP:

$data['request'] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => '%--required-api-command--%',
	'params' => [
		'%--parameters--%',
	],
] );

$ch = curl_init();

curl_setopt_array( $ch, [
	CURLOPT_URL => 'https://api.mywebinar.com',
	CURLOPT_POST => 1,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_RETURNTRANSFER => 1,
	CURLOPT_POSTFIELDS => $data,
] );

$result = json_decode( curl_exec( $ch ) , true );
curl_close( $ch );

// ...
// вывод результатов для теста

var_dump( $result );

Пример на JavaScript

Ниже можно увидеть рабочий пример запроса к API на языке программирования JavaScript для Node.js:

const https = require( 'https' );
const query = require( 'querystring' );

const data = query.stringify( {
	request: JSON.stringify( {
		key: '%--api-key-from-your-profile--%',
		action: '%--required-api-command--%',
		params: [
			'%--parameters--%',
		],
	} ),
} );

const options = {
	hostname: 'api.mywebinar.com',
	port: 443,
	path: '/',
	method: 'POST',
	headers:
	{
		'Content-Type': 'application/x-www-form-urlencoded',
		'Content-Length': Buffer.byteLength( data ),
	},
};

const request = https.request( options, response => {
	response.on( 'data', result => {
		process.stdout.write( '\n\n >>> we sent:\n--\n${data}\n--' );
		process.stdout.write( '\n\n <<< we read:\n--\n${result}\n--\n\n\n' );
	} );
} );

request.on( 'error', error => {
	console.error( error );
} );

request.write( data );
request.end();

Далее, для удобства описания и работы с API будут использованы примеры на языке программирования PHP.

Команды

В этом разделе описаны команды для работы с:

Профилем пользователя
Ведущими вебинаров
Участниками вебинаров
Планированием вебинаров
Автоматизацией вебинаров

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

Профиль пользователя

В этом разделе описаны команды для:

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

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

Для получения детальной или частичной информации о профиле пользователя, используется команда profileGet.

Пример получения всех параметров профиля

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'profileGet',
	'params' => [],
] );

Пример получения индивидуальных параметров профиля

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'profileGet',
	'params' => [
		'name',
		'timezone',
	],
] );

Передаваемые данные

name --- Имя и фамилия пользователя сервиса. Все приглашения на вебинары будут отправляться с использованием этого имени.
email --- Email на который зарегистрирован пользователь сервиса.
timezone --- Часовой пояс пользователя. Время всех создаваемых мероприятий будет основано на этом параметре. Тут можно посмотреть таблицу доступных часовых поясов.
timemove --- Этот параметр указывает, учитывает ли система переход на летнее время. Если в этом поле установлен параметр YES, то система будет автоматически переводить время на летнее и обратно.
language --- Язык пользователя. Этот язык будет по умолчанию использоваться для интерфейса всех планируемых в будущем вебинаров. Возможные значения: EN - английский; DE - немецкий; ES - испанский; FR - французский; PL - польский; RU - русский; UK - украинский.
gateway --- Платежная система, которую использует пользователь: PAYSERA, PAYPAL, INTERKASSA.
subscribe --- Подписка на новости сервиса. Значение YES указывает что подписка активна, NO - нет.
company --- Реквизиты компании. Если это поле не пустое, то пользователь считается юридическим лицом и имеет возможность получать счета для оплаты банковским переводов.

Получаемые данные


name --- Имя и фамилия пользователя сервиса. Все приглашения на вебинары будут отправляться с использованием этого имени.
email --- Email на который зарегистрирован пользователь сервиса.
timezone --- Часовой пояс пользователя. Время всех создаваемых мероприятий будет основано на этом параметре. Тут можно посмотреть таблицу доступных часовых поясов.
timemove --- Этот параметр указывает, учитывает ли система переход на летнее время. Если в этом поле установлен параметр YES, то система будет автоматически переводить время на летнее и обратно.
language --- Язык пользователя. Этот язык будет по умолчанию использоваться для интерфейса всех планируемых в будущем вебинаров. Возможные значения: EN - английский; DE - немецкий; ES - испанский; FR - французский; PL - польский; RU - русский; UK - украинский.
gateway --- Платежная система, которую использует пользователь: PAYSERA, PAYPAL, INTERKASSA.
subscribe --- Подписка на новости сервиса. Значение YES указывает что подписка активна, NO - нет.
company --- Реквизиты компании. Если это поле не пустое, то пользователь считается юридическим лицом и имеет возможность получать счета для оплаты банковским переводов.#### Изменение профиля пользователя

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

Пример изменения параметров профиля

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'profileSet',
	'params' => [
		'name' => '%--first-and-last-names--%',
		'timezone' => '%--timezone-in-minutes--%',
		'subscribe' => '%--yes-or-no--%',
	],
] );

Результат исполнения запроса

{
	"request":
	{
		"action": "profileSet",
		"params":
		{
			"name": "%--first-and-last-names--%",
			"timezone": "%--timezone-in-minutes--%",
			"subscribe": "%--yes-or-no--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные

name --- ФИО пользователя. Все приглашения на планируемые вебинары будут отправляться от этого имени. Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
language --- Язык пользователя. Этот язык будет по умолчанию использоваться для интерфейса всех планируемых в будущем вебинаров. Возможные значения: en - английский; de - немецкий; es - испанский; fr - французский; pl - польский; ru - русский; uk - украинский.
gateway --- Платежная система. Возможные значения: PAYSERA - платежная система Пайсера; PAYPAL - платежная система Пайпал; INTERKASSA - платежная система Интеркасса.
subscribe --- Подписка на новости сервиса. Возможные значения: YES - подписка активна, NO - подписка не активна.
company --- Реквизиты компании. Если установить НЕ пустое значение то пользователь считается юридическим лицом и получает возможность генерировать счета для оплаты банковским переводом. Допускается не более 1000 символов.
timemove --- Параметр позволяет системе автоматически учитывать переход на летнее и зимнее время при планировании вебинаров. Возможные значения: YES - учитывать переход на летнее или зимнее время, NO - не учитывать переход на летнее или зимнее время.
timezone --- Часовой пояс. Система учитывает часовой пояс пользователя при планировании вебинаров. Значения параметра устанавливаются в минутах. Значения могут быть как положительными, так и отрицательными.

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

Получаемые данные


name --- ФИО пользователя. Все приглашения на планируемые вебинары будут отправляться от этого имени. Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
language --- Язык пользователя. Этот язык будет по умолчанию использоваться для интерфейса всех планируемых в будущем вебинаров. Возможные значения: en - английский; de - немецкий; es - испанский; fr - французский; pl - польский; ru - русский; uk - украинский.
gateway --- Платежная система. Возможные значения: PAYSERA - платежная система Пайсера; PAYPAL - платежная система Пайпал; INTERKASSA - платежная система Интеркасса.
subscribe --- Подписка на новости сервиса. Возможные значения: YES - подписка активна, NO - подписка не активна.
company --- Реквизиты компании. Если установить НЕ пустое значение то пользователь считается юридическим лицом и получает возможность генерировать счета для оплаты банковским переводом. Допускается не более 1000 символов.
timemove --- Параметр позволяет системе автоматически учитывать переход на летнее и зимнее время при планировании вебинаров. Возможные значения: YES - учитывать переход на летнее или зимнее время, NO - не учитывать переход на летнее или зимнее время.
timezone --- Часовой пояс. Система учитывает часовой пояс пользователя при планировании вебинаров. Значения параметра устанавливаются в минутах. Значения могут быть как положительными, так и отрицательными.

Таблица часовых поясов, используемых в системе:

Часовой пояс	Значение параметра	Расшифровка
GMT-12:00	-720	Линия перемены даты
GMT-11:00	-660	Магадан, Соломоновы Острова, Новая Каледония
GMT-10:00	-600	Гавайи
GMT-08:00	-480	Аляска
GMT-07:00	-420	Североамериканское тихоокеанское время, Тихуана
GMT-06:00	-360	Центральная Америка, Горное время (США и Канада)
GMT-05:00	-300	Богота, Лима, Кито, Гвадалахара, Мехико, Монтеррей
GMT-04:00	-240	Восточное время (США и Канада), Каракас, Ла-Пас
GMT-03:00	-180	Атлантическое время (Канада), Буэнос-Айрес, Джорджтаун
GMT-02:30	-150	Бразилия
GMT-02:00	-120	Среднеатлантическое время, Сантьяго
GMT-01:00	-60	Острова Кабо-Верде
GMT-00:00	0	Дублин, Эдинбург, Лиссабон, Лондон, Азорские острова
GMT+01:00	60	Канарские острова, Касабланка, Монровия, Западная Центральная Африка
GMT+02:00	120	Амстердам, Берлин, Берн, Рим, Стокгольм, Вена, Белград, Братислава, Будапешт, Любляна, Прага, Брюссель, Копенгаген, Мадрид, Париж, Сараево, Скопье, Варшава, Загреб
GMT+03:00	180	Калининград, Хельсинки, Киев, Рига, София, Таллин, Вильнюс, Стамбул, Афины, Стамбул, Минск, Баку, Тбилиси, Ереван, Иерусалим, Бухарест
GMT+03:30	240	Кувейт, Эр-Рияд, Абу-даби, Маскат, Москва, Минск
GMT+04:00	270	Тегеран, Кабул
GMT+04:30	300	Екатеринбург, Исламабад, Карачи, Ташкент
GMT+05:00	330	Ченнаи, Калькутта, Мумбаи, Нью-Дели, Шри Джаяварденепура
GMT+05:30	345	Катманду
GMT+05:45	360	Алматы, Новосибирск, Астана, Дакка
GMT+06:00	390	Янгон
GMT+06:30	420	Красноярск, Бангкок, Ханой, Джакарта
GMT+07:00	480	Иркутск, Улан-Батор, Куала-Лумпур, Сингапур, Пекин, Чунцин, САР Гонконг, Урумчи
GMT+08:00	540	Якутск, Осака, Саппоро, Токио, Сеул
GMT+09:00	570	Аделаида, Дарвин
GMT+09:30	600	Владивосток, Брисбен, Хобарт, Канберра, Мельбурн, Брисбен, Канберра, Мельбурн, Сидней, Гуам, Порт-Морсби
GMT+10:00	660	Магадан, Соломоновы Острова, Новая Каледония
GMT+11:00	720	Окленд, Веллингтон, Камчатка, Фиджи, Маршалловы острова
GMT+12:00	780	Кирибати, Самоа, Тонга

Ведущие вебинаров

В этом разделе описаны команды для:


Создания ведущих
Удаления ведущих
Изменения ведущих
Получения списка ведущих
Прикрепления ведущих на будущие вебинары
Открепления ведущих с будущих вебинаров
Получения списка вебинаров, на которые прикреплен ведущий

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

Создание ведущих

Для создания нового ведущего используется команда moderatorsCreate.

Пример ниже создаёт ведущего

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsCreate',
	'params' => [
		'name' => '%--first-and-last-names--%',
		'email' => '%--email-address-at-domain-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsCreate",
		"params":
		{
			"name": "%--first-and-last-names--%",
			"email": "%--email-address-at-domain-com--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные

name --- ФИО ведущего. Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
email --- Електронная почта ведущего. Допустимое количество символов от 6 до 128.

Удаление ведущих

Для удаления ведущих используется команда moderatorsDelete.

Пример ниже удаляет одного ведущего с заданным емейлом

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsDelete',
	'params' => [
		'%--email-address-at-domain-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsDelete",
		"params":
		[
			"%--email-address-at-domain-com--%",
		],
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsDelete',
	'params' => [
		'%--email-address-at-domain-com--%',
		'%--email-address-at-domain-com--%',
		...
		'%--email-address-at-domain-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsDelete",
		"params":
		[
			"%--email-address-at-domain-com--%",
			"%--email-address-at-domain-com--%",
			...
			"%--email-address-at-domain-com--%",
		],
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные
email --- Електронная почта ведущего. Допустимое количество символов от 6 до 128. Или массив емейлов.

Изменение ведущих

Для изменения ФИО ведущего, емейла или загрузки нового аватара, используется команда moderatorsSet.

Пример ниже изменяет ФИО и емейл для выбранного ведущего

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsSet',
	'params' => [
		'email' => '%--current-email-address-at-domain-com--%',
		'newEmail' => '%--new-email-address-at-domain-com--%',
		'newName' => '%--first-and-last-name--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsSet",
		"params":
		{
			"email": "%--current-email-address-at-domain-com--%",
			"newEmail": "%--new-email-address-at-domain-com--%",
			"newName": "%--first-and-last-name--%"
		},
	},
	"response": {
		"success": "%--message--%",
	},
},

Передаваемые данные

email --- Емейл ведущего данные которого требуется изменить. Допустимое количество символов от 6 до 128.
newEmail --- Новый емейл ведущего данные которого требуется изменить. Допустимое количество символов от 6 до 128.
newName --- Новое ФИО ведущего. Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
avatar --- Изображение, которое будет установлено в качестве аватара в окне камеры ведущего. Камера при этом будет отключена.

Изображение для аватара необходимо закодировать в формате Base64. Допустимые форматы изображений: JPG, JPEG, PNG.

Для ручного кодирования изображений в формат Base64 можно использовать команду:

$cat /path/to/file/test.png | base64

Получение списка ведущих

Для получения общего списка ведущих используется команда moderatorsList.

Пример ниже получает список всех ведущих с полной информацией

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsList',
	'params' => [
		'fields' => [],
	],
] );

Пример ниже получает список всех ведущих, с частичной информацией, в частности только ФИО

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsList',
	'params' => [
		'fields' => [
			'name',
		],
	],
] );

Пример ниже получает список всех ведущих для конкретного вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsList',
	'params' => [
		'fields' => [],
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

Пример ниже получает список всех ведущих с фильтром по имени и по емейлу

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsList',
	'params' => [
		'fields' => [],
		'search' => '%--search-text--%',
	],
] );

Все четыре варианта могут быть скомпонованы вместе.

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsList",
		"params":
		{
			"fields":
			[
				"email",
				"name",
			],
			"search": "%--search-text--%", -- в случае, если добавлен текст для поиска
		},
	},
	"response":
	[
		{
			"email": "%--email-address-at-domain-com--%",
			"name": "%--first-and-last-name-of-moderator--%",
		},
		{
			"email": "%--email-address-at-domain-com--%",
			"name": "%--first-and-last-name-of-moderator--%",
		},
		...
		{
			"email": "%--email-address-at-domain-com--%",
			"name": "%--first-and-last-name-of-moderator--%",
		},
	],
},

Передаваемые данные

fields --- Список полей, которые хотелось бы получить при выборке. Параметр не является обязательным, может быть опущен или установлен пустым [].
alias --- Уникальный ID вебинара, который можно получить из ссылки на вебинар при его планировании. Параметр не является обязательным, может быть опущен или установлен с пустым значением "".
search --- Поисковый запрос. Набор символов для поиска по имени и по емейлу ведущего. Параметр не является обязательным, может быть опущен или установлен с пустым значением "".


Получаемые данные

name --- ФИО ведущего. Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
email --- Емейл ведущего. Допустимое количество символов от 6 до 128.
registered --- Дата регистрации ведущего, включая год-месяц-день часы:минуты:секунды.
main --- Флаг, указывающий тип ведущего: YES - главный ведущий, NO - нет.
avatar --- Флаг, указывающий на использование аватара вместо камеры ведущего: YES - используется аватар, NO - камера, по умолчанию.

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

Прикрепление ведущих на вебинар

ВНИМАНИЕ: Здесь и далее под словом "прикрепление" подразумевается назначение указанного ведущего, модератором и/или ведущим данного вебинара. Такой ведущий будет получать приглашения с ссылками на вебинар и другие напоминания о запланированном вебинаре.

Для прикрепления одного или нескольких ведущих от вебинара, используется команда moderatorsAddToWebinar.

Пример ниже прикрепляет указанного ведущего на вебинар

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsAddToWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => [
			'%--email-address-at-domain-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsAddToWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email":
			[
				"%--email-address-at-domain-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsAddToWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => [
			'%--email-address-at-domain-com--%',
			'%--email-address-at-domain-com--%',
			...
			'%--email-address-at-domain-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsAddToWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email":
			[
				"%--email-address-at-domain-com--%",
				"%--email-address-at-domain-com--%",
				...
				"%--email-address-at-domain-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные

alias --- Уникальный ID вебинара, на который нужно добавить ведущих и который можно получить из ссылки на вебинар при его планировании.
email --- Один или несколько емейлов по которым зарегистрированы ведущие в системе. Допустимое количество символов от 6 до 128.
sendInvite --- Необязательный параметр, в который можно передать значения YES или NO. Значение YES будет означать, что ведущий сразу же получит приглашение с ссылкой на запланированный вебинар. Значение NO - приглашение будет отправлено по общему расписанию.

Открепление ведущих от вебинара

ВНИМАНИЕ: Здесь и далее под словом "открепление" подразумевается удаление прав доступа к вебинару указанного ведущего. Такой ведущий больше не будет получать приглашения с ссылками на вебинар или иметь какой-либо другой доступ на мероприятие.

Для открепления одного или нескольких ведущих от вебинара, используется команда moderatorsRemoveFromWebinar.

Пример ниже открепляет ведущего от вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsRemoveFromWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => [
			'%--email-address-at-domain-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsRemoveFromWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email": "%--email-address-at-domain-com--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsRemoveFromWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => [
			'%--email-address-at-domain-com--%',
			'%--email-address-at-domain-com--%',
			...
			'%--email-address-at-domain-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsRemoveFromWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email":
			[
				"%--email-address-at-domain-com--%",
				"%--email-address-at-domain-com--%",
				...
				"%--email-address-at-domain-com--%",
			],
		},
	},
	"response":
	{
		"success": "%message%",
	},
},

Передаваемые данные

alias --- Уникальный ID вебинара, с которого нужно открепить ведущих и который можно получить из ссылки на вебинар при его планировании.
email --- Один или несколько емейлов с которыми зарегистрированы ведущие в системе. Допустимое количество символов от 6 до 128.

Получение списка вебинаров, на которые прикреплен ведущий

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

Пример ниже возвращает всю информацию о вебинарах к которым прикреплен заданный ведущий

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'moderatorsRooms',
	'params' => [
		'email' => '%--email-address-at-domain-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "moderatorsRooms",
		"params":
		{
			"email": "%--email-address-at-domain-com--%",
		},
	},
	"response":
	[
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--wwebinar-name-or-topic--%",
			"description": "%--html-formatted-webinar-description--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"timezone": "%--timezone-in-minutes--%", 
			"duration": "%--webinar-duration-in-minutes--%",
			"moderatorLink": "%--https-access-url-for-the-moderator--%"
		},
		... ведущий может быть прикреплен к любому количеству вебинаров
	]
}

Передаваемые данные

alias --- Уникальный ID вебинара для которого выполняется данная команда API.

Получаемые данные

email --- Емейл по которому зарегистрирован ведущий в системе. Допустимое количество символов от 6 до 128.
name --- Название или тема вебинара.
description --- Описание вебинара. Может быть пустым
start --- Дата и время проведения вебинара.
timezone --- Часовой пояс по которому проводится вебинар.
duration --- Планируемая длительность вебинара. Длительность вебинара в минутах. Максимальное значение 1439.
moderatorLink --- Ссылка входа ведущего.


Некоторые ведущие могут делиться своей ссылкой на вебинар и потом жаловаться на то, что: 1 - их выбивает из вебинарной комнаты, 2 - не могут зайти, 3 - кто-то уже зашел под их именем. Поэтому, помните, ссылка каждого ведущего ИНДИВИДУАЛЬНАЯ и предназначена для доступа в комнату только конкретно этого ведущего. Вход другим человеком по той же ссылке ЗАПРЕЩЕН! Повторный вход в вебинарную комнату ВСЕГДА будет отключать предыдущий!

Участники вебинаров

В этом разделе описаны команды для:

Создания участников
Редактирования участников
Удаления участников
Получения общего списка участников
Прикрепления участников на будущие вебинары
Открепления участников от будущих вебинаров
Получения списка вебинаров, на которые прикреплены участники
Создания группы участников
Переименования группы участников
Удаления группы участников
Получения списка групп участников
Добавления участников в группы
Удаления участников из групп
Получения списка групп, в которых присутствуют участники
Удаления участников из списка заблокированных

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

Создание участников

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

Пример ниже создает нового участника

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesCreate',
	'params' => [
		'email' => '%--attendee-email-at-domain-dot-com--%',
		'name' => '%--attendee-first-and-last-name--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesCreate",
		"params":
		{
			"email": "%--attendee-email-at-domain-dot-com--%",
			"name": "%--attendee-first-and-last-name--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные


name --- ФИО участника. Допустимое количество до 64 символов, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
email --- Емейл участника. Допустимое количество символов от 6 до 128 можно использовать английские буквы и цифры.

Редактирование участников

Для изменения данных участника, используется команда attendeesSet.

Пример ниже изменяет личные данные ранее созданного участника

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesSet',
	'params' => [
		'email' => '%--attendee-email-at-domain-dot-com--%',
		'newemail' => '%--attendee-new-email-at-domain-dot-com--%',
		'name' => '%--attendee-first-and-last-name--%',
		'phone' => '%--attendee-phone-number--%',
		'skype' => '%--attendee-skype--%',
		... etc ...
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesSet",
		"params":
		{
			"email": "%--attendee-email-at-domain-dot-com--%",
			"newemail": "%--attendee-new-email-at-domain-dot-com--%",
			"name": "%--attendee-first-and-last-name--%",
			"phone": "%--attendee-phone-number--%",
			"skype": "%--attendee-skype--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные

email --- Емейл участника. Допустимое количество английских букв и цифр от 6 до 128.
newemail --- Новый емейл участника. Допустимое количество английских букв и цифр от 6 до 128.
name --- ФИО участника. Допустимое количество символов до 10 символов, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
phone --- Телефон участника. Допустимое количество символов 16.
skype --- Скайп участника. Допустимы символы английского алфавита, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
company --- Компания. Допустимы любые символы, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
department --- Департамент. Допустимы любые символы, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
city --- Город. Допустимы любые символы, кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
born --- Дата рождения формат yyyy-mm-dd

Количество дополнительных полей с данными может отличаться от приведенных в таблице выше

Удаление участников

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

Пример ниже удаляет указанного участника

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesDelete',
	'params' => [
		'%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesDelete",
		"params":
		[
			"%--attendee-email-at-domain-dot-com--%",
		],
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Пример ниже удаляет несколько участников

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesDelete',
	'params' => [
		'%--attendee-email-at-domain-dot-com--%',
		'%--attendee-email-at-domain-dot-com--%',
		...
		'%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesDelete",
		"params":
		[
			"%--attendee-email-at-domain-dot-com--%",
			"%--attendee-email-at-domain-dot-com--%",
			...
			"%--attendee-email-at-domain-dot-com--%",
		],
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Передаваемые данные

email --- Емейл участника либо массив емейлов удаляемых участников. Допустимое количество символов от 6 до 128 можно использовать только английские буквы и цифры.

Получение списка участников

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

Пример ниже получает список всех участников

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesList',
	'params' => [
		'fields' => [
			'email',
			'link',
			...
		] ,
		'onРage' => '%--amount-of-attendees-per-query--%',
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'search' => '%--search-text--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesList",
		"params":
		{
			"onРage": "%--amount-of-attendees-per-query--%",
		},
	},
	"response":
	{
		"count": "%--total-amount-of-attendees--%",
		"list": [
			{
				"name": "%--attendee-first-and-last-name--%",
				"email": "%--attendee-email-at-domain-dot-com--%",
			},
			{
				"name": "%--attendee-first-and-last-name--%",
				"email": "%--attendee-email-at-domain-dot-com--%",
			},
			...
			{
				"name": "%--attendee-first-and-last-name--%",
				"email": "%--attendee-email-at-domain-dot-com--%",
			},
		],
	},
},

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

fields --- Список полей, которые нужно получить. Параметр не обязателен. Если его не указать, будут возвращены только поля name и email. Список возможных значений поля:
onPage --- Сколько участников вернуть за один запрос на странице. По умолчанию - 100, если параметр не указан будет получен список без разделения на страницы
alias --- Уникальный ID вебинара
search --- Набор символов, который должен содержатся в имени или email участника
page --- Номер страницы, которую нужно вернуть
order --- Сортировка ASC - по возрастанию и DESC - по убыванию. По умолчанию - ASC
orderField --- Поле, по которому нужно выполнить сортировку. name, email, creation_date. По умолчанию - name.
type --- Тип участника: ACTIVE - активен; PENDING - неактивен; BANNED - заблокирован.
imported --- Каким способом участники были добавлены в систему. YES - ручное добавление владельцем аккаунта, NO - самостоятельная регистрация.
webinars --- Мероприятия, массив алиасов на которых был или не были участники
webinarsOrder --- Был ли участник на вебинарах, которые перечислены в параметре webinars. IN - был на вебинаре, OUT - не был на вебинаре.
withEmail --- Возвращать участников с email или без email. YES - возвращать только тех участников, у которых есть email, NO - возвращать только тех участников, у которых нет email. Если параметр не указан, возвращается весь список
group --- id группы, к которой привязаны участники.

возможные значения поля fields

name --- ФИО участника Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
email --- Емейл участника Допустимое количество символов от 6 до 128.
phone --- Телефон участника. Допустимое количество символов от 6 до 128.
skype --- Скайп участника. Допустимое количество символов от 6 до 128.
company --- Компания. Допустимое количество символов от 6 до 128.
department --- Департамент. Допустимое количество символов от 6 до 128.
city --- Город. Допустимое количество символов от 6 до 128.
born --- Дата рождения.
creation_date --- Дата добавления.
country --- Страна участника.
type --- Тип участника: ACTIVE - активен, PENDING - неактивен, BANNED - заблокирован.
notified --- Количество ранее отправленных приглашений на вебинары.
link --- Ссылка для входа на вебинар. Это поле доступно, только если указан параметр alias.

Прикрепление участников на будущие вебинары

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

Пример ниже прикрепляет указанного участника к вебинару

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesAddToWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request": {
		"action": "attendeesAddToWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Пример ниже прикрепляет несколько участников к вебинару

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesAddToWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
			'%--attendee-email-at-domain-dot-com--%',
			...
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request": {
		"action": "attendeesAddToWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
				"%--attendee-email-at-domain-dot-com--%",
				...
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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


alias --- Уникальный ID вебинара для которого выполняется данная команда API.
attendees --- Массив емейлов участников, которые будут прикреплены к вебинару.

Открепление участников от будущих вебинаров

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

Пример ниже открепляет указанного участника от вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesRemoveFromWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request": {
		"action": "attendeesRemoveFromWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Пример ниже открепляет несколько участников от вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesRemoveFromWebinar',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
			'%--attendee-email-at-domain-dot-com--%',
			...
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request": {
		"action": "attendeesRemoveFromWebinar",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
				"%--attendee-email-at-domain-dot-com--%",
				...
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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


alias --- Уникальный ID вебинара для которого выполняется данная команда API.
attendees --- Массив емейлов участников, которые будут откреплены от вебинара.

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

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

Пример ниже получает список всех вебинаров на которые был прикреплен указанный участник

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesRooms',
	'params' => [
		'email' => '%--attendee-email-at-domain-dot-com',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesRooms",
		"params":
		{
			"email": "%--attendee-email-at-domain-dot-com",
		}
	},
	"response":
	[
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--webinar-name-or-topic--%",
			"description": "%--webinar-html-formatted-description--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"timezone": "%--timezone-in-minutes--%",
			"duration": "%--webinar-duration-in-minutes--%",
			"attendeeLink": "%--https-access-url-for-the-attendee--%"
		},
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--webinar-name-or-topic--%",
			"description": "%--webinar-html-formatted-description--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"timezone": "%--timezone-in-minutes--%",
			"duration": "%--webinar-duration-in-minutes--%",
			"attendeeLink": "%--https-access-url-for-the-attendee--%"
		},
		...
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--webinar-name-or-topic--%",
			"description": "%--webinar-html-formatted-description--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"timezone": "%--timezone-in-minutes--%",
			"duration": "%--webinar-duration-in-minutes--%",
			"attendeeLink": "%--https-access-url-for-the-attendee--%"
		},
	],
},

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

email --- Емейл участника для которого необходимо получить список вебинаров. Допустимое количество символов от 6 до 128.
alias --- Уникальный ID вебинара для которого выполняется данная команда API.
name --- Название или тема вебинара.
description --- Описание вебинара, в случае, может отсутствовать.
start --- Дата и время начала вебинара. Текст в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.
timezone --- Часовой пояс по которому проводится вебинар.
duration --- Ориентировочная длительность вебинара в минутах. Максимальное значение 1439.
attendeeLink --- Ссылка на вход в вебинарную комнату.

Создание группы участников

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

Пример ниже создаёт новую группу

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesCreateGroup',
	'params' => [
		'name' => '%--attendee-group-name--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesCreateGroup",
		"params":
		{
			"name": "%--attendee-group-name--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
		"group_id": "%--attendee-group-id--%",
	},
},

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

name --- Имя создаваемой группы участников.
group_id --- ID созданной группы участников.

Переименование группы участников

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

Пример ниже переименовывает группу участников

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesGroupsRename',
	'params' => [
		'id' => '%--attendee-group-id--%'
		'newname' => '%--attendee-groun-new-name--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesGroupsRename",
		"params":
		{
			"id": "%--attendee-group-id--%",
			"newname": "%--attendee-groun-new-name--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

id --- ID группы участников. Можно получить во время создания группы параметр attendeesCreateGroup или через получения списка групп attendeesGroupsList.
newname --- Новое имя группы участников.

Удаление группы участников

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

Пример ниже удаляет ранее созданную группу по указанному идентификатору

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesDeleteGroup',
	'params' => [
		'id' => '%--attendee-group-id--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesDeleteGroup",
		"params":
		{
			"id": "%--attendee-group-id--%",
		},
	},
	"response": {
		"success": "%--message--%",
	},
},

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

id --- ID группы участников. Можно получить во время создания группы параметр attendeesCreateGroup или через получения списка групп attendeesGroupsList.

Получение списка групп участников

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

Пример ниже получает список всех групп

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesGroupsList',
	'params' => [],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesGroupsList",
		"params": [],
	},
	"response":
	[
		[
			{
				"id": "%--attendee-group-id--%",
				"name": "%--attendee-group-name--%",
			},
			{
				"id": "%--attendee-group-id--%",
				"name": "%--attendee-group-name--%",
			},
			...
			{
				"id": "%--attendee-group-id--%",
				"name": "%--attendee-group-name--%",
			},
		],
	],
},

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

id --- ID группы.
name --- Название группы.

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

Для добавления участников в ранее созданную группу, используется команда attendeesAssignToGroup.

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesAssignToGroup',
	'params' => [
		'group_id' => '%--attendee-group-id--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesAssignToGroup",
		"params":
		{
			"group_id": "%--attendee-group-id--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Пример ниже добавляет несколько участников в группу

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesAssignToGroup',
	'params' => [
		'group_id' => '%--attendee-group-id--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
			'%--attendee-email-at-domain-dot-com--%',
			...
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesAssignToGroup",
		"params":
		{
			"group_id": "%--attendee-group-id--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
				"%--attendee-email-at-domain-dot-com--%",
				...
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

group_id --- ID группы участников. Можно получить во время создания группы параметр attendeesCreateGroup или через получения списка групп attendeesGroupsList.
attendees --- Массив емейлов участников, которых необходимо добавить в группу.

Удаление участников из группы

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

Пример ниже удаляет указанного участника из группы

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesUnAssignFromGroup',
	'params' => [
		'group_id' => '%--attendee-group-id--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesUnAssignFromGroup",
		"params":
		{
			"group_id": "%--attendee-group-id--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesUnAssignFromGroup',
	'params' => [
		'group_id' => '%--attendee-group-id--%',
		'attendees' => [
			'%--attendee-email-at-domain-dot-com--%',
			'%--attendee-email-at-domain-dot-com--%',
			...
			'%--attendee-email-at-domain-dot-com--%',
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesUnAssignFromGroup",
		"params":
		{
			"group_id": "%--attendee-group-id--%",
			"attendees":
			[
				"%--attendee-email-at-domain-dot-com--%",
				"%--attendee-email-at-domain-dot-com--%",
				...
				"%--attendee-email-at-domain-dot-com--%",
			],
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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


group_id --- ID группы участников. Можно получить во время создания группы параметр attendeesCreateGroup или через получения списка групп attendeesGroupsList.
attendees --- Массив емейлов участников, которых необходимо удалить из группы.

Получение списка групп, в которых присутствует участник

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

Пример ниже получает список групп для указанного участника

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesCommonGroups',
	'params' => [
		'%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesCommonGroups",
		"params":
		[
			"%--attendee-email-at-domain-dot-com--%",
		],
	},
	"response":
	[
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
		...
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
	],
},

Пример ниже получает список групп для нескольких участников сразу

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesCommonGroups',
	'params' => [
		'%--attendee-email-at-domain-dot-com--%',
		'%--attendee-email-at-domain-dot-com--%',
		...
		'%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesCommonGroups",
		"params":
		[
			"%--attendee-email-at-domain-dot-com--%",
			"%--attendee-email-at-domain-dot-com--%",
			...
			"%--attendee-email-at-domain-dot-com--%",
		],
	},
	"response":
	[
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
		...
		{
			"id": "%--attendee-group-id--%",
			"name": "%--attendee-group-name--%",
		},
	],
},

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

attendee-email-at-domain-dot-com --- Массив емейлов участников, которых необходимо добавить в группу.

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

Удаление участников из списка заблокированных

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

Пример ниже разблокирует указанного участника

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesUnbanned',
	'params' => [
		'email' => '%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesUnbanned",
		"params":
		{
			"email": "%--attendee-email-at-domain-dot-com--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

Пример ниже разблокирует одновременно несколько участников

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'attendeesUnbanned',
	'params' => [
		'email' => '%--attendee-email-at-domain-dot-com--%',
		'email' => '%--attendee-email-at-domain-dot-com--%',
		...
		'email' => '%--attendee-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "attendeesUnbanned",
		"params":
		{
			"email": "%--attendee-email-at-domain-dot-com--%",
			"email": "%--attendee-email-at-domain-dot-com--%",
			...
			"email": "%--attendee-email-at-domain-dot-com--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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


email --- Емейл или массив емейлов участников, с которых необходимо необходимо снять блокировку.

Вебинары

В этом разделе описаны команды для:

Планирования и создание вебинара
Изменения настроек вебинара
Удаления вебинара
Клонирования вебинара
Получения списка запланированных вебинаров
Получения детальной информации для вебинара
Получения данных по рассылке приглашений для вебинара
Изменения параметров рассылки приглашений для вебинара
Отключения рассылок для вебинара
Включения рассылок для вебинара
Получения списка участников на активном вебинаре
Получения списка записей вебинара
Удаления записи вебинара
Получения списка материалов загруженных на вебинар
Получения истории посещений вебинара


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

Планирование и создание вебинара

Для создания планируемого вебинара, используется команда webinarsCreate.

Пример ниже создает вебинар

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' =>'webinarsCreate',
	'params' => [
		'name' => '%--webinar-name-or-topic--%',
		'start' => '%--year-month-day-hours-minutes-seconds--%',
		'duration' => '%--webinar-duration-in-minutes--%',
	]
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsCreate",
		"params":
		{
			"name": "%--webinar-name-or-topic--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"duration": "%--webinar-duration-in-minutes--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
		"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		"webinarLink": "%--https-access-url-to-the-webinar--%",
		"mainModeratorLink": "%--https-access-url-for-the-main-moderator--%",
	},
},

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


alias --- Уникальный ID вебинара для которого выполняется данная команда API.
name --- Имя или тема вебинара.
description --- Описание вебинара.
start --- Дата и время начала вебинара. Текст в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.
duration --- Ориентировочная длительность вебинара в минутах. Максимальное значение 1439.
webinarLink --- Публичная ссылка на вебинар.
mainModeratorLink --- Ссылка на вебинар для главного ведущего.

Изменение параметров планируемого вебинара

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

Пример ниже изменяет часть настроек для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsSet',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'name' => '%--webinar-name-or-topic--%',
		... - дополнительные данные смотрите в таблице ниже
		'language' => '%--webinar-room-language--%',
		'settings' => [
			'cameraSize' => '%--mini-middle-big--%',
			'userList' => '%--yes-or-no--%',
			'loginfields' => [
				'name',
				'email',
				... - в зависимости от необходимых полей
			],
			'recordWhole' => "%--record-whole-area-chat-webcam--%",
			"recordUsers" => "%--yes-or-no--%",
			"recordQuality" => "%--0-1-2-3-4--%",
			... - количество данных может меняться
		],
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsSet",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--webinar-name-or-topic--%",
			"language": "%--webinar-room-language--%",
			"settings":
			{
				"cameraSize": "%--camera-size--%",
				"userList": "%--yes-or-no--%",
				"loginfields":
				[
					"name",
					"email"
				],
				"recordWhole": "",
				"recordUsers": "%--yes-or-no--%",
				"recordQuality": "%--0-1-2-3-4--%",
				...
			},
			...
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
name --- Название или тема для вебинара.
description --- Расширенное описание вебинара в HTML формате. Рараметр не обязателен.
start --- Дата и время начала вебинара в часовом поясе, который указан в разделе Профиль. Текст в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.
duration --- Длительность вебинара в минутах. Максимальное значение 1439.
close --- YES - закрытый вебинар, или NO - открытый вебинар.
language --- Двухбуквенный код языка в комнате. На этом языке будет отображаться интерфейс вебинара по умолчанию у ведущих и у слушателей. Возможные значения параметра: be - белорусский; bg - болгарский; de - немецкий; en - английский; es - испанский; et - эстонский; fr - французский; it - итальянский; lt - литовский; lv - латышский; pl - польский; pt - португальский; ru - русский; sl - словенский; tr - турецкий; uk - украинский.
logo --- Логотип для вебинарной комнаты. Картинка в формате Base64.
logotype_url --- Ссылка на страницу, которая будет появляться при клике на логотип.
banner --- Баннер для вебинарной комнаты. Картинка в формате Base64.
banner_url --- Ссылка на страницу, которая будет появляться при клике на баннер.
google_id --- ID для кода Google Analytics.
settings --- Расширенные настройки комнаты. Допустимые параметры:


webcamPosition --- Расположение камеры ведущего: LEFT - камера слева над чатом, RIGHT - камера справа над чатом.
themebg --- Цвет общего фона в вебинарной комнате. Значения цветов в формате HEX, например #f2f2f2.
themetext --- Цвет иконок и текста в вебинарной комнате. Значения цветов в формате HEX, например #d3d3d3.
userList --- Показывать или не показывать участникам список пользователей в комнате. YES показывать список гостей участникам, NO не показывать список.
flags --- Показывать или не показывать флаги стран в списке пользователей в комнате. YES показывать флаги,`NO` не показывать флаги. Параметр не сработает если для userList установлено`NO`.
buttonQuestion --- Показывать или не показывать кнопку Задать вопрос в меню участника на вебинаре. YES показывать, NO не показывать.
buttonVoice --- Показывать или не показывать кнопку Попросить слово в меню участника на вебинаре. YES показывать, NO не показывать.
chat --- Показывать или не показывать гостям поле чата. YES отображать, участники могут отправлять сообщения в чате. NO не отображать, участники не могут отправлять сообщения в чате.
showBeforeTimer --- Показывать или не показывать таймер обратного отсчета времени до начала вебинара. YES таймер отображаеться, NO таймер не отображается.
showLoginStart --- Показывать или не показывать время начала мероприятия на странице входа на вебинар. YES время начала будет отображаться, NO время начала не будет отображаться.
showLoginName --- Показывать или не показывать название вебинара на странице входа на вебинар. YES название будет отображаться, NO название вебинара не отображается.
showLoginModerators --- Показывать или не показывать список ведущих на странице входа на вебинар. YES список ведущих отображается, NO список отсутствует.
showSocialButtons --- Показывать или не показывать на странице входа кнопки входа через социальные сети. YES кнопки входа отображаются, NO данные кнопки отсутствуют.
showLoginCounter --- Показывать количество свободных мест на вебинаре на странице входа. YES показывать количество свободных мест, NO не показывать количество свободных мест.
group --- Наличие данного параметра отвечает за то, будут ли участники собраны в Группу id группы, используйте команду `AttendeesGroupsList` для получения id группы.
loginfields --- Список полей для ввода на странице входа на вебинар и их последовательность. Параметр может содержать такие эелементы: name - поле для ввода имени; email - поле ввода email (если параметр отсутствует, участник не появится в разделе участников в панели управления, он будет только в статистике этого вебинара); phone - поле для ввода номера телефона; skype - поле для ввода логина Skype; city - поле для ввода названия города; company - поле для ввода названия организации; department - поле ввода названия отдела; born - поле ввода даты рождения.
beforeStartTime --- Время за сколько минут до начала мероприятия система начнет пускать участников на вебинар. Время в минутах от 5 до 60.
cameraSize --- Размер камеры на вебинаре. mini маленькая `middle`средняя, big большая - в настройках мероприятия параметр называется Размер чата
emailIdntLogin --- Активация режима именных ссылок для входа на вебинар YES активировать режим, NO отключить режим.
emailIdntRecord --- Активация режима именных ссылок для просмотра записи YES активировать режим NO выключить режим.
режим записи. --- Существует несколько режимов записи. Чтобы установить нужный режим записи, нужно в режим передать как ключ - массив с пустым значением. Например, recordWebCams => "". Список режимов: recordWebCams - запись только камер; recordAreaNoChat - запись камеры, микрофона, чата и области показа материалов; recordArea - запись камеры, микрофона и области показа материалов; recordWhole - запись всей комнаты. Может принимать значения: recordUsers - активация записи списка участников вебинара. При изменении этого параметр активируется режим записи recordWhole. YES в записи будет присутствовать список участников. NO в записи не будет списка пользователей. recordModer - на камере ведущего в записи будет отображено имя ведущего. При изменении этого параметра автоматически будет установлен режим записи recordWhole. YES в записи на камерах ведущих будут отображены их имена. `NO`в записи не будут показаны имена ведущих. recordChat - при активации данного режима в записи будет присутствовать чат. YES в записи будет показан чат. NO в записи чат отсутствует.
recordQuality - Установка уровня качества записи: 0 - запись будет проводиться в разрешении 480p [800x460]; 1 - запись будет проводиться в разрешении 720p [1280x720]; 2 - запись будет проводиться в разрешении 1080p [1920x1080] - этот уровень качества доступен только на платных тарифах; 3 - запись будет проводиться в разрешении 2K [2048x1080] - этот уровень качества доступен в тарифах от 500 участников.
sendRecord --- Отправка ссылки на просмотр записи вебинара после окончания мероприятия. YES запись будет автоматически отправлена участникам после вебинара. NO запись не отправляется.
sendRecordTo --- Параметр определяет, кому отправлять ссылку на запись после окончания вебинара. По умолчанию, если параметр активен, запись отправляется всем пользователям, зарегистрированным в качестве участников вебинара. all - отправить запись всем. visit - отправить запись всем, кто был на вебинаре. miss - отправить запись всем, кто не был на вебинаре.

Удаление вебинара

Для полного удаления запланированного ранее вебинара, используется команда webinarsDelete.

Пример ниже удаляет указанный вебинар

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsDelete',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsDelete",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response": {
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.

Клонирование вебинара

Для клонирования ранее созданного вебинара, используется команда webinarsClone.

Пример ниже создает копию запланированного ранее вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsClone',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'date' => '%--year-month-day--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsClone",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"date": "%--year-month-day--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
		"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		"webinarLink": "%--https-access-url-to-the-webinar--%",
		"mainModeratorLink": "%--https-access-url-for-the-main-moderator--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
date --- Дата создаваемого мерпориятия.
webinarLink --- Ссылка на создаваемое мероприятия.
mainModeratorLink --- Ссылка гавного ведущего на вход на мероприятие.

Получение списка запланированных вебинаров

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

Пример ниже возвращает список вебинаров

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsList',
	'params' => [
		'fields' => [
			'name',
			'alias'
		],
		'status' => '%--active-or-finished--%',
		'date' => '%--year-month-day-hours-minutes-seconds--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsList",
		"params":
	{
			"fields":
			[
				"name",
				"alias"
			],
			"status": "%--active-or-finished--%",
			"date": "%--year-month-day-hours-minutes-seconds--%",
		},
	},
	"response":
	[
		{
			"name": "%--webinar-name-or-topic--%",
			"description": "%--html-formatted-webinar-description--%",
			"created": "%--year-month-day-hours-minutes-seconds--%",
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"language": "%--webinar-room-language--%",
		},
		{
			"name": "%--webinar-name-or-topic--%",
			"description": "%--html-formatted-webinar-description--%",
			"created": "%--year-month-day-hours-minutes-seconds--%",
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"language": "%--webinar-room-language--%",
		},
		...
		{
			"name": "%--webinar-name-or-topic--%",
			"description": "%--html-formatted-webinar-description--%",
			"created": "%--year-month-day-hours-minutes-seconds--%",
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"start": "%--year-month-day-hours-minutes-seconds--%",
			"language": "%--webinar-room-language--%",
		},
	],
},

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

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


status --- Фильтр по статусу вебинара: ACTIVE - вебинары, которые идут или будут идти; FINISHED - вебинары, которые завершены.
date --- Фильтр по дате. Выбор всех вебинаров за определенный день. Текст дата в формате ГГГГ-ММ-ДД.
name --- Название или тема для вебинара. Текст темы вебинара.
description --- Текст описания вебинара. Может быть пустым.
created --- Дата создания вебинара. Описываться в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС по GMT 0.
alias --- Уникальный ID вебинара для которого выполняется данная команда API.
start --- Дата и время начала в часовом поясе, который указан в Профиле. Формат ГГГГ-ММ-ДД ЧЧ:ММ:СС.
language --- Двухбуквенный код языка в комнате. На этом языке будет отображаться интерфейс вебинара по умолчанию у ведущих и у слушателей. Допустимые значения: be - белорусский; bg - болгарский; de - немецкий; en - английский; es - испанский; et - эстонский; fr - французский; it - итальянский; lt - литовский; lv - латышский; pl - польский; pt - португальский; ru - русский; sl - словенский; tr - турецкий; uk - украинский.

Получение детальной информации для вебинара

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

Пример ниже получает всю информацию по вебинару

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsGetInfo',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsGetInfo",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%"
		}
	},
	"response": {
		"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		"name": "%--webinar-name-or-topic--%",
		"description": "%--html-formatted-webinar-description--%",
		"start": "%--year-month-day-hours-minutes-seconds--%",
		"duration": "%--webinar-duration-in-minutes--%",
		"close": "%--yes-or-no--%",
		"language": "%--webinar-room-language--%",
		"google_id": "%--google-analytics-id--%",
		"created": "%--year-month-day-hours-minutes-seconds--%",
		"status": "%--active-or-finished--%",
		"records": "%--amount-of-the-previous-records--%",
		"settings": {
			"userList": "%--yes-or-no--%",
			"flags": "%--yes-or-no--%",
			"chat": "%--yes-or-no--%",
			"buttonQuestion": "%--yes-or-no--%",
			"buttonVoice": "%--yes-or-no--%",
			"showBeforeTimer": "%--yes-or-no--%",
			"showLoginStart": "%--yes-or-no--%",
			"showLoginName": "%--yes-or-no--%",
			"showLoginModerators": "%--yes-or-no--%",
			"showSocialButtons": "%--yes-or-no--%",
			"showLoginCounter": "%--yes-or-no--%",
			"emailIdntLogin": "%--yes-or-no--%",
			"emailIdntRecord": "%--yes-or-no--%",
			"sendRecord": "%--yes-or-no--%",
			"theme": {
				"bg": "%--html-based-color-code--%",
				"text": "%--html-based-color-code--%"
			},
			"loginFields": [
				"name",
				"email"
			],
			"group": "%--group-name--%"
		}
	}
}

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


alias --- Уникальный ID вебинара для которого выполняется данная команда API
name --- Название вебинара
description --- Описание вебинара
start --- Время начала вебинара
duration --- Длительность вебинара в минутах. Максимальное значение 1439.
close --- Закрытый или открытый вебинар. YES закрытый, NO открытый.
language --- Язык по умолчанию вебинара. На этом языке будут отправляться все уведомления о мероприятии
google_id --- id Google Analytics (DEPRECATED).
created --- Дата создания вебинара.
status --- ACTIVE вебинары, которые идут или будут идти FINISHED вебинары, которые завершены.
records --- Параметры записи подробнее см. команду webinarsSet.
settings --- Параметры вебинарной комнаты. Для детальной информации по параметра смотрите команду `webinarsSet`.
... --- и другие доступные параметры.

Внимание: Количество и формат возвращаемых данных может отличаться от приведенного выше примера!

Получение данных по рассылке приглашений для вебинара

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

Пример ниже возвращает все активные рассылки для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsGetLettersInfo',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsGetLettersInfo",
		"params":
		{
			"alias": "xzkh-velf-xbek-wner",
		},
	},
	"response":
	{
		"REGISTRATIONCONFIRM":
		{
			"enabled": "%--0-or-1--%",
			"status": "%--wait-or-end--%",
			"text": "%--email-message-body--%",
		},
		"1HOUR":
		{
			"enabled": "%--0-or-1--%",
			"status": "%--wait-or-end--%",
			"text": "%--email-message-body--%",
		},
		"STARTED":
		{
			"enabled": "%--0-or-1--%",
			"status": "%--wait-or-end--%",
			"text": "%--email-message-body--%",
		},
		"FINISHED":
		{
			"enabled": "%--0-or-1--%",
			"status": "%--wait-or-end--%",
			"text": "%--email-message-body--%",
		},
		... - здесь может быть дополнительная информация
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.

Изменение параметров рассылки приглашений для вебинара

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

Пример ниже изменяет настройки приглашений для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsSetLetters',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'text' => '%--some-text-for-email-message-footer--%',
		'type' => '%--type--%',
		'enabled' => '%--yes-or-no--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsSetLetters",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"type": "%--type--%",
			"enabled": "%--yes-or-no--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API - валидный ID вебинара.
text --- Текст подписи к письму - текст в формате HTML. Чтобы удалить этот текст, отправьте запрос с пустым значением.
type --- Тип сообщения. Письмо, над которым нужно выполнить действие.


REGISTRATIONCONFIRM - письмо подтверждения регистрации. Письмо отправляется при самостоятельной регистрации участника на вебинар через страницу входа
3DAY - письмо для участника за 3 дня (72 часа) до вебинара.
1DAY - письмо для участника за 1 день (24 часа) до вебинара.
1HOUR - письмо приглашения участника за 1 час до вебинара.
STARTED - письмо опоздавшим, отправляется тем участникам, которые приглашены, но не вошли в вебинарную комнату на момент начала мероприятия.
FINISHED - письмо после завершения вебинара.


enabled --- Активация или отключение отправки письма: YES письмо будет отправлено; NO письмо не будет отправлено. Письмо приглашения участника за 1 час до вебинара 1HOUR не отключается.

Отключение рассылки для вебинара

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

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsLettersOff',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsLettersOff",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.

Включение рассылки для вебинара

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

Пример ниже активирует рассылку для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsLettersOn',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsLettersOn",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.

Получение списка участников на активном вебинаре

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

Пример ниже выбирает всех участников на вебинаре который идет в текущий момент

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsOnlineList',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsOnlineList",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"moderators":
		[
			{
				"name": "%--first-and-last-name-of-the-moderator--%",
				"email": "%--moderator-email-at-domain-dot-com--%",
			},
			...
		],
		"guests":
		[
			{
				"name": "%--first-and-last-name-of-the-attendee--%",
				"email": "%--attendee-email-at-domain-dot-com--%",
			},
			...
		],
	},
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
moderators --- Список ведущих.
guests --- Список участников.

Получение списка записей вебинара

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

Пример ниже получает списико записей вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsRecordsList',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsRecordsList",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	[
		{
			"id": "%--unique-id-of-the-recording--%",
			"name": "%--name-of-the-recording--%",
			"status": "%--ready-or-wait--%",
			"added": "%--year-month-day-hours-minutes-seconds--%",
			"size": "%--recording-file-size-in-bytes--%",
			"duration": "%--recording-length-in-seconds--%",
			"link": "%--https-unique-url-to-watch-the-recoring--%",
			"download_link": "%--https-unique-url-to-download-the-recoring--%",
		},
		...
	],
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
id --- Уникальный ID записи вебинара.
name --- Название записи вебинара.
status --- Статус записи в обработке или готова для загрузки.
added --- Дата и время создания записи.
size --- Размер файла записи.
duration --- Длительность записи.
link --- Ссылка для просмотра записи.
download_link --- Ссылка для загрузки записи.

Удаление записи для вебинара

Для удаления записи вебинара по её уникальному коду, используется команда webinarsRecordDelete.

Пример ниже удаляет запись для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsRecordDelete',
	'params' => [
		'id' => '%--unique-id-of-the-recording--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsRecordDelete",
		"params":
		{
			"id": "%--unique-id-of-the-recording--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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


id --- Идентификатор записи. id записи, можно получить используя команду webinarsRecordsList.

Получение списка материалов загруженных на вебинар

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

Пример ниже получает ранее загруженные файлы для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsFilesList',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'type' => '%--type--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsFilesList",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"type": "%--type--%",
		},
	},
	"response":
	[
		{
			"id": "%--unique-id-of-the-file--%",
			"name": "%--name-of-the-file--%",
			"added": "%--year-month-day-hours-minutes-seconds--%",
			"size": "%--file-size-in-bytes--%",
			"duration": "%--length-in-seconds-or-amount-of-pages--%",
			"link": "%--https-unique-url-to-watch-the-file--%",
			"download_link": "%--https-unique-url-to-download-the-file--%",
		},
		...
	],
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
type --- Тип файлов которые нужно получить. Параметр не является обязательным. PRESENTATION - получение списка презентаций и изображений. MEDIA - получение списка mp3, mp4 файлов, видео с Youtube и Vimeo.
id --- Уникальный ID файла.
name --- Название файла.
added --- Дата и время добавления/создания файла.
size --- Размер файла.
duration --- Длина файла, например у презентации количество слайдов.
link --- Ссылка на файл.
download_link --- Ссылка на загрузку файла.

Получение истории посещений вебинара

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

Пример ниже получает историю посещений или чата для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsHistory',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'type' => '%--chat-or-visits--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsHistory",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"type": "%--type--%",
		},
	},
	"response":
	[
		[
			"%--year-month-day-hours-minutes-seconds--%",
			"%--attendee-first-and-last-name--%",
			"%--text-chat-message-attendee-sent--%",
			"%--g-or-m--%",
			"%--attendee-email-at-domain-dot-com--%",
		],
		[
			"%--year-month-day-hours-minutes-seconds--%",
			"%--attendee-first-and-last-name--%",
			"%--text-chat-message-attendee-sent--%",
			"%--g-or-m--%",
			"%--attendee-email-at-domain-dot-com--%",
		],
		...
		[
			"%--year-month-day-hours-minutes-seconds--%",
			"%--attendee-first-and-last-name--%",
			"%--text-chat-message-attendee-sent--%",
			"%--g-or-m--%",
			"%--attendee-email-at-domain-dot-com--%",
		],
	],
},

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

alias --- Уникальный ID вебинара для которого выполняется данная команда API.
type --- Тип запрашиваемой истории: chats - возвращает детализированную историю всех сообщений в текстовом чате. visits - возвращает историю посещений вебинара.

Автоматизация вебинаров

В этом разделе описаны команды для

Создания виртуальных ведущих
Удаления виртуальных ведущих
Создания виртуальных участников
Удаления виртуальных участников
Получения списка виртуальных участников
Отправки сообщений в чат от имени виртуальных участников
Отключения чата для «живых» участников
Включения чата для «живых» участников
Отключения ссылок в чате для «живых» участников
Включения ссылок в чате для «живых» участников
Запуска показа слайдов презентации для «живых» участников
Остановки показа презентации для «живых» участников
Запуска загруженного видео-ролика или youtube
Остановки показа видео-ролика или youtube
Завершения вебинара и отключения «живых» участников

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

Создание виртуальных ведущих

Для создания виртуальных ведущих, используется команда webinarsAddModerToRoom.

Пример ниже создает виртуального ведущего на вебинаре

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsAddModerToRoom',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => '%--moderator-email-at-domain-dot-com--%',
		'name' => '%--moderator-first-and-last-name--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsAddModerToRoom",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email": "%--moderator-email-at-domain-dot-com--%",
			"name": "%--moderator-first-and-last-name--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого создается виртуальный ведущий.
email --- Уникальный емейл создаваемого виртуального ведущего Допустимое количество символов от 6 до 128.
name --- ФИО создаваемого виртуального ведущего Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.

Удаление виртуальных ведущих

Для удаления виртуального ведущего с вебинара, используется команда webinarsRemoveModerFromRoom.

Пример ниже удаляет ранее созданного виртуального ведущего с вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsRemoveModerFromRoom',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'email' => '%--moderator-email-at-domain-dot-com--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsRemoveModerFromRoom",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"email": "%--moderator-email-at-domain-dot-com--%",
		}
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара с которого удаляется ранее созданный ведущий.
email --- Уникальный емейл ранее созданного виртуального ведущего Допустимое количество символов от 6 до 128.

Создание виртуальных участников

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

Пример ниже создает виртуального участника на вебинаре

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsAddBotToRoom',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'name' => '%--attendee-first-and-last-name--%',
		'country' => '%--two-letters-country-code--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsAddBotToRoom",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"name": "%--attendee-first-and-last-name--%",
			"country": "%--two-letters-country-code--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
		"id": "%--unique-id-of-the-virtual-attendee--%",
	},
},

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

alias --- Уникальный ID вебинара для которого создается виртуальный участник.
name --- ФИО создаваемого виртуального участника Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\::;,<>/?.
country --- Код страны. Например EN, DE, UK, FR, PL, UA ...
id --- Уникальный код (ID) созданного виртуального участника.

Удаление виртуальных участников

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

Пример ниже удаляет ранее созданного виртуального участника с вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsRemoveBotFromRoom',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'id' => '%--unique-id-of-the-virtual-attendee--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsRemoveBotFromRoom",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"id": "%--unique-id-of-the-virtual-attendee--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара с которого удаляется виртуальный участник.
id --- Уникальный код (ID) созданного виртуального участника.

Получение списка виртуальных участников

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

Пример ниже получает всех виртуальных участников которые в момент запроса подключены к вебинару

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsGetBotsList',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsGetBotsList",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	[
		{
			"id": "%--unique-id-of-the-virtual-attendee--%",
			"name": "%--attendee-first-and-last-name--%",
			"country": "%--two-letters-country-code--%",
		},
		...
	],
},

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

alias --- Уникальный ID вебинара для которого получается список всех созданных ранее виртуальных участников.
id --- Уникальный код (ID) созданного виртуального участника.
name --- ФИО виртуального участника Допустимое количество символов от 2 до 64. Разрешены все символы кроме: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
country --- Код страны. Например EN, DE, UK, FR, PL, UA ...

Отправка сообщений в чат от имени виртуальных участников

Для отправки сообщений от имени виртуального участника или ведущего, используется команда webinarsBotMessage.

Пример ниже отправляет текстовое сообщение на вебинаре

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsBotMessage',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'bot' => '%--moderator-email-or-unique-id-of-the-virtual-attendee--%',
		'text' => '%--text-message--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsBotMessage",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"bot": "%--moderator-email-or-unique-id-of-the-virtual-attendee--%",
			"text": "%--text-message--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара в текстовый чат которого будет оправлено сообщение.
bot --- Емейл виртуального ведущего, который использовался при его создании. Либо, уникальный идентификатор виртуального участника, получаемый при его создании.
text --- Текстовое сообщение, которое будет отправлено в текстовый чат вебинара.

Отключение текстового чата для «живых» участников

Для отключения текстового чата во время вебинара, используется команда webinarLockChat.

Пример ниже запрещает обмен сообщениями в чате между участниками вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsLockChat',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsLockChat",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого отключается возможность обмена сообщениями в чате для всех «живых» участников.

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

Включение текстового чата для «живых» участников

Для включения текстового чата во время вебинара, используется команда webinarsUnlockChat.

Пример ниже разрешает обмен сообщениями в чате между участниками вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsUnlockChat',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsUnlockChat",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого включается возможность обмена сообщениями в чате для всех «живых» участников.

Отключение ссылок в чате для «живых» участников

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

Пример ниже запрещает обмен ссылками в чате между участниками вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsLinkLockInChat',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsLinkLockInChat",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого отключается возможность обмена ссылками в чате между «живыми» участниками.

Включение ссылок в чате для «живых» участников

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

Пример ниже разрешает обмен ссылками в чате между участниками вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsLinkUnlockInChat',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsLinkUnlockInChat",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого включается возможность обмена ссылками в чате между «живыми» участниками.

Запуск показа слайдов презентаций для «живых» участников

Для запуска презентации, используется команда webinarsStartPresentation.

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsStartPresentation',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'id' => '%--unique-id-of-the-file--%',
		'slide' => '%--page-or-slide-number--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsStartPresentation",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"id": "%--unique-id-of-the-file--%",
			"slide": "%--page-or-slide-number--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого запускается презентации.
id --- Код ID презентации, получаемый при выборке загруженных ранее файлов. Для получения используем параметр `webinarsFilesList`.
slide --- Номер слайда презентации, который нужно показать на вебинаре.

Остановка показа презентаций для «живых» участников

Для остановки показа презентации на вебинаре, используется команда webinarStopPresentation.

Пример ниже останавливает показ презентации для вебинара

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarStopPresentation',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarStopPresentation",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого останавливается показ презентации.

Запуск видеоролика или youtube для «живых» участников

Для запуска видео-, youtube- или vimeo- ролика , используется команда webinarsStartVideo.

Пример ниже запускает видеоролик на вебинаре

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsStartVideo',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
		'id' => '%--unique-id-of-the-file--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsStartVideo",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
			"id": "%--unique-id-of-the-file--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого запускается показ видеоролика.
id --- Код ID видеоролика. Для получения используем параметр `webinarsFilesList`.

Остановка видеоролика для «живых» участников

Для остановки воспроизведения запущенного видео-, youtube- или vimeo- файла, используется команда webinarsStopVideo.

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

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsStopVideo',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsStopVideo",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара для которого останавливается показ видеоролика.

Завершение вебинара и отключение «живых» участников

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

Пример ниже завершает вебинар

$data[ 'request' ] = json_encode( [
	'key' => '%--api-key-from-your-profile--%',
	'action' => 'webinarsFinish',
	'params' => [
		'alias' => '%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%',
	],
] );

В случае успешного выполнения команды будет получен ответ

{
	"request":
	{
		"action": "webinarsFinish",
		"params":
		{
			"alias": "%--webinar-alias-xxxx-xxxx-xxxx-xxxx--%",
		},
	},
	"response":
	{
		"success": "%--message--%",
	},
},

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

alias --- Уникальный ID вебинара который будет завершен. Завершыть можно только вебинар который начался.


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

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

Обновлено на: 18/01/2024