Interface App\Api\WebmeetingInferface


					
	public

createAccount(string $name, string $login, string $email, string $password)

Vytvoří nový účet (nového uživatele) ve Webmeetingu - vyhrazeno pro vnitřní použití a pro partnery. Při nastavování …

Vytvoří nový účet (nového uživatele) ve Webmeetingu - vyhrazeno pro vnitřní použití a pro partnery. Při nastavování hesla do Webmeetingu nepoužívejte stejné heslo jako do systému, ze kterého API používáte; je na business logice, dáte-li uživateli jeho heslo nějak vědět. Pro komunikaci přes API toto heslo není potřeba, požadavky se podepisují tajemstvím klienta API (systému partnera).

Parameters

`$name`	Jméno nového uživatele
`$login`	Přihlašovací jméno nového uživatele, musí být unikátní
`$email`	string Emailová adresa klienta
`$password`	string Hash hesla pro konkrétního klienta, lze použít: md5() - bude přehashováno

#


					
	public

updateMeeting(
	string $login,
	int $meetingId,
	string $name,
	string $time_begin,
	string $speaker_name,
	string $description,
	int $type,
)

Upraví již vytvořené setkání. Úpravy jsou omezené stejně jako při přístupu přes webové rozhraní, již započaté setkání…

Upraví již vytvořené setkání. Úpravy jsou omezené stejně jako při přístupu přes webové rozhraní, již započaté setkání nelze upravovat.

Parameters

$login

Login uživatele, jemuž setkání patří.

$meetingId

ID setkání

$name

Nový název setkání

$time_begin

Nový čas začátku setkání ve formátu "d.m.Y H:i". Pokud se zadá prázdný (nebo v blízké minulosti), bude považován za TEĎ HNED.

$speaker_name

Nové jméno přednášejícího

$description

Nový popis setkání

$type

Nový typ setkání, konstanty viz násl. tabulka. Ne všechny typy setkání musejí být k dispozici pro všechny (tarifní) programy. Parametry typů setkání mohou být v budoucnu měněny.

14	Rande (až 3 účastníků, 91 minut)
2	Porada (až 9 účastníků, 91 minut)
1	Místnost pro 51 (až 51 účastníků, 217 minut)
11	Místnost pro 101 (až 101 účastníků, 217 minut)
9	Místnost pro 201 (až 201 účastníků, 217 minut)
4	Stálá porada (až 9 účastníků kontinuálně na 1 rok)
5	Stálá místnost pro 51 (až 51 účastníků kontinuálně na 1 rok)
12	Stálá místnost pro 101 (až 101 účastníků kontinuálně na 1 rok)

#


					
	public

createMeeting(string $login, string $name, string $time_begin, string $speaker_name, string $description, int $type)

Vytvoří nové setkání (poradu, meeting nebo webinář). V odpovědi vrací ID setkání.

Parameters

`$login`	Login uživatele, pro kterého setkání vytváříme.
`$name`	Název setkání
`$time_begin`	Čas začátku setkání ve formátu "d.m.Y H:i". Pokud se zadá prázdný (nebo v blízké minulosti), bude považován za TEĎ HNED.
`$speaker_name`	Jméno přednášejícího
`$description`	Popis setkání
`$type`	Typ setkání (konstanty viz tabulka v dokumentaci metody updateMeeting())

#


					
	public

deleteMeeting(string $login, int $meetingId)

Smaže již vytvořené setkání. Smazání je omezené stejně jako při přístupu přes webové rozhraní, již započaté setkání…

Smaže již vytvořené setkání. Smazání je omezené stejně jako při přístupu přes webové rozhraní, již započaté setkání nelze smazat.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání

#


					
	public

configureMeeting(string $login, int $meetingId, array $options)

Nastaví další parametry pro již vytvořené setkání.

Parameters

$login

Login uživatele, jemuž setkání patří.

$meetingId

ID setkání

$options

Pole s konfiguračními parametry (klíč-hodnota), povolené klíče jsou:

auto_start_recording (začít automaticky nahrávání, aktuálně nepodporováno BBB)
is_public (Umožnit na setkání přihlašování veřejnosti - 0 ne, 1 ano, 2 ano + umístit do veřejného seznamu),
public_capacity (Kapacita pro veřejnost),
public_price (Cena pro veřejnost, -1 = placený v režii pořadatele)
logout_url (vlastní URL po odchodu ze setkání)
restrict_enter_multiplicity (Pouze jeden účastník na jednu pozvánku = 1, bez omezení = 0)

#


					
	public

getMeetings(string $login, ?int $meetingId)

Vrací seznam všech existujících setkání.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	Volitelné: ID setkání - je-li nastaveno, vrací pouze jedno setkání s tímto ID.

#


					
	public

createParticipant(string $login, string $number, string $surname, string $firstname, string $email)

Vytvoří účastníka - t.j. někoho, kdo se může účastnit setkání. V odpovědi vrací ID účastníka (jako $participantId).

Parameters

`$login`	Login uživatele, k němuž účastník patří.
`$number`	registrační číslo (smí být prázdné)
`$surname`	příjmení
`$firstname`	jméno
`$email`	platná e-mailová adresa

#


					
	public

updateParticipant(string $login, int $participantId, string $number, string $surname, string $firstname, string $email)

Upraví existujícího účastníka.

Parameters

`$login`	Login uživatele, k němuž účastník patří.
`$participantId`	ID účastníka
`$number`	registrační číslo, smí být prázdné
`$surname`	příjmení
`$firstname`	jméno
`$email`	platná e-mailová adresa

#


					
	public

deleteParticipant(string $login, int $participant_id)

Smaže existujícího účastníka.

Parameters

`$login`	Login uživatele, k němuž účastník patří.
`$participant_id`	ID účastníka

#


					
	public

getParticipants(string $login, ?int $participant_id)

Vrací seznam všech existujících účastníků.

Parameters

`$login`	Login uživatele, k němuž účastnci patří.
`$participant_id`	Volitelně: ID účastníka, je-li nastaveno, vrací pouze jednoho účastníka s tímto ID.

#


					
	public

setAccess(string $login, int $meetingId, int $participantId, $level)

Nastaví účastníkovi přístup k setkání.

Parameters

`$login`	Login uživatele
`$meetingId`	ID setkání
`$participantId`	ID účastníka

#


					
	public

getAccess(string $login, int $meetingId, int $participantId): array

Zjistí aktuální nastavení úrovně přístupu k setkání (pro jednoho zvoleného a nebo pro všechny přihlášené účastníky).

Parameters

`$login`	Login uživatele
`$meetingId`	ID setkání
`$participantId`	ID účastníka - volitelné - může být null, pak vrací všechny účastníky s jiným právem než ACCESS_NONE

Returns

Jeden tiket (pro zadaný atribut $participantId) nebo pole tiketů indexované participantId (jinak), tiket obsahuje "participantId", "meetingId", "isAllowedOnline" (povolení vstupu online), "isAllowedRecord" (povolení vstupu k záznamu), "token", "onlineInvitationSent" a "recordInvitationSent" (čas odeslání pozvánek)

#


					
	public

importParticipants(string $login, int $meetingId, array $participants, int $access_level): array

Naimportuje účastníky a dle požadavku je přiřadí k existujícímu setkání. Pokud už identický účastník existuje, není…

Naimportuje účastníky a dle požadavku je přiřadí k existujícímu setkání. Pokud už identický účastník existuje, není vytvářen duplicitně. Pokud má už účastník nějaká práva k setkání, úroveň přístupu k setkání, která bude účastníkům je mu pouze přidávána, ale nikdy ubírána.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání, může být null, v takovém případě jsou účastníci pouze naimportování, ale nejsou přiřazeni k žádnému setkání
`$participants`	Pole účastníků, každá položka pole musí být asociativní pole s klíči 'number' (reg. číslo, smí být prázdné), 'surname' (příjmení), 'firstname' (jméno) a 'email' (musí být platnou e-mailovou adresou).
`$access_level`	Úroveň přístupu k setkání, která bude účastníkům přidána (ACCESS_ONLINE_ONLY, ACCESS_RECORD_ONLY, ACCESS_ONLINE_AND_RECORD)

Returns

Pole, kde klíčem je číslo záznamu ze vstupu $participants a hodnotou ID vloženého (nebo již existujícího) účastníka

#


					
	public

setMeetingEmpty(string $login, int $meetingId)

Odebere všechny přístupy k setkání s daným $meetingId - myšleno jako reset přihlášených účastníků před novým…

Odebere všechny přístupy k setkání s daným $meetingId - myšleno jako reset přihlášených účastníků před novým importParticipants()

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání

#


					
	public

sendInvitations($login, int $meetingId, int $mode, int $filter, string $body)

Rozešle jednorázově pozvánky k setkání (s defaultním textem pozvánky).

Parameters

`$meetingId`	ID setkání
`$mode`	Druh pozvánek: 0 pro pozvánky na online, 1 pro pozvánky k záznamu
`$filter`	Filtr (0 = všem, 1 = jen dosud nepozvaným)
`$body`	Tělo pozvánky, musí obsahivat /%URL%/ pro vložení odkazu pro vstup. Alternativně, pokud je $body prázdné, použije WebMeeting standardní text pozvánky.

#


					
	public

sendInvitationsExt(
	string $login,
	int $meetingId,
	int $mode,
	int $filter,
	string $body,
	string $senderName,
	string $replyTo,
	string $subject,
)

Rozešle jednorázově pozvánky k setkání (s defaultním textem pozvánky).

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání
`$mode`	Druh pozvánek: 0 pro pozvánky na online, 1 pro pozvánky k záznamu
`$filter`	Filtr (0 = všem, 1 = jen dosud nepozvaným)
`$body`	Tělo pozvánky, musí obsahivat /%URL%/ pro vložení odkazu pro vstup. Alternativně, pokud je $body prázdné, použije Webmeeting standardní text pozvánky.
`$senderName`	Jméno odesílatele nebo null pro výchozí hodnotu
`$replyTo`	Email odesílatele nebo null pro výchozí hodnotu
`$subject`	Předmět zprávy nebo null pro výchozí hodnotu

#


					
	public

getModeratorAccess(string $login, int $meetingId)

Vrátí URL vstupní stránky pro moderátora a vstupní kód pro přihlášení moderátora k danému setkání, jako pole s klíči …

Vrátí URL vstupní stránky pro moderátora a vstupní kód pro přihlášení moderátora k danému setkání, jako pole s klíči "url" a "moderatorCode".

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání

#


					
	public

getModeratorEnterURL(string $login, int $meetingId, string $moderatorName, bool $html5client): string

Vrátí přímo URL místnosti pro moderátora k danému setkání.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání
`$moderatorName`	Jméno moderátora
`$html5client`	Použít html5 klienta?, výchozí je true

Returns

URL

#


					
	public

getParticipantEnterURL(string $login, int $meetingId, int $participantId, bool $html5client): string

Vrátí přímo URL místnosti pro účastníka k danému setkání.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání
`$participantId`	ID účastníka
`$html5client`	Použít html5 klienta?, výchozí je true

Returns

URL

#


					
	public

importParticipantAndGetEnterURL(
	string $login,
	int $meetingId,
	array $participants,
	int $access_level,
	bool $html5client,
): array

Provede import účastníků (pokud účastník neexistuje, vytvoří se, pokud není k setkání přiřazen, přiřadí se) a rovnou…

Provede import účastníků (pokud účastník neexistuje, vytvoří se, pokud není k setkání přiřazen, přiřadí se) a rovnou vrátí unikátní URL místnosti pro vstup těchto účastníků k danému setkání.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání
`$participants`	účastník - musí být asociativní pole s klíči 'number' (reg. číslo, smí být prázdné), 'surname' (příjmení), 'firstname' (jméno) a 'email' (musí být platnou e-mailovou adresou).
`$access_level`	Úroveň přístupu (ACCESS_NONE, ACCESS_ONLINE_ONLY, ACCESS_RECORD_ONLY, ACCESS_ONLINE_AND_RECORD)
`$html5client`	Použít html5 klienta?

Returns

Pole, kde klíčem je číslo záznamu ze vstupu $participants a hodnotou URL pro vstup účastníka na setkání

#


					
	public

getRecordings(string $login, int $meetingId): array

Vrátí seznam nahrávek k danému setkání vč. odkazů pro jejich přehrání.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání

Returns

Pole s informacemi o nahrávkách (jedno setkání může mít více nahrávek), indexováno kódem nahrávky, obsahuje hodnoty indexované url (odkaz na nahrávku), length (délka v minutách) a startTime (čas začátku ve formátu 06.11.2019 12:59:56).

#


					
	public

getChatRecordings(string $login, int $meetingId): array

Vrátí výpis ze zaznamenaného chatu k danému setkání. Podmínkou je, že pro setkání byl pořízen záznam.

Parameters

`$login`	Login uživatele, jemuž setkání patří.
`$meetingId`	ID setkání

Returns

Pole obsahující záznamy chatu k jednotlivým nahrávkám (jedno setkání může mít více nahrávek), v první úrovni indexováno kódem nahrávky, ve druhé úrovni jednotlivé zprávy indexovány od 0, v poslední úrovni obsahuje hodnoty indexované time (čas zprávy od začátku nahrávky), name (jméno posluchače) a message (text vlastní zrpávy).

#


					
	public

getPresence($login, int $meetingId, ?int $participantId = null): array

Vrátí informace o přítomnosti účastníků na živém setkání.

Parameters

`$meetingId`	ID setkání
`$participantId`	ID účastníka (je-li požadována informace jen o jednom účastníkovi) nebo NULL (je-li požadována informace o všech účastnících)

Returns

Návštěvnost živého setkání pro jednotlivé účastníky - pole obsahuje položky indexované 'participant_id', 'participant_name' a 'presence', prezence je indexovaná časem (datetime) a obsahuje binární (0, 1) položky 'is_moderator' (je moderátorem), 'is_presenter' (je přednášejícím), 'is_listening' (poslouchal), 'has_joined_voice' (aktivoval mikrofon) a 'has_video' (aktivoval webkameru). Modarátoři mají participant_id NULLové. Řádky pro účastníky, kteří na setkání vůbec nebyli (hypotetické prázdné presence), se nevracejí. Při použití parametru $participantId je návratová hodnota (nanejvýš) jednoprvkové pole.

#


					
	public

getPlaybackPresence($login, int $meetingId, ?int $participantId = null): array

Vrátí informace o shlédnutí záznamu ze setkání jednotlivými účastníky.

Parameters

`$meetingId`	ID setkání
`$participantId`	ID účastníka (je-li požadována informace jen o jednom účastníkovi) nebo NULL (je-li požadována informace o všech účastnících)

Returns

Návštěvnost záznamu ze setkání webináře pro jednotlivé účastníky - pole obsahuje položky indexované 'participant_id' a 'has_played' (1, pokud si přehrál záznam). Neřešíme už přitom, jak dlouho měl účastník záznam otevřený, ani zda, kolikrát nebo které části záznamu v rámci tohoto otevření shlédnul. Pokud je k setkání záznamů více, neřešíme, který z nich otevřel. Při použití parametru $participantId je návratová hodnota (nanejvýš) jednoprvkové pole. Řádky pro účastníky, kteří záznam vůbec neviděli (hypotetické has_played == false), se nevracejí. Návratová hodnota může být v budoucnu zpětně kompatibilním způsobem rozšířena o další položky.

#

Constants
`public`	`ACCESS_NONE = 0` Nepřihlášen (vztah k účastníka k setkání) Nepřihlášen (vztah k účastníka k setkání)	#
`public`	`ACCESS_ONLINE_ONLY = 1` Přihlášen pouze na on-line setkání (vztah k účastníka k setkání) Přihlášen pouze na on-line setkání (vztah k účastníka k setkání)	#
`public`	`ACCESS_RECORD_ONLY = 2` Přihlášen pouze k prohlížení záznamu (vztah k účastníka k setkání) Přihlášen pouze k prohlížení záznamu (vztah k účastníka k setkání)	#
`public`	`ACCESS_ONLINE_AND_RECORD = 3` Přihlášen na on-line setkání i k prohlížení záznamu (vztah k účastníka k setkání) Přihlášen na on-line setkání i k prohlížení záznamu (vztah k účastníka k setkání)	#

Namespaces

Interfaces

Interface App\Api\WebmeetingInferface

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns