nece001/php-sdk-coze

php 扣子应用

1.0.0 2025-08-26 11:48 UTC

Requires

• php: >=7.2
• firebase/php-jwt: ^6.0
• guzzlehttp/guzzle: ^7.0
• psr/log: ^1.0
• psr/simple-cache: ^1.0

MIT

• nece001

README

简介

Coze PHP SDK（php-sdk-coze）是一个用于集成 Coze 平台 API 的 PHP 开发包，支持音频处理、对话管理、知识库、文件、变量、工作流等多种功能模块，便于开发者快速对接 Coze 智能体服务。

安装方法

推荐使用 Composer 进行安装：

composer require nece001/php-sdk-coze

需确保 PHP 版本为 7.2 及以上，且已安装 GuzzleHttp 依赖。

主要功能

• 获取并管理 AccessToken
• 音频处理（Audio）
• 空间与智能体管理（Bot）
• 渠道管理（Connectors）
• 对话与消息（Conversation）
• 知识库（Datasets）
• 文件管理（Files）
• 变量管理（Variables）
• 工作流（Workflow）

快速开始

获取密钥：
进入[授权页面](https://www.coze.cn/open/oauth/pats)，在“OAuth 应用”选项卡中，点击“创建新应用”。
第一步：基本信息
应用类型：普通
客户端类型：服务类应用。
第二步：配置
公钥和私钥：点击右侧的“创建key”，生成“公钥指纹”和“私钥文件”，私钥文件文件会立即下载。
权限：将需要用到的权限选中。
以上2步完成后，返回列表页，列表中的“应用 ID”就是”$client_id“。

1. 初始化 Client

use Nece\Sdk\Coze\Client;

$client_id = '应用列表中的：应用 ID';
$client_secret = '创建key后生成的：公钥指纹';
$private_key = '创建key后下载的：私钥内容';

$client = new Client($client_id, $client_secret, $private_key);

2. 设置日志与缓存（可选）

// 设置 PSR-3 日志记录器
$client->setLogger($logger);
// 设置 PSR-16 缓存器
$client->setCacher($cache);

3. 调用各模块接口

获取 AccessToken

$accessToken = $client->getAccessToken()->getAccessToken();

音频处理

$audioApi = $client->audio();
// 具体方法请参考 Audio 类文档

对话管理

$conversationApi = $client->conversation();
$data = $conversationApi->conversations('会话ID');

其他模块

调用方式类似：

• $client->bot()
• $client->connectors()
• $client->datasets()
• $client->files()
• $client->variables()
• $client->workflow()

依赖说明

• guzzlehttp/guzzle
• psr/log（可选，用于日志）
• psr/simple-cache（可选，用于缓存）

常见问题

1. AccessToken 获取失败？
   • 请检查 client_id、client_secret、private_key 是否正确，网络是否可达。
2. 接口调用报错？
   • 检查参数是否正确，建议开启日志查看详细错误信息。
3. 如何自定义 HTTP 配置？
   • 构造 Client 时传入 $http_config 数组即可。
4. 为何没有 WebSocket 语音的API
   • WebSocket 语音的API直接由前端调用，只需从本SDK中获取Access_Token交给前端使用即可。

贡献与支持

如有问题或建议，欢迎提交 Issue 或 PR。

License

MIT

运行单元测试

1. 修改配置：vendor\nece001\php-sdk-coze\tests\bootstrap.php
2. 运行命令：vendor/bin/phpunit -c vendor/nece001/php-sdk-coze/tests/phpunit.xml