README

此库是官方客户端，用于通过 REST API 与由 BBB On Demand 管理的实例进行交互 - 一项提供按需在云规模上提供 BigBlueButton 会议和实例的服务。该服务为用户提供了一切，使客户能够在云中运行 BigBlueButton 会议，而无需担心基础设施。

此库允许

管理运行 BigBlueButton 的实例
获取会议的详细信息
管理录音等。

库的用法

请确保已安装 composer。
将以下内容添加到您的 composer.json 文件中

{
    "repositories": [
        {
            "url": "https://github.com/bbbondemand/bbb-vm-php",
            "type": "git"
        }
    ],
    "require": {
        "bbbondemand/bbb-vm-php": "dev-main"
    }
}

运行以下命令安装库及其依赖项

composer install --no-dev

要与服务交互，请在 BBBOnDemand 上注册并获取以下凭据

客户账户 ID
On Demand 实例的 APITOKEN。

使用上述凭据运行代码示例

<?php declare(strict_types=1);
require __DIR__ . '/vendor/autoload.php';

$vm = \BBBondemand\Vm::mk([
    'customerId' => 'Your Customer Account ID',
    'customerApiToken' => 'Your APITOKEN for the For On Demand Instances',
]);
var_dump(
    $vm->getInstances()
);

可用方法（API）

主类 Vm 用于与服务交互，其方法名称与服务提供的 REST API 非常相似

REST API 调用
- 计费
  - getBillingSummary()
- 实例
  - getInstances()
  - createInstance()
  - getInstance()
  - stopInstance()
  - deleteInstance()
  - startInstance()
  - getInstanceHistory()
- 会议
  - getMeetings()
  - getMeeting()
- 录音
  - getRecordings()
  - getRecording()
  - unpublishRecording()
  - deleteRecording()
  - publishRecording()
- 区域
  - getRegions()
其他实用方法
- setUrlBuilder()
- getUrlBuilder()
- send()
- getLastResponse()
- setHttpClient()
- getHttpClient()

请参阅官方 Swagger 文档以获取此库支持的完整 REST API 描述。

用法示例

在 ./tests 目录中可以找到许多用法示例。

警告

使用此库的结果可能会产生费用。请参阅定价页面获取更多详细信息。

致谢

感谢

Bhavdip Pambhar (@bhavdip111)：为此库的初始版本做出贡献
@jackstr：为此库做出许多改进

版权声明

承认 BigBlueButton 精彩开源项目的所有版权和知识产权。

bbbondemand / bbb-vm-php

维护者

详情

README

库的用法

可用方法（API）

用法示例

警告

致谢

版权声明