高级功能与服务端 API
  • 云端录制
  • 音视频流推至CDN
  • 通过 TRTC 实现与 RTMP 互通
  • 服务端事件回调
    • 房间与媒体回调
    • 旁路转推回调
    • 云端录制回调
    • 签名校验示例
  • 发送和接收消息
  • 访问管理
    • 产品概述
    • 可授权的资源及操作
    • 预设策略
    • 自定义策略
  • 启用高级权限控制
  • 如何通过 OBS WHIP 推流至 TRTC 房间
  • 服务端 API
    • 接口分类
    • 历史记录
    • 发出接口请求
      • 请求结构
      • 通用参数
      • 签名方法 v3
      • 签名
      • 回复
    • 房间管理接口
      • SetUserBlockedByStrRoomId
      • SetUserBlocked
      • RemoveUser
      • DismissRoom
      • RemoveUserByStrRoomId
      • DismissRoomByStrRoomId
    • 通话质量监控接口
      • DescribeRoomInfo
      • DescribeUserEvent
      • DescribeCallDetailInfo
      • DescribeUserInfo
      • DescribeScaleInfo
    • 输入在线媒体流相关接口
      • StartStreamIngest
      • StopStreamIngest
      • DescribeStreamIngest
    • 云端录制接口
      • CreateCloudRecording
      • DescribeCloudRecording
      • ModifyCloudRecording
      • DeleteCloudRecording
    • 混流转推相关接口
      • UpdatePublishCdnStream
      • StartPublishCdnStream
      • StopPublishCdnStream
    • 用量统计相关接口
      • DescribeTrtcUsage
      • DescribeRecordingUsage
      • DescribeMixTranscodingUsage
      • DescribeRelayUsage
      • DescribeTrtcRoomUsage
    • 数据类型
    • 错误码
    • 附录
      • 事件 ID 映射表

可授权的资源及操作

注意:
本文档主要介绍 实时音视频 TRTC 访问管理功能的相关内容,其他产品访问管理相关内容请参见 支持 CAM 的产品
访问管理的核心功能可以表达为:允许或禁止某账号对某些资源进行某些操作。TRTC 访问管理支持 资源级授权,资源的粒度是 TRTC 应用,操作的粒度是 云 API,包括 服务端 API 以及访问 TRTC 控制台时可能会用到的 API。
如有 TRTC 访问管理需求,请登录腾讯云 主账号 使用 预设策略自定义策略 完成具体授权操作。

可授权的资源类型

TRTC 访问管理可授权的资源类型为 应用

支持资源级授权的 API

除了部分 不支持资源级授权的 API ,本小节列出的所有 API 操作均支持资源级授权。 授权策略语法 中对这些 API 操作的资源语法描述均相同,具体为:
授权所有应用访问权限:qcs::trtc::uin/${uin}:sdkappid/*
授权单个应用访问权限:qcs::trtc::uin/${uin}:sdkappid/${SdkAppId}

服务端 API 操作

接口名称
接口分类
功能描述
房间管理
解散房间
房间管理
移出用户
房间管理
移出用户(字符串房间号)
房间管理
解散房间(字符串房间号)
混流转码
启动云端混流
混流转码
结束云端混流转码
混流转码
启动云端混流(字符串房间号)
混流转码
结束云端混流(字符串房间号)
通话质量监控
创建异常信息
通话质量监控
查询异常体验事件
通话质量监控
查询用户列表与通话指标
通话质量监控
查询历史房间和用户数
通话质量监控
查询房间列表
通话质量监控
查询历史用户列表

控制台 API 操作

接口名称
使用模块
功能描述
DescribeAppStatList
TRTC 控制台

概览
获取应用列表
DescribeSdkAppInfo
获取应用信息
ModifyAppInfo
编辑应用信息
ChangeSecretKeyFlag
修改权限密钥状态
CreateWatermark
上传图片
DeleteWatermark
删除图片
ModifyWatermark
编辑图片
DescribeWatermark
查找图片
CreateSecret
创建对称式加密密钥
ToggleSecretVersion
切换密钥版本(公私钥/对称式加密密钥)
DescribeSecret
TRTC 控制台

获取对称式加密密钥
DescribeTrtcAppAndAccountInfo
获取应用及账号信息来获取公私钥
CreateSecretUserSig
使用对称式加密密钥生成 UserSig
DescribeSig
TRTC 控制台

获取使用旧版公私钥生成的UserSig
VerifySecretUserSig
对称式加密密钥生成的 UserSig 校验
VerifySig
公私钥生成的 UserSig 校验
CreateSpearConf
新增画面设定配置。此功能设置卡片仅对 iLiveSDK 1.9.6 及之前的版本可见,TRTC SDK 6.0及以后版本请参见 设定画面质量
DeleteSpearConf
删除画面设定配置。此功能设置卡片仅对 iLiveSDK 1.9.6 及之前的版本可见,TRTC SDK 6.0及以后版本请参见 设定画面质量
ModifySpearConf
修改画面设定配置。此功能设置卡片仅对 iLiveSDK 1.9.6 及之前的版本可见,TRTC SDK 6.0及以后版本请参见 设定画面质量
DescribeSpearConf
获取画面设定配置。此功能设置卡片仅对 iLiveSDK 1.9.6 及之前的版本可见,TRTC SDK 6.0及以后版本请参见 设定画面质量
ToggleSpearScheme
切换画面设定场景。此功能设置卡片仅对 iLiveSDK 1.9.6 及之前的版本可见,TRTC SDK 6.0及以后版本请参见 设定画面质量


不支持资源级授权的 API

由于特殊限制,下述 API 不支持资源级授权:

服务端 API 操作

接口名称
接口分类
功能描述
特殊限制说明
DescribeDetailEvent
通话质量监控
获取详细事件
输入参数无 SDKAppID ,无法进行资源级授权。
DescribeRecordStatistic
其他接口
查询云端录制计费时长
业务原因,暂不支持资源级授权
DescribeTrtcInteractiveTime
其他接口
查询音视频互动计费时长
业务原因,暂不支持资源级授权
DescribeTrtcMcuTranscodeTime
其他接口
查询旁路转码计费时长
业务原因,暂不支持资源级授权

控制台 API 操作

接口名称
使用模块
功能描述
特殊限制说明
DescribeTrtcStatistic
TRTC 控制台

概览
获取计费时长用量统计数据
该接口包含返回全量 SDKAppID 的统计数据,限制非全量 SDKAppID 将返回错误。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
DescribeDurationPackages
TRTC 控制台

概览
获取预付费套餐包列表
预付费套餐包为单个腾讯云账号下的所有 TRTC 应用共享,套餐包信息中无 SDKAppID 参数,无法进行资源级授权
GetUserList
TRTC 控制台 监控仪表盘
获取用户列表
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
GetUserInfo
TRTC 控制台 监控仪表盘
获取用户信息
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
GetCommState
TRTC 控制台 监控仪表盘
获取通话状态
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
GetElasticSearchData
TRTC 控制台 监控仪表盘
查询 ES 数据
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
CreateTrtcApp
TRTC 控制台

创建 TRTC 应用
输入参数无 SDKAppID,无法进行资源级授权。SDKAppID 是 TRTC 应用的唯一标识,创建应用之后才有 SDKAppID 信息
HardDescribeMixConf
查询自动旁路推流状态
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
ModifyMixConf
开启/关闭自动旁路推流
输入参数无 SDKAppID,无法进行资源级授权。如有需要,可通过 DescribeAppStatList 接口来限制可查询的应用列表
RemindBalance
TRTC 控制台 套餐包管理
获取预付费套餐包余额告警信息
预付费套餐包为单个腾讯云账号下的所有 TRTC 应用共享,套餐包信息中无 SDKAppID 参数,无法进行资源级授权

注意:
针对不支持资源级授权的 API 操作,您仍然可以通过 自定义策略 向用户授予使用该操作的权限,但是策略语句的资源元素必须指定为*