# polyv-php-sdk

**Repository Path**: lsqpy/polyv-php-sdk

## Basic Information

- **Project Name**: polyv-php-sdk
- **Description**: 保利威 php sdk
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-04
- **Last Updated**: 2025-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# think-polyv-live

保利威直播API集成插件，适用于ThinkPHP8框架，封装了保利威直播API的常用功能，便于在ThinkPHP项目中快速集成和使用。

## 功能特点

- 封装保利威直播API常用功能：创建直播间、管理回放、生成签到等
- 支持请求签名认证
- 提供简洁的API调用方式
- 支持日志记录
- 完全兼容ThinkPHP8框架

## 安装

### 1. 通过Composer安装

使用Composer安装插件：

```bash
composer require polyv/think-polyv-live
```

### 2. 发布配置文件

安装完成后，在ThinkPHP8项目中执行以下命令发布配置文件：

```bash
php think polyv-live:publish
```

或者手动复制配置文件（通常Composer会自动处理配置文件的发布）。

### 3. 配置API参数

编辑`config/polyv-live.php`文件，填入您的保利威API信息：

```php
return [
    // API基础配置
    'base_url' => 'https://api.polyv.net/live/v3',
    
    // 认证信息
    'user_id' => 'your_user_id', // 保利威用户ID
    'app_id' => 'your_app_id',   // 应用ID
    'app_secret' => 'your_app_secret', // 应用密钥
    'access_key' => 'your_access_key', // 访问密钥
    
    // 请求配置
    'timeout' => 30,            // 请求超时时间（秒）
    'connect_timeout' => 10,    // 连接超时时间（秒）
    
    // 日志配置
    'log' => [
        'enabled' => true,
        'level' => 'info',     // 日志级别：debug, info, notice, warning, error
    ],
];
```

## 快速使用示例

### 创建直播间示例

```php
<?php

namespace app\controller;

use think\Controller;
use PolyvLive\Facade\PolyvLive;
use think\Exception;

class LiveController extends Controller
{
    /**
     * 创建保利威直播间示例
     */
    public function createChannel()
    {
        try {
            // 创建一个2小时后开始，持续2小时的直播间
            $result = PolyvLive::channel()->create([
                'channelName' => '产品发布会直播间',
                'channelPasswd' => 'live2023', // 直播间密码
                'startTime' => date('Y-m-d H:i:s', time() + 3600 * 2),
                'endTime' => date('Y-m-d H:i:s', time() + 3600 * 4),
                'channelDesc' => '最新产品发布会直播，欢迎观看！'
            ]);
            
            // 获取创建成功的直播间信息
            $channelId = $result['channelId'];
            $watchUrl = $result['watchUrl'];
            $pushUrl = $result['pushUrl'];
            
            return json([
                'code' => 0,
                'message' => '直播间创建成功',
                'data' => [
                    'channelId' => $channelId,
                    'watchUrl' => $watchUrl,
                    'pushUrl' => $pushUrl
                ]
            ]);
        } catch (Exception $e) {
            return json([
                'code' => 1,
                'message' => '创建失败：' . $e->getMessage()
            ]);
        }
    }
}
```

## 更多使用方法

### 门面方式调用（推荐）

```php
use PolyvLive\Facade\PolyvLive;

// 获取直播间列表
$channels = PolyvLive::channel()->list(['pageNum' => 1, 'pageSize' => 10]);

// 获取回放视频列表
$videos = PolyvLive::video()->list(['pageNum' => 1, 'pageSize' => 10]);

// 创建签到活动
$signIn = PolyvLive::signIn()->create([
    'channelId' => '123456',
    'signName' => '直播签到',
    'duration' => 300, // 签到持续时间（秒）
]);
```

### 容器方式调用

```php
use think\facade\App;

// 获取客户端实例
$client = App::get('polyv-live');

// 发送自定义请求
$result = $client->request('GET', '/channel/list', ['pageNum' => 1, 'pageSize' => 10]);
```

## API 文档

详细API文档请参考保利威官方文档：[https://help.polyv.net/index.html#/live/api/introduce](https://help.polyv.net/index.html#/live/api/introduce)

## 支持的功能模块

### 账号管理 (AccountService)
- 查询账号可用直播分钟数
- 获取账号信息
- 查询账号套餐信息
- 查询账号直播统计数据
- 查询账号流量使用情况

### 分类管理 (CategoryService)
- 创建直播分类
- 获取直播分类列表
- 获取分类详情
- 更新直播分类
- 删除直播分类
- 移动分类顺序

### 直播间管理 (ChannelService)
- 创建直播间
- 获取直播间列表
- 获取直播间详情
- 更新直播间信息
- 删除直播间
- 重置推流地址
- 获取推流地址
- 获取观看地址

### 回放管理 (VideoService)
- 获取回放视频列表
- 获取回放视频详情
- 更新回放视频信息
- 删除回放视频
- 设置回放视频封面
- 获取回放视频播放地址

### 签到管理 (SignInService)
- 创建签到活动
- 获取签到活动列表
- 获取签到活动详情
- 更新签到活动
- 删除签到活动
- 开始签到
- 结束签到
- 获取签到结果

### 单点登录管理 (SSOService)
- 生成账号单点登录链接
- 生成子账号单点登录链接
- 生成频道单点登录链接
- 生成助教单点登录链接
- 验证单点登录签名

### AI助手管理 (AIAssistantService)
- 创建AI助手
- 获取AI助手列表
- 获取AI助手详情
- 更新AI助手
- 删除AI助手
- 关联AI助手与直播间
- 取消AI助手与直播间的关联
- 添加知识库
- 获取知识库列表

## 错误处理

所有API调用都会抛出异常，建议使用try-catch进行错误处理：

```php
try {
    $result = PolyvLive::channel()->create($params);
} catch (Exception $e) {
    // 处理异常
    echo '错误信息：' . $e->getMessage();
}
```

## License

This package is licensed under the [MIT License](LICENSE).