Methods summary
public
|
#
createAccount( $name, $login, $email, $password )
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).
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
- Emailová adresa klienta
- $password
- Hash hesla pro konkrétního klienta, lze použít: md5() - bude přehashováno
|
public
|
#
updateMeeting( $login, $meetingId, $name, $time_begin, $speaker_name, $description, $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í nelze upravovat.
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 dokumentace)
|
public
|
#
createMeeting( $login, $name, $time_begin, $speaker_name, $description, $type )
Vytvoří nové setkání (poradu, meeting nebo webinář). V odpovědi vrací
ID setkání.
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 dokumentace)
|
public
|
#
deleteMeeting( $login, $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í nelze smazat.
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( $login, $meetingId, $options )
Nastaví další parametry pro již vytvořené setkání.
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)
|
public
|
#
getMeetings( $login, $meetingId )
Vrací seznam všech existujících setkání.
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( $login, $number, $surname, $firstname, $email )
Vytvoří účastníka - t.j. někoho, kdo se může účastnit setkání. V odpovědi
vrací ID účastníka (jako $participantId).
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( $login, $participantId, $number, $surname, $firstname, $email )
Upraví existujícího účastníka.
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( $login, $participant_id )
Smaže existujícího účastníka.
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( $login, $participant_id )
Vrací seznam všech existujících účastníků.
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( $login, $meetingId, $participantId, $level )
Nastaví účastníkovi přístup k setkání.
Nastaví účastníkovi přístup k setkání.
Parameters
- $login
- Login uživatele
- $meetingId
- ID setkání
- $participantId
- ID účastníka
- $level
- Nová úroveň přístupu (ACCESS_NONE, ACCESS_ONLINE_ONLY, ACCESS_RECORD_ONLY, ACCESS_ONLINE_AND_RECORD)
|
public
|
#
getAccess( $login, $meetingId, $participantId )
Zjistí aktuální nastavení úrovně přístupu k setkání (pro jednoho zvoleného a nebo pro všechny
přihlášené účastníky).
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
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( $login, $meetingId, $participants, $access_level )
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.
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
array 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( $login, $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 importParticipants()
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, $meetingId, $mode, $filter, $body )
Rozešle jednorázově pozvánky k setkání (s defaultním textem pozvánky).
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.
|
public
|
#
getModeratorAccess( $login, $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 "url" a "moderatorCode".
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
string
|
#
getModeratorEnterURL( $login, $meetingId, $moderatorName, $html5client )
Vrátí přímo URL místnosti pro moderátora k danému setkání.
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
string
|
public
|
#
getParticipantEnterURL( $login, $meetingId, $participantId, $html5client )
Vrátí přímo URL místnosti pro účastníka k danému setkání.
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
Returnss
string
|
public
|
#
importParticipantAndGetEnterURL( $login, $meetingId, $participants, $access_level, $html5client )
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í.
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
array Pole, kde klíčem je číslo záznamu ze vstupu $participants a hodnotou URL pro vstup účastníka na setkání
|
public
|
#
getRecordings( $login, $meetingId )
Vrátí seznam nahrávek k danému setkání vč. odkazů pro jejich přehrání.
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
array 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( $login, $meetingId )
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.
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
array 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
|
#
isLoginUsed( $login )
Zjistí, zda existuje uživatel s daným loginem - vyhrazeno pro vnitřní
použití a pro partnery.
Zjistí, zda existuje uživatel s daným loginem - vyhrazeno pro vnitřní
použití a pro partnery.
|
public
|
#
setAccessLevel( $login, $accessLevel, $days )
Přenastaví uživateli placený program - vyhrazeno pro vnitřní použití a pro partnery.
Přenastaví uživateli placený program - vyhrazeno pro vnitřní použití a pro partnery.
- pokud login neexistuje, skončí s chybou,
- pokud je novy program $accessLevel stejný jako starý program, prodlouží tento program o $days dni
- pokud je novy program $accessLevel jiný než starý program (a nebo pokud starý program už vypršel), nastaví nový program od teď na $days dni
|