1. 接口描述
接口请求域名: tiw.tencentcloudapi.com 。
查询录制任务状态与结果
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeOnlineRecord。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SdkAppId | 是 | Integer | 客户的SdkAppId 示例值:1400000001 |
TaskId | 是 | String | 实时录制任务Id 示例值:ghucnligqtgtvk2624mb |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FinishReason | String | 录制结束原因, - AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止录制 - USER_CALL: 主动调用了停止录制接口 - EXCEPTION: 录制异常结束 - FORCE_STOP: 强制停止录制,一般是因为暂停超过90分钟或者录制总时长超过24小时。 示例值:USER_CALL |
TaskId | String | 需要查询结果的录制任务Id 示例值:ghucnligqtgtvk2624mb |
Status | String | 录制任务状态 - PREPARED: 表示录制正在准备中(进房/启动录制服务等操作) - RECORDING: 表示录制已开始 - PAUSED: 表示录制已暂停 - STOPPED: 表示录制已停止,正在处理并上传视频 - FINISHED: 表示视频处理并上传完成,成功生成录制结果 示例值:FINISHED |
RoomId | Integer | 房间号 示例值:880528 |
GroupId | String | 白板的群组 Id 示例值:880528 |
RecordUserId | String | 录制用户Id 示例值:tic_record_user_880528_test-01 |
RecordStartTime | Integer | 实际开始录制时间,Unix 时间戳,单位秒 示例值:1568949369 |
RecordStopTime | Integer | 实际停止录制时间,Unix 时间戳,单位秒 示例值:1568949392 |
TotalTime | Integer | 回放视频总时长(单位:毫秒) 示例值:18317 |
ExceptionCnt | Integer | 录制过程中出现异常的次数 示例值:0 |
OmittedDurations | Array of OmittedDuration | 拼接视频中被忽略的时间段,只有开启视频拼接功能的时候,这个参数才是有效的 |
VideoInfos | Array of VideoInfo | 录制视频列表 |
ReplayUrl | String | 回放URL,需配合信令播放器使用。此字段仅适用于视频生成模式 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://replayurl |
Interrupts | Array of Interrupt | 视频流在录制过程中断流次数 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实时录制任务
输入示例
https://tiw.tencentcloudapi.com/?Action=DescribeOnlineRecord
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<公共请求参数>
输出示例
{
"Response": {
"ExceptionCnt": 0,
"FinishReason": "USER_CALL",
"GroupId": "880528",
"OmittedDurations": [],
"RecordStartTime": 1568949369,
"RecordStopTime": 1568949392,
"RecordUserId": "tic_record_user_880528_test-01",
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"RoomId": 880528,
"Status": "FINISHED",
"TaskId": "ghucnligqtgtvk2624mb",
"TotalTime": 18317,
"ReplayUrl": "http://replayurl",
"Interrupts": [],
"VideoInfos": [
{
"UserId": "Mac_trtc_04",
"VideoDuration": 17969,
"VideoFormat": "mp4",
"VideoId": "dace3518e865e76a9e36712c629822ba",
"VideoPlayTime": 0,
"VideoSize": 593418,
"VideoType": 0,
"Width": 640,
"Height": 360,
"VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/d124f518e865e76a9e36712c629822ba.mp4"
},
{
"UserId": "tic_mixstream_880528_101",
"VideoDuration": 18205,
"VideoFormat": "mp4",
"VideoId": "763d1f6b8679c3f17fb118bd37d05c85",
"VideoPlayTime": 3,
"VideoSize": 765545,
"VideoType": 3,
"Width": 640,
"Height": 360,
"VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/763d1f6b86724f51fb118bd37d05c85.mp4"
},
{
"UserId": "tic_mixstream_880528_3",
"VideoDuration": 18222,
"VideoFormat": "mp4",
"VideoId": "1b9623df0516dc7318df89f6e7fffc1e",
"VideoPlayTime": 95,
"VideoSize": 402038,
"VideoType": 3,
"Width": 640,
"Height": 360,
"VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/1b9623df05124f51318df89f6e7fffc1e.mp4"
},
{
"UserId": "",
"VideoDuration": 17605,
"VideoFormat": "mp4",
"VideoId": "a8152f8faa2cfe621dc965a066a5813c",
"VideoPlayTime": 623,
"VideoSize": 226337,
"VideoType": 2,
"Width": 640,
"Height": 360,
"VideoUrl": "http://online-recording-1259648581.file.myqcloud.com/00sp43mantgtv4r842mb/a815224f512cfe621dc965a066a5813c.mp4"
}
]
}
}
示例2 查询录制失败的实时录制任务
输入示例
https://tiw.tencentcloudapi.com/?Action=DescribeOnlineRecord
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<公共请求参数>
输出示例
{
"Response": {
"Error": {
"Code": "FailedOperation.Record",
"Message": "code: 40004, msg: 2019-09-23 10:31:47, im login failed with code 6206, desc serSig expired\n"
},
"RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
}
}
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation.Record | 录制失败,具体请参考错误描述。 |
InvalidParameter.BodyParameterTypeUnmatched | 参数类型不匹配。 |
InvalidParameter.TaskNotFound | 需要查询的任务不存在。 |
ResourceUnavailable.NotRegistered | 未开通互动白板。 |
ResourceUnavailable.ServiceExpired | 账户欠费或者互动白板服务已过期。 |
UnauthorizedOperation.SdkAppId | SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。 |