BigBlueButton REST API 命令行客户端

这是一个小巧但实用的命令行客户端，可以直接通过BigBlueButton服务器或集群的REST API来控制会议和录制。它允许管理员绕过前端应用（如greenlight、moodle或替代品）并直接访问后台BBB服务器以执行管理任务、监控或测试。

此模块也可以作为Python库导入，但请注意，该项目在任何方面都尚未被视为稳定。可能随后会有一个更稳定且更易用的Python脚本API。

安装

# Install via pip
sudo pip install -U bbbctl
# or manually:
sudo curl -L https://raw.githubusercontent.com/defnull/bbbctl/master/src/bbbctl.py -o /usr/local/bin/bbbctl
sudo chmod +x /usr/local/bin/bbbctl

用法

# Only required for external BBB servers:
export BBBCTL_SERVER="https://bbb.example.com/"
export BBBCTL_SECRET="..."

bbbctl meeting list    # Test your secret by listing current meetings
bbbctl -h              # Print help for a list of commands

如果直接在具有足够权限的BBB服务器上运行，将自动从本地BBB配置文件中获取服务器URL和密钥。

命令概览

您可以通过bbbctl -h或bbbctl <command> -h获取详细帮助和所有参数列表。

• meeting 创建、列出、加入、检查或结束会议
  • list 列出所有会议
  • info <meetingID> 显示会议信息
  • create <meetingID> <title> 创建新会议
  • join <meetingID> <displayName> 生成加入链接
  • end <meetingID> 强制结束会议
  • nuke 强制结束所有会议（请谨慎操作）
• record 操作录制
  • list 列出所有录制
  • info <recordID> 显示录制信息
  • publish <recordID> 发布未发布的录制
  • unpublish <recordID> 取消发布（隐藏）录制
  • delete <recordID> 删除录音（请谨慎操作）

输出格式

默认输出格式为可读性强的纯文本格式。您可以使用--format=compact切换到更紧凑的版本。还支持其他更适合脚本使用的格式：json、jsonline或xml

许可证

版权（c）2020-2022，Marcel Hellkamp。

在此特此授予任何获得本软件及其相关文档副本（以下简称“软件”）的人免费处理软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利，并允许软件的接收者这样做，前提是遵守以下条件

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

软件按“原样”提供，不提供任何形式的保证，无论是明示的还是暗示的，包括但不限于适销性、针对特定目的的适用性和非侵权性。在任何情况下，作者或版权所有者均不对任何索赔、损害或其他责任承担责任，无论是基于合同、侵权或其他原因，无论是源于、因之或与此软件或软件的使用或其他处理有关。