Программный интерфейс MyOwnConference

Разделы

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

Доступ к API

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

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

Ключ доступа

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• %--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();

Команды

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$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--%',
	],
] );

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

$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--%',
	],
] );

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

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

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

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

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

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

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

$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--%',
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
	"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--%",
		},
	],
},

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

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

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

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

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

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

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

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

$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--%',
		],
	],
] );

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

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

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

$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--%',
		],
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

$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--%',
		],
	],
] );

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

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

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

$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--%',
		],
	],
] );

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

{
	"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%",
	},
},

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

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

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

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

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

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

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

{
	"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--%"
		},
		... ведущий может быть прикреплен к любому количеству вебинаров
	]
}

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

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

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

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

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

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

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

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

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

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

$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--%',
	],
] );

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

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

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

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

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

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

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

$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 ...
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

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

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

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

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

$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--%',
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

$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--%',
	],
] );

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

{
	"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--%",
			},
		],
	},
},

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

• 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.

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

$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--%',
		],
	],
] );

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

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

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

$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--%',
		],
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

$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--%',
		],
	],
] );

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

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

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

$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--%',
		],
	],
] );

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

{
	"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--%",
	},
},

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

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

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

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

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

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

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

{
	"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--%"
		},
	],
},

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

{
	"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--%",
			},
		],
	],
},