保利威直播 CLI
执行前验证
在执行任何 CLI 命令之前，必须先验证账号认证状态。
1. 检测认证状态
CODEBLOCK0
2. 配置认证（如需要）
如果用户未配置认证，引导用户提供 AppID 和 AppSecret：
CODEBLOCK1
然后用用户提供的凭据配置：
CODEBLOCK2
3. 验证配置成功
CODEBLOCK3
快速开始
CODEBLOCK4
身份认证
CODEBLOCK5
频道命令
CODEBLOCK6
推流命令
CODEBLOCK7
商品命令
CODEBLOCK8
优惠券命令
CODEBLOCK9
回放命令
CODEBLOCK10
录制设置命令
CODEBLOCK11
场次命令
CODEBLOCK12
文档命令
CODEBLOCK13
统计命令
CODEBLOCK14
播放器命令
CODEBLOCK15
场景初始化
CODEBLOCK16
监控命令
CODEBLOCK17
聊天消息命令
CODEBLOCK18
禁言踢人命令 (Story 11-2)
CODEBLOCK19
签到管理命令 (Story 11-3)
CODEBLOCK20
问答管理命令 (Story 11-4)
CODEBLOCK21
问卷管理命令 (Story 11-4)
CODEBLOCK22
抽奖管理命令 (Story 11-5)
CODEBLOCK23
打赏管理命令 (Story 11-6)
CODEBLOCK24
观众信息查询命令 (Story 12-1)
CODEBLOCK25
观众标签管理命令 (Story 12-2)
CODEBLOCK26
观看条件配置命令 (Story 12-3)
CODEBLOCK27
JSON 配置文件格式示例 (watch-condition.json):
CODEBLOCK28
白名单管理命令 (Story 12-4)
CODEBLOCK29
平台账号信息管理命令 (Story 13-1)
CODEBLOCK30
回调设置管理命令 (Story 13-2)
CODEBLOCK31
全局频道设置管理
管理账号级别的全局频道设置，包括并发人数、转码、打赏等功能开关。
CODEBLOCK32
可用参数
| 参数 | 说明 | 值 |
|---|
| --channel-concurrences-enabled | 最大并发观看人数开关 | Y/N |
| --timely-convert-enabled |
自动转码开关 | Y/N |
| --donate-enabled | 打赏功能开关 | Y/N |
| --rebirth-auto-upload-enabled | 转存自动上传PPT | Y/N |
| --rebirth-auto-convert-enabled | 转存自动转码 | Y/N |
| --ppt-covered-enabled | PPT全屏开关 | Y/N |
| --cover-img-type | 封面图片类型 | contain/cover |
| --test-mode-button-enabled | 测试模式按钮 | Y/N |
转播管理命令 (Story 14-3)
CODEBLOCK33
卡片推送命令 (Story 14-2)
CODEBLOCK34
输出格式
大多数命令支持 -o table（默认表格格式）或 -o json（JSON格式，便于程序化处理）。
CODEBLOCK35
全局选项
CODEBLOCK36
常用工作流程
创建并开始直播
CODEBLOCK37
初始化电商直播场景
CODEBLOCK38
监控直播质量
CODEBLOCK39
详细文档
联系方式
- - 邮箱: support@polyv.net
- 官网: https://www.polyv.net/
- 保利威直播 API 文档: https://help.polyv.net/#/live/api/
- 技术支持: 400-993-9533
保利威直播 CLI
执行前验证
在执行任何 CLI 命令之前，必须先验证账号认证状态。
1. 检测认证状态
bash
npx polyv-live-cli@latest account list
2. 配置认证（如需要）
如果用户未配置认证，引导用户提供 AppID 和 AppSecret：
请提供你的保利威 AppID 和 AppSecret：
- - 访问 https://www.polyv.net/ 后台获取
- 路径：云直播 -> 设置 -> 开发者信息
然后用用户提供的凭据配置：
bash
npx polyv-live-cli@latest account add <名称> --app-id --app-secret
npx polyv-live-cli@latest account set-default <名称>
3. 验证配置成功
bash
npx polyv-live-cli@latest channel list
快速开始
bash
添加账号凭证
npx polyv-live-cli@latest account add myaccount --app-id
--app-secret
切换账号
npx polyv-live-cli@latest use myaccount
创建频道
npx polyv-live-cli@latest channel create -n 我的直播
获取推流密钥（用于OBS）
npx polyv-live-cli@latest stream get-key -c
开始直播
npx polyv-live-cli@latest stream start -c
监控直播状态
npx polyv-live-cli@latest stream status -c -w
身份认证
bash
账号管理
npx polyv-live-cli@latest account add <名称> --app-id --app-secret
npx polyv-live-cli@latest account list
npx polyv-live-cli@latest account set-default <名称>
npx polyv-live-cli@latest account remove <名称>
切换当前会话账号
npx polyv-live-cli@latest use <名称>
或使用内联凭证
npx polyv-live-cli@latest channel list --appId --appSecret
npx polyv-live-cli@latest channel list -a <账号名称>
频道命令
bash
增删改查操作
npx polyv-live-cli@latest channel create -n <名称> [-d <描述>] [--scene <场景类型>]
npx polyv-live-cli@latest channel list [-P <页码>] [-l <数量>] [--keyword <关键词>]
npx polyv-live-cli@latest channel get -c <频道ID>
npx polyv-live-cli@latest channel update -c <频道ID> [-n <名称>] [-d <描述>]
npx polyv-live-cli@latest channel delete -c <频道ID> [-f]
npx polyv-live-cli@latest channel batch-delete --channelIds ...
场景类型: topclass(大班课,默认) | alone(活动营销) | seminar(研讨会) | train(企业培训) | double(双师课,需开通) | guide(导播,需开通)
模板: ppt(三分屏-横屏,默认) | portraitppt(三分屏-竖屏) | alone(纯视频-横屏) | portraitalone(纯视频-竖屏) | topclass(纯视频极速-横屏) | portrait_topclass(纯视频极速-竖屏) | seminar(研讨会)
推流命令
bash
推流操作
npx polyv-live-cli@latest stream get-key -c <频道ID> # 获取RTMP地址和推流密钥
npx polyv-live-cli@latest stream start -c <频道ID> # 开始直播
npx polyv-live-cli@latest stream stop -c <频道ID> # 结束直播
npx polyv-live-cli@latest stream status -c <频道ID> [-w] # 查看状态（-w持续监控）
npx polyv-live-cli@latest stream push -c <频道ID> -f <文件> # 推送视频文件
npx polyv-live-cli@latest stream verify -c <频道ID> [-d 60] # 直播质量验证
npx polyv-live-cli@latest stream monitor -c <频道ID> [-r 5] # 实时监控面板
商品命令
bash
商品管理
npx polyv-live-cli@latest product list -c <频道ID>
npx polyv-live-cli@latest product add -c <频道ID> --name <名称> --price <价格>
npx polyv-live-cli@latest product get -c <频道ID> -p <商品ID>
npx polyv-live-cli@latest product update -c <频道ID> -p <商品ID> [--name <名称>]
npx polyv-live-cli@latest product delete -c <频道ID> -p <商品ID>
优惠券命令
bash
优惠券操作
npx polyv-live-cli@latest coupon add -c <频道ID> --name <名称> --type <类型> --discount <金额>
npx polyv-live-cli@latest coupon list -c <频道ID> [--status enabled|disabled]
npx polyv-live-cli@latest coupon delete -c <频道ID> --coupon-ids
优惠券类型: discount(折扣券), reduction(满减券)
回放命令
bash
回放管理
npx polyv-live-cli@latest playback list -c <频道ID>
npx polyv-live-cli@latest playback get -c <频道ID> --video-id <回放ID>
npx polyv-live-cli@latest playback delete -c <频道ID> --video-id <回放ID>
npx polyv-live-cli@latest playback merge -c <频道ID> --file-ids
录制设置命令
bash
回放设置管理
npx polyv-live-cli@latest record setting get -c <频道ID>
npx polyv-live-cli@latest record setting set -c <频道ID> [--playback-enabled Y|N] [--type single|list] [--origin playback|vod|record]
录制转存
npx polyv-live-cli@latest record convert -c <频道ID> --file-name <文件名> [--session-id <场次ID>] [--async]
npx polyv-live-cli@latest record set-default -c <频道ID> --video-id <视频ID> [--list-type playback|vod]
origin 类型: playback(回放列表), vod(点播列表), record(录制文件)
type 类型: single(单个回放), list(列表回放)
场次命令
bash
场次管理
npx polyv-live-cli@latest session list [-c <频道ID>] [--page <页码>] [--page-size <数量>]
npx polyv-live-cli@latest session get -c <频道ID> --session-id <场次ID>
状态值: unStart(未开始), live(直播中), end(已结束), playback(回放中), expired(已过期)
文档命令
bash
文档管理
npx polyv-live-cli@latest document list -c <频道ID> [--status <状态>] [--page <页码>] [--page-size <数量>]
npx polyv-live-cli@latest document upload -c <频道ID> --url <文件URL> [--type common|animate] [--doc-name <名称>]
npx polyv-live-cli@latest document delete -c <频道ID> --file-id <文档ID> [--type old|new] [--force]
npx polyv-live-cli@latest document status -c <频道ID> --file-id <文档ID>
状态值: normal, waitUpload, failUpload, waitConvert, failConvert
类型: common(普通转换), animate(动效转换)
统计命令
bash
查看每日观看统计
npx polyv-live-cli@latest statistics view -c <频道ID> --start-day 2024-01-01 --end-day 2024-01-31
查看历史并发数据
npx polyv-live-cli@latest statistics concurrency -c <频道ID> --start-date 2024
