PHPackages                             zegoim/server\_assistant - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. zegoim/server\_assistant

ActiveLibrary[Utility & Helpers](/categories/utility)

zegoim/server\_assistant
========================

Zego Server Assistant

1.0.0(1y ago)17831MITPHPPHP >=5.3.0

Since Oct 13Pushed 1y ago7 watchersCompare

[ Source](https://github.com/zegoim/zego_server_assistant_php)[ Packagist](https://packagist.org/packages/zegoim/server_assistant)[ Docs](https://www.zego.im)[ RSS](/packages/zegoim-server-assistant/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

\[toc\]

1. 安装
=====

[](#1-安装)

方式一(推荐)：composer 官方源packagist安装
-------------------------------

[](#方式一推荐composer-官方源packagist安装)

执行`composer require zegoim/server_assistant:1.0.0`进行安装使用

方式二(推荐)：composer repositories path类型安装
--------------------------------------

[](#方式二推荐composer-repositories-path类型安装)

将`token/php`目录下的 主体目录结构：

```
.
├── composer.json
├── composer.lock
├── packages
│   └── zego_server_assistant
└── src

```

composer.json添加path类型的仓库

```
{
//...
    "repositories": [
        {
            "type": "path",
            "url": "./packages/zego_server_assistant"
        }
    ]
//...
}
```

执行`composer require zegoim/server_assistant:1.0.0`进行安装。

方式三：Composer Autoload，即使用composer的PSR-4自动加载机制实现加载
-------------------------------------------------

[](#方式三composer-autoload即使用composer的psr-4自动加载机制实现加载)

1. 拷贝文件包至项目根目录下的某个目录中，例如这里以`/my_project/zego`目录为例，其中`/my_project/`为项目根目录
2. `vim /my_project/composer.json`加入`psr-4`自动加载配置

```
{
  ...
  "autoload": {
    "psr-4": {
      "ZEGO\\": "zego/src/ZEGO"
    }
  }
  ...
}
```

1. 执行 `composer dump-autoload` 或 `composer dump-autoload -o`（生产环境适用） 或 `composer update` 命令，生成自动加载文件

方式四：Symfony Class Auto Loader 注册自动加载，适合在未使用composer的项目中使用此方式
------------------------------------------------------------

[](#方式四symfony-class-auto-loader-注册自动加载适合在未使用composer的项目中使用此方式)

1. 拷贝文件包至项目根目录下的某个目录中，例如这里以`/my_project/zego`目录为例，其中`/my_project/`为项目根目录

使用时先引入自动加载器

```
require_once 'zego/auto_loader.php';
```

2. 使用
=====

[](#2-使用)

### 普通token 生成demo

[](#普通token-生成demo)

- 在`/my_project/xxx.php`文件中使用
- 普通token用于服务接口的简单权限验证的场景，payload字段可传空

```
require 'vendor/autoload.php';
use ZEGO\ZegoServerAssistant;
use ZEGO\ZegoErrorCodes;

$appId = 1;
$userId = 'demo';
$secret = 'fa94dd0f974cf2e293728a526b028271';
$payload = '';
$token = ZegoServerAssistant::generateToken04($appId,$userId,$secret,3600,$payload);
if( $token->code == ZegoErrorCodes::success ){
  print_r($token->token);
}
```

### 强验证token 生成demo

[](#强验证token-生成demo)

- 在`/my_project/xxx.php`文件中使用
- 强验证token用于对房间登录/推拉流权限需要进行强验证的场景，payload字段需要按照规格生成

```
require 'vendor/autoload.php';
use ZEGO\ZegoServerAssistant;
use ZEGO\ZegoErrorCodes;

//权限位定义
const PrivilegeKeyLogin   = 1; // 登录
const PrivilegeKeyPublish = 2; // 推流

//权限开关定义
const PrivilegeEnable     = 1; // 开启
const PrivilegeDisable    = 0; // 关闭

$appId = 1;
$userId = 'demo';
$roomId = "demo";
$secret = 'fa94dd0f974cf2e293728a526b028271';
$rtcRoomPayLoad = [
    'room_id' => $roomId, //房间id；用于对接口的房间id进行强验证
    'privilege' => [     //权限位开关列表；用于对接口的操作权限进行强验证
        PrivilegeKeyLogin => PrivilegeEnable,
        PrivilegeKeyPublish => PrivilegeDisable,
    ],
    'stream_id_list' => [] //流列表；用于对接口的流id进行强验证；允许为空，如果为空，则不对流id验证
];

$payload = json_encode($rtcRoomPayLoad);

$token = ZegoServerAssistant::generateToken04($appId, $userId, $secret, 3600, $payload);
if( $token->code == ZegoErrorCodes::success ){
  print_r($token);
}
```

3. 错误码说明
========

[](#3-错误码说明)

```
namespace ZEGO;

class ZegoErrorCodes{
    const success                       = 0;  // 获取鉴权 token 成功
    const appIDInvalid                  = 1;  // 调用方法时传入 appID 参数错误
    const userIDInvalid                 = 3;  // 调用方法时传入 userID 参数错误
    const secretInvalid                 = 5;  // 调用方法时传入 secret 参数错误
    const effectiveTimeInSecondsInvalid = 6;  // 调用方法时传入 effectiveTimeInSeconds 参数错误
}
```

4. generateToken04 参数及返回值说明
===========================

[](#4-generatetoken04-参数及返回值说明)

```
    /**
     * 根据所提供的参数列表生成用于与即构服务端通信的鉴权
     *
     * @param integer $appId Zego派发的数字ID, 各个开发者的唯一标识
     * @param string $userId 用户 ID
     * @param string $secret 由即构提供的与 appId 对应的密钥，请妥善保管，切勿外泄
     * @param integer $effectiveTimeInSeconds token 的有效时长，单位：秒
     * @param string $payload 业务扩展字段，json串
     * @return ZegoAssistantToken 返回 token 内容，值为ZEGO\ZegoAssistantToken对象，在使用前，请检查对象code属性是否为 ZEGO\ZegoErrorCodes::success。实际 token 内容保存在 token 属性中
     */
    public static function generateToken04(int $appId, string $userId, string $secret, int $effectiveTimeInSeconds, string $payload )
```

返回值为`ZEGO\ZegoAssistantToken`对象：

```
namespace ZEGO;

class ZegoAssistantToken{
    public $code;
    public $message = '';
    public $token;
}
```

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~430 days

Total

2

Last Release

518d ago

Major Versions

0.0.1 → 1.0.02024-12-17

### Community

Maintainers

![](https://www.gravatar.com/avatar/94401039d95e40a29ea5e2fc5b5822d28fd0b32bad2f3c604749a41fc7ff161e?d=identicon)[kleinxu](/maintainers/kleinxu)

---

Top Contributors

[![kleinxu](https://avatars.githubusercontent.com/u/25740350?v=4)](https://github.com/kleinxu "kleinxu (1 commits)")

---

Tags

zegoServer Assistant

### Embed Badge

![Health badge](/badges/zegoim-server-assistant/health.svg)

```
[![Health](https://phpackages.com/badges/zegoim-server-assistant/health.svg)](https://phpackages.com/packages/zegoim-server-assistant)
```

###  Alternatives

[magarrent/laravel-url-shortener

Simpler Url Shortener for Laravel

557.4k](/packages/magarrent-laravel-url-shortener)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)