Jak korzystać z modułu Zoom

Zoom Moduł umożliwia pracę z serwisem Zoom API (https://marketplace.zoom.us/docs/guides/).

Instalacja modułu Zoom

API Key oraz Secret Key twojej Zoom aplikacji muszą być najpierw pobrane(https://marketplace.zoom.us/develop/create?source=devdocs). Podążając za linkiem zobaczysz kilka typów Zoom aplikacji do wyboru.

Zoom's app API Key oraz Secret Key zostaną wyświetlone po wybraniu typu aplikacji.

Meeting i Recurrence Modele danych

Po zainstalowaniu modułu Zoom w projekcie tworzone są również dwa wirtualne modele danych: Meeting oraz Recurrence. Pierwszy z nich odnosi się do samego obiektu połączenia wideo i Recurrence odpowiada za regularność (powtarzalność) tego spotkania wideo. Pomocnicze w tworzeniu i wykorzystaniu tych modeli danych są następujące BP:

• Make Zoom Meeting - tworzy obiekt o Meeting typu modelu danych:
  • Join_url [string] - link do spotkania;
  • start_time [datetime] - czas rozpoczęcia spotkania;
  • Status [string] - status spotkania;
  • Type [enum] - typ spotkania
    • Instant - nieplanowane, jednorazowe spotkanie
    • Scheduled - spotkanie zaplanowane
    • Recurring with no fixed time - powtarzające się spotkanie bez ustalonego czasu
    • Recurring with fixed time - powtarzające się spotkanie z ustalonym czasem
  • Meeting_id [integer] - identyfikator spotkania;
  • Agenda [string] - informacja o porządku spotkania;
  • Topic [string] - temat spotkania;
  • Recurrence [recurrence typ obiektu] - obiekt o Recurrence typ modelu danych;
  • Password [string] - hasło spotkania;

• Expand Zoom Meeting - rozszerza obiekt typu Meeting typu modelu danych;
  • Join_url [string] - link do spotkania;
  • start_time [datetime] - godzina rozpoczęcia spotkania;
  • Status [string] - status spotkania;
  • Type [enum] - typ spotkania
    • Instant - niezaplanowane, jednorazowe spotkanie
    • Scheduled - spotkanie terminowe
    • Recurring with no fixed time - powtarzające się spotkanie bez ustalonego czasu
    • Recurring with fixed time - powtarzające się z ustalonym czasem
  • Meeting_id [integer] - identyfikator spotkania;
  • Agenda [string] - informacja o porządku spotkania;
  • Topic [string] - temat spotkania;
  • Recurrence [recurrence typ obiektu] - obiekt o Recurrence typ modelu danych;
  • Password [string] - hasło spotkania;

• Make Zoom Recurrence - tworzy obiekt typu Recurrence typu modelu danych;
  • Type [enum] - typ rekurencji
    • Daily
    • Weekly
    • Monthly
  • Ends_time [integer] - liczba wystąpień spotkania rekurencyjnego przed jego anulowaniem, pomiędzy wartością 1 a 50. Nie można używać tego klawisza z klawiszem end_date_time kluczem.
  • Monthly_day [integer] - wymagany tylko dla spotkań powtarzających się co miesiąc. Dzień miesiąca, w którym odbywa się spotkanie cykliczne, w zakresie od 1 do 31.
  • Weekly_days [enum] - wymagane tylko w przypadku spotkań cyklicznych tygodniowych (1 - poniedziałek, 2 - wtorek, ... , 7 - niedziela).
  • Repeat_interval [integer] - interwał powtarzania spotkania. Dla dziennego przedziału czasowego, maksymalnie 90 dni. Dla interwału tygodniowego, maksymalnie 12 tygodni.
  • End_date_time [datetime] - ostateczna data i godzina zakończenia spotkania cyklicznego przed jego anulowaniem, w formacie UTC. Nie można używać tego klucza z kluczem end_times kluczem.

• Expand Zoom Recurrence - rozszerza obiekt typu Recurrence typu data model;
  • Type [enum] - typ powtarzającego się spotkania.
    • Daily
    • Weekly
    • Monthly
  • Ends_time [integer] - liczba powtórzeń spotkania przed jego anulowaniem, od 1 do 50. Nie można używać tego klucza z kluczem end_date_time kluczem.
  • Monthly_day [integer] - wymagany tylko dla spotkań powtarzających się co miesiąc. Dzień miesiąca, w którym odbywa się spotkanie cykliczne, w zakresie od 1 do 31.
  • Weekly_days [enum] - wymagane tylko w przypadku spotkań cyklicznych tygodniowych (1 - poniedziałek, 2 - wtorek, ... , 7 - niedziela).
  • Repeat_interval [integer] - interwał powtarzania spotkania. Dla dziennego przedziału czasowego, maksymalnie 90 dni. Dla interwału tygodniowego, maksymalnie 12 tygodni.
  • End_date_time [datetime] - ostateczna data i godzina zakończenia spotkania cyklicznego przed jego anulowaniem, w formacie UTC. Nie można używać tego klucza z kluczem end_times kluczem.

Procesy biznesowe, które pracują z Zoom Module

Preinstalowane Zoom modułowe procesy biznesowe są dostępne tylko dla backendu aplikacji:

• Zoom: Get meeting - pobiera obiekt spotkania o podanym identyfikatorze:
  • Meeting_id [integer] - identyfikator spotkania;

• Zoom: Delete meeting - usuwa rekord spotkania z DB z podanym identyfikatorem;
  • Meeting_id [integer] (wymagane) - identyfikator spotkania;

• Zoom: Update meeting - aktualizuje obiekt spotkania w DB z podanym identyfikatorem:
  • Meeting_id [integer] (wymagane) - identyfikator spotkania;
  • Topic [string] - temat spotkania;
  • Type [enum] - rodzaj spotkania
    • Instant - nieplanowane, jednorazowe spotkanie
    • Scheduled - spotkanie terminowe
    • Recurring with no fixed time - powtarzające się spotkanie bez ustalonego czasu
    • Recurring with fixed time - powtarzające się z ustalonym czasem
  • start_time [datetime] - czas rozpoczęcia spotkania;
  • Join_url [string] - link do spotkania;
  • Password [string] - hasło spotkania;
  • Agenda [string] - informacja o porządku spotkania;
  • Recurrence [recurrence typ obiektu] - obiekt o Recurrence typ modelu danych;

• Zoom: Create Meeting - tworzy obiekt o Meeting typu modelu danych:
  • Type [enum] - typ spotkania
    • Instant - nieplanowane, jednorazowe spotkanie
    • Scheduled - spotkanie terminowe
    • Recurring with no fixed time - powtarzające się spotkanie bez ustalonego czasu
    • Recurring with fixed time - powtarzające się o stałej porze
  • Password [string] - hasło spotkania;
  • Agenda [string] - meeting agenda info;
  • Recurrence [recurrence type of object] - obiekt typu Recurrence typ modelu danych;
  • User_id [string] (wymagane) - adres użytkownika ID lub adres e-mail.

• Zoom: List meetings - użyj tego API do zestawienia zaplanowanych spotkań użytkownika (gospodarza spotkania). Użytkownik jest zdefiniowany za pomocą swojego API_KEY;
  • Page_size [integer] - liczba rekordów zwróconych w ramach jednego API wywołania. Domyślnie ustawiona jest na 30.
  • Page_number [integer] - numer strony bieżącej w zwróconych rekordach. Domyślnie ustawiony na 1.

Przykład użycia

Przyjrzyjmy się przykładowi generowania. Zoom link do spotkania po kliknięciu przycisku. Aby wykorzystać procesy biznesowe modułu we front-endzie aplikacji, pierwszym krokiem jest ustawienie. Endpoint aby utworzyć generowanie linków (Zoom: Create meeting).

1. Utwórz nową grupę w Endpoints sekcji.
2. Po utworzeniu grupy należy wykonać nowy Endpoint. Zoom: Create meeting Proces biznesowy powinien być traktowany jako POST typ żądania.
3. W procesie biznesowym aplikacji internetowej można wykorzystać nowo utworzony endpoint jak na przykładzie poniżej. Tutaj generowany jest link, który jest przekazywany jako Label właściwość Label gdy przycisk zostanie kliknięty (onClick).

Wynik pokazany jest poniżej: