实时音视频查询云端录制状态-服务端 API -文档中心-腾讯云

1. 接口描述

接口请求域名： trtc.tencentcloudapi.com 。

成功开启录制后，可以使用此接口来查询录制状态。仅在录制任务进行时有效，录制退出后查询将会返回错误。
录制文件上传到云点播VOD时，StorageFileList中不会返回录制文件信息，请订阅相关录制文件回调事件，获取录制文件信息。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCloudRecording。
Version	是	String	公共参数，本接口取值：2019-07-22。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-shanghai 。
SdkAppId	是	Integer	TRTC的SDKAppId，和录制的房间所对应的SDKAppId相同。示例值：1234
TaskId	是	String	录制任务的唯一Id，在启动录制成功后会返回。示例值：123

3. 输出参数

参数名称	类型	描述
TaskId	String	录制任务的唯一Id。示例值：123
Status	String	云端录制任务的状态信息。 Idle：表示当前录制任务空闲中 InProgress：表示当前录制任务正在进行中。 Exited：表示当前录制任务正在退出的过程中。示例值：InProgress
StorageFileList	Array of StorageFile	录制文件信息。示例值：[{"FileName": "1400188366_555666__UserId_s_amVmZjM._UserIde_main_audiovideo.m3u8","UserId": "jeff3","TrackType": "audio_video","BeginTimeStamp": 1730087526709}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询SdkAppId 为 1400366 TaskId 为 m9-bVVU7nhKM5X3GsED6KNGVG*ndibWSn631uT6pbhE4PcPDSsggE.的录制状态。

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudRecording
<公共请求参数>

{
    "TaskId": "m9-bVVU7nhKM5X3GsED6KNGVG********ndibWSn631uT6pbhE4PcPDSsggE.",
    "SdkAppId": 1400188366
}

输出示例

{
    "Response": {
        "Status": "InProgress",
        "StorageFileList": [],
        "RequestId": "c4536bd1-c3ea-4e84-b2dd-a8491d2057e2",
        "TaskId": "m9-bVVU7nhKM5X3GsED6KNGVG********ndibWSn631uT6pbhE4PcPDSsggE."
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnRealNameAuthenticated	未完成实名认证，不允许此操作。
AuthFailure.UnauthorizedOperation	CAM鉴权失败。
AuthFailure.UnsupportedOperation	不支持该操作。
FailedOperation	操作失败。
FailedOperation.CRUnsupportMethod	云端录制方法不支持。
InternalError.CRInternalError	云端录制内部服务错误。
InvalidParameter.OutOfRange	参数超出范围。
InvalidParameter.SdkAppId	SdkAppId参数错误。
MissingParameter.RoomId	缺少RoomId参数。
MissingParameter.SdkAppId	缺少SdkAppId参数。
MissingParameter.TaskId	缺少TaskId参数。
MissingParameter.UserId	缺少UserId参数。
ResourceNotFound	资源不存在。

查询云端录制状态

本页目录：