Meetings API Technische Details

Inhalt

• Meetings API oder Video API?: Bestimmen Sie, welche API für Ihr Projekt am besten geeignet ist.
• Terminologie: Wichtige Begriffe und Definitionen für die Meetings API.
• Zimmer-Typen: Legt die verfügbaren Raumtypen fest.
• Website & App einbetten: Verwenden Sie einen iFrame, um ein Meeting in eine Website oder Anwendung einzubetten.
• Referenz: Weitere Informationen über die Meetings API.
• Preisgestaltung: Informationen über die Kosten für die Nutzung der Meetings API.

Meetings API oder Video API?

Sowohl die Meetings API als auch die Video API ermöglichen es Ihnen, hochwertige interaktive Video-Meetings in Ihren Web-Applikationen zu verwenden. Die Meetings API ist ideal für diejenigen, die Plug-and-Play-Meetings mit begrenzter Anpassung wünschen; es sind nur ein paar Zeilen Code erforderlich, um ein Meeting zu generieren und in Ihre Anwendung einzubetten. Die Video API ist ideal für diejenigen, die mehr Anpassungsmöglichkeiten und Flexibilität wünschen, aber sie erfordert einen höheren Entwicklungsaufwand.

Werfen Sie einen Blick auf die Video API Dokumentation für weitere Informationen.

Terminologie

• Zimmer: der virtuelle Raum, in dem das Videomeeting stattfindet. Siehe Zimmer-Typen unten.
• Teilnehmer:
  • Eigentümer: In der Regel der Ersteller des Raumes, hat diese Person besondere Verwaltungsfähigkeiten.
  • Gast: Personen, die an der Sitzung teilnehmen. Die Gäste haben Zugang zu den Standardfunktionen für Meetings.
  • Jeder Raum kann bis zu 250 Teilnehmer mit 25 aktiven Videostreams aufnehmen.
• Einrichtung und Konfiguration:
  • Anfrage: das Code-Snippet, das Sie einreichen, um einen Raum einzurichten.
  • Antwort: die Daten, die von Ihrer Anfrage zurückgegeben werden.
  • Tagungsraum-ID: die ID ist ein Sitzungsbezeichner, der in der Antwort auf eine Besprechungsanfrage zurückgegeben wird.
  • SitzungDie Zeitspanne zwischen dem Eintritt des ersten Teilnehmers und dem Austritt des letzten Teilnehmers ist definiert als alle Ereignisse, die während dieser Zeitspanne stattfinden.
  • Gast-URLTagungsraum URL, der von den Gästen genutzt wird.
  • Host-URLURL des Besprechungsraums mit Funktionen zur Besprechungsverwaltung, die vom Gastgeber verwendet werden.
  • Thema: die Menge der Farben, Logos und Stile, die für bestimmte Räume im Account gelten sollen.
• Eigenschaften:
  • WhitelabelDie Möglichkeit, Räume mit einem bestimmten Branding oder Farbschema zu gestalten.
  • Chat: Raum für schriftliche Mitteilungen, die für alle Teilnehmer im Raum sichtbar sind.
  • Aufnahme: Sie können eine Aufzeichnung manuell während einer Besprechung starten oder die Besprechung so einstellen, dass sie automatisch aufgezeichnet wird, wenn Sie eine Anfrage senden. Sie können auch festlegen, dass nur der Besitzer des Raums aufgezeichnet wird.
  • Raum-Management: Sie können Informationen über Räume löschen, aktualisieren oder abrufen.
  • Rückrufe: ermöglichen es Ihnen, Informationen über eine Sitzung zu erhalten.
  • Warteraum: Legen Sie fest, welche Genehmigungsstufe für die Teilnahme an der Besprechung erforderlich ist. Die Teilnehmer treten dem Warteraum bei, bis entweder der Eigentümer beigetreten ist oder bis der Eigentümer sie zugelassen hat, je nach der erforderlichen Genehmigungsstufe.

Zimmer-Typen

Es gibt zwei Zimmertypen:

• Sofortiger Raum:
  • Erstellt für ein Meeting, das jetzt stattfindet.
  • Aktiv für zehn (10) Minuten, bis der erste Teilnehmer den Raum betritt. Wenn innerhalb dieser zehn Minuten niemand dem Raum beitritt, wird der Raum gelöscht.
  • Aktiv für zehn Minuten nach Verlassen des letzten Teilnehmers, dann wird sie gelöscht.
• Langfristiges Zimmer:
  • Bleibt bis zu dem von Ihnen angegebenen Verfallsdatum (maximal ein Jahr) bestehen.
  • In der Regel mit einer wiederkehrenden Besprechung, Person oder Ressource verbunden.
  • Erfordert die Angabe eines Verfallsdatums (im ISO-Format).
  • Ermöglicht es Ihnen, zu beantragen, dass ein Raum zehn Minuten, nachdem der letzte Teilnehmer den Raum verlassen hat, automatisch gelöscht wird.

Website und App einbetten

Ein über die API erstelltes Meeting kann in Ihre Website und mobilen Anwendungen eingebettet werden. Generieren Sie dazu den Link zur Besprechung und erstellen Sie einen iFrame mit der Funktion GUEST_URL:

<iframe src="$GUEST_URL" title="Embedded Meeting" allow="camera;microphone;display-capture"></iframe>

Dies wird derzeit sowohl auf dem Desktop als auch auf dem Handy mit den folgenden Browsern unterstützt:

• Desktop - Unterstützt von Firefox und Chrome basierten Browsern.
• iOS 14+ - Unterstützt von Safari, Edge oder Firefox.
• Android - Unterstützt mit Chrome oder Samsung Browser v14+.

Das Meeting kann in jeder Größe über 360PX angezeigt werden, die Anzahl der verfügbaren Funktionen hängt jedoch von der Größe des iFrames ab:

¹ Die Aufzeichnung ist in 360-500PX-Sitzungen weiterhin möglich, indem Sie die Option auto_record Parameter im API-Aufruf.

Preisgestaltung

Die Preise richten sich nach Teilnehmer- und Aufzeichnungsminuten.

Teilnehmer-Protokolle

Eine Teilnehmerminute wird pro Teilnehmer und Minute in einer Sitzung berechnet; der Minutentarif richtet sich danach, wie viele Teilnehmerminuten Sie pro Monat nutzen:

Wenn Sie beispielsweise bis zu 100.000 Teilnehmerminuten verbraucht haben, würde ein 1-stündiges Gespräch mit 4 Teilnehmern 1,14 € kosten, wobei 0,00475 € pro Minute berechnet werden.

Aufzeichnung des Protokolls

Eine Aufzeichnungsminute wird pro Minute der Aufzeichnung einer Sitzung berechnet; der Minutentarif richtet sich danach, wie viele Aufzeichnungsminuten Sie pro Monat nutzen:

Wenn Sie beispielsweise bis zu 50.000 Minuten verbraucht haben, kostet die Aufzeichnung eines 1-stündigen Gesprächs 2,10 € und wird mit 0,035 € pro Minute berechnet.

Referenz

• Meetings API-Referenz