404｜保利威帮助中心

直播服务端 API

使用须知
- API介绍
- 获取密钥
- 集团账号2.0获取密钥
- 更新日志
- 签名生成规则
- 快速接入示例
- 全局错误说明
- 授权和连麦token
- API在线调用
- 单点登录demo
- 调用限制
账号设置
- 查询全局频道设置
- 修改全局频道设置
- 查询页脚设置
- 修改页脚设置
- 查询观看次数开关
- 修改观看次数开关
用量查询
- 查询账号信息
- 查询用户套餐和资源信息
- 查询账号可用直播分钟数
- 查询账号连麦分钟数
- 查询账号时间范围连麦使用量
- 查询账号下收入详情
默认模板
- 观看条件
  - 查询默认模板观看条件
  - 修改默认模板观看条件
- 打赏设置
  - 查询默认模板打赏设置
  - 修改默认模板礼物打赏设置
- 回放设置
  - 查询默认模板回放设置
  - 修改默认模板回放设置
- 防录屏
  - 查询默认模板防录屏设置
  - 修改默认模板防录屏设置
- 观看页设置
  - 查询观看页默认模板设置
  - 修改观看页默认模板设置
频道管理
- 频道创建
- 频道查询
- 频道删除
  - 删除单个频道
  - 批量删除频道
- 频道修改
- 频道开关
  - 修改频道的功能开关状态
  - 查询频道的功能开关状态
- 频道状态
- 频道场次
- 频道列表
- 分类管理
- 标签管理
- 角色管理
- 字幕管理
直播截图
- 查询频道直播截图
伪直播
- 设置伪直播
- 结束伪直播
- 删除伪直播视频
- 获取硬盘推流(伪直播)视频列表
转播
- 查询转播频道信息
防录屏
- 查询频道防录屏信息
- 设置频道防录屏信息
- 防录屏说明
  - URL自定义跑马灯
  - 视频跑马灯–新的防录屏神器
商品库
- 添加频道商品
- 引用平台商品库商品
- 批量添加频道商品
- 查询频道商品库开关状态
- 查询频道商品列表
- 推送频道商品库商品
- 取消推送频道商品库商品
- 修改频道商品信息
- 修改频道商品库开关状态
- 修改频道商品库上下架状态
- 批量修改频道商品库上下架状态
- 通过上移下移修改频道商品库列表顺序
- 删除频道商品
- 批量删除频道商品
- 创建商品标签
- 删除商品标签
- 更新商品标签
- 查询商品标签列表
- 通过序号修改频道商品库列表顺序
- 置顶频道商品
- 取消置顶频道商品
- 分页查询频道商品统计列表
- 查询频道商品配置
- 修改频道商品配置
商品订单
- 查询商品订单列表
- 查询商品订单
- 批量更新订单状态
频道优惠券
- 查询频道优惠券列表
- 查询频道优惠券开关状态
- 修改频道优惠券开关状态
- 新增频道优惠券
- 删除频道优惠券
播放器
- 修改设置授权认证URL
- 观看页
  - 查询投诉反馈
观看页观看条件
- 查询频道观看条件
- 修改频道观看条件
- 修改频道外部授权设置
- 修改频道自定义授权设置
- 白名单观看
- 登记观看
  - 查询频道登记观看设置的字段信息
营销设置
- 任务奖励
- 广告
- 报名观看
  - 查看报名观看记录
- 卡片推送
- 公众号
  - 获取频道关注公众号设置信息
  - 修改频道关注公众号设置信息
- 微信分享
  - 查询频道微信分享信息
  - 修改频道微信分享信息
- 打赏
- 邀请海报
  - 创建邀请者
- 渠道推广
  - 渠道推广列表
  - 批量创建渠道推广
- 邀请员
- 直播预约
互动应用
- 问卷
- 抽奖
  - 创建抽奖活动
  - 修改抽奖活动
  - 删除抽奖活动
  - 查询抽奖活动详情
  - 查询抽奖活动列表
  - 查询观众中奖记录
  - 提交中奖信息
  - 提交中奖信息V4
  - 发起定时抽奖
  - 分组管理
  - 分组名单管理
  - 黑名单管理
- 答题卡
- 信息采集
聊天室
- 内容风控
- 公告
- 发送信息
- 签到功能
  - 批量设置签到
- 聊天审核
  - 更新聊天审核开关
- 问答
  - 查询频道问答列表
- 观众发言
  - 批量更新频道观众发言开关
  - 查询场次真实发言次数
- 发送点赞
- 直播聊天室JS-SDK
- 获取频道展示在线人数
文档管理
- 上传文档到某个频道
- 查询频道已上传文档列表
- 查询频道文档转码状态
- 删除文档
- 讲师文档关系管理
回放管理
- 观看回放设置
  - 查询频道回放设置
  - 修改频道回放设置
- 视频库
  - 直播暂存
  - 回放列表及点播列表
- 裁剪及合并
- 重制课件
云分发
- 查询分发地址信息
- 批量添加分发地址
- 批量修改分分发地址
- 批量删除分发地址
- 修改云分发频道总开关
- 批量修改频道云分发开关
- 查询云分发数据信息
AI应用
- 数字人
- 视频创作
素材库
- 查询素材库分类
- 查询素材列表
- 删除素材
- 标签
集团账号
- 创建集团分账号
- 分配分账号资源
- 查询分账号列表及剩余资源
- 查询主账号账单统计
- 查询集团主账号资源概览
- 集团账号分配记录查询
- 集团账号分账号用量预警回调
- 集团账号使用频道号获取外部授权秘钥
子账号
- 子账号
- 组织架构
- 角色
直播内容审核
- 音频审核设置
- 视频审核设置
用户
- 用户管理
- 用户标签管理
- 频道用户分组（后台）
数据统计
- 查询后台频道统计信息
- 查询频道实时并发数据
- 查询频道多场次概览统计数据
- 查询多个频道概览统计数据
- 查询多个频道实时并发数据
- 查询频道历史并发数据
- 查询频道历史最高并发数据
- 查询频道直播观看详情数据
- 查询时间范围内频道直播观看详情数据
- 分页查询频道直播观看详情数据
- 分页查询账号直播观看详情数据
- 查询时间内直播场次数据
- 查询观看记录
- 获取观众观看详情列表
- 查询直播场次汇总数据列表
- 聊天
  - 查询频道聊天记录
- 提问
  - 查询频道提问记录
- 登记观看
  - 查询频道登记观看记录
  - 下载频道登记观看记录
- 抽奖
  - 查询频道抽奖记录
  - 查询频道抽奖统计记录
  - 查询多个频道抽奖记录
  - 查询频道中奖记录
  - 下载频道中奖记录
- 问卷
  - 查询频道问卷题目与结果
  - 查询频道问卷结果
  - 分页查询频道问卷结果
- 签到
  - 查询频道发起的签到记录
  - 查询频道签到成功记录
  - 根据签到ID查询所有签到记录
- 答题卡
  - 查询频道答题卡结果
- 红包
  - 查询红包派发数据统计
- 邀请海报
  - 查询邀请海报明细数据
- 点赞
  - 分页查询频道点赞记录
- 打赏
  - 分页查询频道打赏记录
- 商品库
  - 获取频道商品统计概览
财务中心
- 用户帐单
  - 查询用户账单使用明细数据
  - 查询用户账单详情数据
直播服务授权
- 启动开播客户端
- 单点登录
- token设置
- 观众
平台设置
- 主播管理
- 平台商品库
- 平台内容库
  - 平台内容库分组列表
- 平台优惠券
开发设置
- 直播回调设置
- 频道回调设置
  - 查询频道回调设置
  - 修改频道回调设置
- 回调说明
- 积分说明
  - 积分开发指引
- 互动监听
  - 创建互动监听事件
  - 删除互动监听事件
常见问题
- 直播多码率有几种清晰度