MyOwnConference public API

Sections

• Access to API
• API commands

Access to API

In this section, the following is described:

• Access key
• Access domain
• Request format
• Response format
• PHP example
• Node.js example

Access key

To utilize the MyOwnConference webinar platform API, you will require an automatically generated unique key. You can acquire this key from the control panel. Simply log in to the control panel and proceed to the "Profile" section. From there, locate the "API Key" field to discover your exclusive key.

Access domain

All API requests are sent over the secure HTTPS protocol to a dedicated domain: api.mywebinar.com.

Request format

All API requests are sent in the JSON format for optimal compatibility and data exchange.

The API requests follow the following structure:

1. Requests with named parameters parameter=value

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

2. Requests in the format of a list of values

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

3. Transmitted and received data

• %--api-key-from-your-profile--% --- API key.
• %--required-api-command--% --- API command.
• %params% --- Additional parameters of the command.

Response format

All API responses are always returned in the JSON format.

API responses always include the original request, along with either the successful result or an error message.

The API response returns the following data:

• An array of requested data, which represents the result of the request.
• Or a message indicating successful execution in case there is no result available.
• Or an error message with a detailed description of the error.

Possible response options for the example request in section 1.3 are:

1. Successful execution with data returned

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

2. Successful execution without returning data

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

3. Request execution error with a detailed description

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

4. Transmitted and received data

• %--required-api-command--% --- Command.
• %--value--% --- Return the transmitted value as the output if the operation is successful. The transferred value should be one of the values from an array.
• %--message--% --- The message will indicate whether the command was executed successfully or unsuccessfully.

PHP example

Here is a functional demonstration of how to send an API request using the PHP programming language:

$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 );

// ...
// printing test results

var_dump( $result );

Node.js example

Here is a functional demonstration of how to send an API request using the Node.js programming language.

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

Commands

In this section, commands for working with:

• User profile
• Webinar moderators
• Webinar participants
• Webinar scheduling
• Webinar automation

User profile

In this section, commands are described for:

• Getting user profile
• Updating user profile

Getting user profile

The profileGet command is used to obtain comprehensive or limited details regarding the user profile.

1. Example of retrieving all profile parameters

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

2. Example of retrieving individual profile parameters

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

3. Transmitted and received data

• name --- Name and surname of the user of the service. All webinar invitations will be sent using this name.
• email --- Email address registered to the user of the service.
• timezone --- User's time zone. The timing of all created events will be based on this parameter. You can refer to the time zone table to see the available time zones.
• timemove --- This parameter indicates whether the system takes into account daylight saving time. If the value of this field is set to YES, the system will automatically adjust the time for daylight saving and vice versa.
• language --- User's language. This language will be used as the default interface language for all future scheduled webinars. Possible values are: EN - English; DE - German; ES - Spanish; FR - French; PL - Polish; RU - Russian; UK - Ukrainian.
• gateway --- The payment system used by the user: PAYSERA, PAYPAL, INTERKASSA.
• subscribe --- Subscription to service news. The value YES indicates the subscription is active, and NO suggests it is not.
• company --- Company details. If this field is not empty, it indicates that the user is a legal entity and is eligible to receive invoices for payment via bank transfers.

Updating user profile

To fully or partially update the user profile, the command profileSet is used.

1. Example of updating profile parameters

$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. Result of the request execution

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

3. The transmitted and received data

• name --- User's full name. All invitations to scheduled webinars will be sent from this name. The acceptable character count is from 2 to 64. All characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• language --- User's language. This language will be used as the default interface language for all future scheduled webinars. Possible values are: EN - English; DE - German; ES - Spanish; FR - French; PL - Polish; RU - Russian; UK - Ukrainian.
• gateway --- The payment system. Possible values: PAYSERA - Paysera payment system; PAYPAL - PayPal payment system.
• subscribe --- Service newsletter subscription. Possible values: YES - subscription is active, NO - subscription is inactive.
• company --- Company details. If a non-empty value is set, the user is considered a legal entity and gains the ability to generate invoices for payment via bank transfer. Up to 1000 characters are allowed.
• timemove --- This parameter allows the system to automatically account for daylight saving time when scheduling webinars. Possible values: YES - account for daylight saving time, NO - do not account for daylight saving time.
• timezone --- Time zone. The system takes into account the user's time zone when scheduling webinars. The parameter values are set in minutes. The values can be both positive and negative.

Time zone table used in the system:

Webinar moderators

This section describes commands for:

• Creating webinar moderators
• Deleting webinar moderators
• Updating webinar moderators' information
• Retrieving the list of webinar moderators
• Attaching webinar moderators to a webinar
• Detaching moderators from the webinar
• Getting a list of webinars to which a webinar moderator is attached

Creating webinar moderators

The command used to create a new webinar moderator is moderatorsCreate.

1. The example below creates a webinar moderator

$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. In case of successful execution of the command, you will receive a response.

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

3. Data sent and received

• name --- Webinar moderator's full name. The acceptable character count is from 2 to 64. All characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• email --- Webinar moderator's email address. The acceptable character count is from 6 to 128.

Deleting webinar moderators

The command used to delete webinar moderators is moderatorsDelete.

1. The example below deletes a webinar moderator with a specified email

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

2. In case of successful execution of the command, you will receive a response.

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

3. The example below deletes multiple webinar moderators based on an array of emails

$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. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

An array of emails is passed to the command in both cases.

Updating webinar moderators' information

To modify the webinar moderator's complete name and email address or upload a new profile picture, you would utilize the command moderatorsSet.

1. The example below updates the full name and email for a chosen webinar moderator

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• email --- The webinar moderator's email, which requires updating, should consist of anywhere from 6 to 128 characters.
• newEmail --- The new email address of the webinar moderator whose information needs to be updated. It should have a character count between 6 and 128.
• newName --- The new full name of the webinar moderator. It should be between 2 and 64 characters long and can contain any character except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• avatar --- The image that will be used as the profile picture in place of the webcam video for the webinar moderator. The webcam will be disabled while the profile picture is shown.

The image for the avatar needs to be encoded in Base64 format. Acceptable image formats are: JPG, JPEG, PNG.

To manually encode images into Base64 format, you can use the following command:

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

Retrieving the list of webinar moderators

To retrieve the overall list of webinar moderators, the command moderatorsList is used.

1. The example below retrieves a list of all webinar moderators with complete information

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

2. The example below retrieves the list of all webinar moderators with partial information, specifically only the full names

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

3. The example below retrieves the list of all webinar moderators for a specific webinar

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

4. The example below retrieves the list of all webinar moderators with filters based on name and email

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

5. In case of successful execution of the command, you will receive a response

{
	"request":
	{
		"action": "moderatorsList",
		"params":
		{
			"fields":
			[
				"email",
				"name",
			],
			"search": "%--search-text--%", -- in case search text has been added
		},
	},
	"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. Data sent and received

• fields --- The list of fields that you would like to retrieve in the query. This parameter is optional and can be omitted or set as an empty array [].
• alias --- The unique ID of the webinar, which can be obtained from the webinar link when scheduling it. This parameter is not mandatory and can be omitted or set with an empty value "".
• search --- Search query. A set of characters used to search for webinar moderators by name and email. This parameter is optional and can be omitted or set with an empty value "".
• name --- The full name of the webinar moderator. It should have a character count between 2 and 64. All characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• email --- The email of the webinar moderator. It should contain between 6 and 128 characters.
• registered --- The registration date of the webinar moderator, including year-month-day hours:minutes:seconds.
• main --- A flag indicating whether this webinar moderator is a primary moderator in the webinar: YES - primary moderator, NO - not a primary moderator.
• avatar --- A flag indicating the use of an avatar instead of the webcam for the webinar moderator: YES - avatar is used, NO - camera, by default.

The primary webinar moderator or account administrator is the moderator created during the registration process on the platform. In the webinar moderator management section of the control panel, this moderator is identified by a star and cannot be deleted. This moderator has access to all webinars and uploaded documents and media.

Attaching webinar moderators to a webinar

To attach one or multiple webinar moderators to a webinar, the command moderatorsAddToWebinar is used.

1. The example below attaches the specified webinar moderator to a webinar

$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. In case of successful execution of the command, you will receive a response

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

3. The example below attaches multiple webinar moderators to the webinar

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• alias --- The unique webinar ID, which you need to add moderators to, can be obtained from the webinar link when scheduling it.
• email --- One or multiple email addresses registered for the moderators in the system. The allowable character count is from 6 to 128.
• sendInvite --- An optional parameter that can be set to either YES or NO. Setting it to YES means that the moderator will receive an invitation with a link to the scheduled webinar immediately. Setting it to NO means that the invitation will be sent according to the general schedule.

Detaching moderators from the webinar

To detach one or multiple moderators from a webinar, you can use the command moderatorsRemoveFromWebinar.

1. The example below detaches the presenter from the webinar.

$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. In case of successful execution of the command, you will receive a response

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

3. The example below detaches multiple moderators from the webinar

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• alias --- Unique webinar ID from which you want to detach the moderators, which can be obtained from the webinar link when it is scheduled.
• email --- One or multiple email addresses with which the moderators are registered in the system. The allowable number of characters is between 6 and 128.

Getting a list of webinars that a presenter is attached to

To retrieve the list of webinars to which a moderator is attached, you can use the command moderatorsRooms.

1. The example below retrieves all the information about webinars to which a specific moderator is attached

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

2. In case of successful execution of the command, you will receive a response

{
	"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--%"
		},
		... the moderator can be attached to any number of webinars
	]
}

3. Data sent and received

• alias --- Unique webinar ID for which this API command is being executed.
• email --- Email address registered for the moderator in the system. Allowed character limit is from 6 to 128.
• name --- Title or topic of the webinar.
• description --- Webinar description. It can be left empty.
• start --- Date and time of the webinar.
• timezone --- The time zone for the webinar.
• duration --- Estimated duration of the webinar. Duration of the webinar in minutes. Maximum value is 1439 minutes.
• moderatorLink --- moderator login link.

Webinar participants

In this section, you will find commands for:

• Creating participants
• Editing participants
• Removing participants
• Obtaining a general list of participants
• Attaching participants to future webinars
• Unattaching participants from future webinars
• Obtaining a list of webinars with attached participants
• Creating a participant group
• Renaming a participant group
• Removing a group of participants
• Obtaining the list of participant groups
• Adding participants to groups
• Removing participants from groups
• Retrieving a list of groups in which a participant is present
• Removing participants from the blocked list

Creating participants

To create a new attendee for your webinars, you can use the command attendeesCreate.

1. The example below creates a new participant

$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. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

• name --- Full name of the participant. Maximum of 64 characters allowed, excluding: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• email --- Participant's full name. Participant's email. Acceptable character count is between 6 and 128, and you can use English letters and numbers.

Editing Participants

For updating participant data, the command attendeesSet is used.

1. The example below updates the personal information of a previously created participant.

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• email --- Email address of the participant. The allowed number of English letters and digits is from 6 to 128.
• newemail --- New email address for the participant. Acceptable number of English letters and numbers is from 6 to 128.
• name --- Full name of the participant. Maximum 10 characters allowed, excluding: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• phone --- Participant's phone number. Maximum of 16 characters allowed.
• skype --- Participant's Skype ID. Acceptable characters are English alphabet characters, excluding: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• company --- Company. Any characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• department --- Department. Any characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• city --- City. Any characters are allowed, except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• born --- Date of birth.

Removing participants

To remove previously created attendees, the command attendeesDelete is used.

1. The example below deletes the specified participant.

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

2. In case of successful execution of the command, you will receive a response

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

1. The example below removes multiple participants

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• name --- Full name of the participant. Acceptable character limit is up to 64 characters, excluding: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• email --- Email of the participant or an array of emails of the participants to be removed. The allowed character limit is from 6 to 128, and only English letters and numbers can be used.

Obtaining a list of participants

To obtain a list of previously created attendees, you can use the command attendeesList.

1. The example below retrieves a list of all participants

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• fields — List of fields to retrieve. This parameter is optional. If not specified, only the name and email fields will be returned. List of possible field values:
• onPage --- How many participants to return per request on the page. By default, it is set to 100. If the parameter is not specified, the list will be obtained without pagination.
• alias --- Unique webinar ID
• search --- Please enter a set of characters that should be included in the participant's name or email.
• page --- Page number to be returned.
• order --- Sorting in ascending order ASC and descending order DESC. Default is ASC.
• orderField --- Field by which to perform sorting: name, email, creation_date. Default is name.
• type --- Participant type: ACTIVE - active; PENDING - inactive; BANNED - blocked.
• imported --- In which way were the participants added to the system. YES indicates manual addition by the account owner, NO indicates self-registration.
• webinars --- Events, array of aliases where participants were or were not present.
• webinarsOrder --- Has the participant attended the webinars listed in the webinars parameter? IN - attended the webinar, OUT - did not attend the webinar.
• withEmail --- Return participants with email or without email. YES - return only participants with an email, NO - return only participants without an email. If the parameter is not specified, the entire list is returned.
• group --- Group id to which participants are associated.

Possible values for the fields field

• name --- Participant's full name. Acceptable character limit is between 2 and 64. All characters are allowed except: ^~!@#$%^&*()+=[{}]\|:;,<>/?.
• email --- Email address of the participant. Acceptable number of characters is between 6 and 128.
• phone --- Participant's phone number. Allowed number of characters is between 6 and 128.
• skype --- Participant's Skype ID. Acceptable character count is between 6 and 128.
• company --- Company. Acceptable number of characters: 6 to 128.
• department --- Department. Allowed number of characters is from 6 to 128.
• city --- City. Acceptable number of characters is from 6 to 128.
• born --- Date of birth.
• creation_date --- Date added.
• country --- Participant's country.
• type --- Participant type: ACTIVE - active, PENDING - pending, BANNED - banned.
• notified --- The number of webinar invitations previously sent.
• link --- Joining link for the webinar. This field is available only if the alias parameter is specified.

Attaching participants to future webinars

To attach (invite, assign) an attendee to scheduled webinars, the command attendeesAddToWebinar is used.

1. The example below attaches the specified participant to the webinar

$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. In case of successful execution of the command, you will receive a response

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

3. The example below attaches multiple participants to the webinar

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• alias --- Unique webinar ID for which this API command is executed.
• attendees --- Array of participant emails to be attached to the webinar.

Unsubscribing participants from future webinars

To remove an attendee from a scheduled webinar, you can use the command attendeesRemoveFromWebinar.

1. The example below detaches the specified participant from the webinar

$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. In case of successful execution of the command, you will receive a response

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

3. The example below removes multiple participants from the webinar

$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. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• alias --- Unique webinar ID for which this API command is executed.
• attendees --- An array of participant emails to be detached from the webinar.

Getting a list of webinars that a participant is attached to

To retrieve the webinars to which a previously created attendee has been invited, you can use the command attendeesRooms.

1. The example below retrieves a list of all webinars to which the specified participant has been attached

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

2. In case of successful execution of the command, you will receive a response

{
	"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. Data sent and received

• email --- Email address of the participant for whom you need to retrieve the list of webinars. The allowed number of characters is from 6 to 128.
• alias --- Unique webinar ID for which this API command is executed.
• name --- Title or topic of the webinar.
• description --- Description of the webinar, if any, may be absent.
• start --- Date and time of the webinar start. Text in the format YYYY-MM-DD HH:MM:SS.
• timezone --- The time zone in which the webinar is conducted. You can refer to the Time Zone Table for available time zones.
• duration --- Estimated duration of the webinar in minutes. The maximum value is 1439.
• attendeeLink --- Webinar room access link.

Creating a participant group

To create a new group of attendees, you will use the command attendeesCreateGroup.

1. The example below creates a new group

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

2. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

• name --- Name of the participant group being created.
• group_id --- Group ID of the created participants.

Renaming a participant group

To rename a previously created group of attendees, you can use the command attendeesGroupsRename.

1. The example below renames a group of participants

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

2. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

• id - The ID of the participant group. You can obtain it during group creation using the attendeesCreateGroup parameter or through retrieving the list of groups using the attendeesGroupsList command.
• newname --- New name for the participant group.

Removing a group of participants

To delete a previously created group of attendees, you can use the command attendeesDeleteGroup.

1. The example below deletes a previously created group using the specified identifier.

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

2. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

• id --- Group ID of the attendees. You can obtain it during group creation using the parameter attendeesCreateGroup or through retrieving the list of groups using attendeesGroupsList.

Getting a list of participant groups

To retrieve a list of all previously created groups, you can use the command attendeesGroupsList.

1. The example below retrieves a list of all groups

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

2. In case of successful execution of the command, you will receive a response

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

3. Data sent and received

• id --- Group ID.
• name --- Group name.

Adding participants to groups

To add participants to a previously created group, you can use the command attendeesAssignToGroup.

1. The example below adds the specified participant to the group

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

2. In case of successful execution of the command, you will receive a response

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

3. The example below adds multiple participants to the group

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