1. 接口描述
接口请求域名: tiw.tencentcloudapi.com 。
根据房间号搜索实时录制任务
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRecordSearch。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RecordTaskSet | Array of RecordTaskSearchResult | 录制任务搜索结果集合 |
TotalCount | Integer | 录制总任务数 示例值:151 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功
输入示例
https://tiw.tencentcloudapi.com/?Action=DescribeRecordSearch
&Offset=0
&Limit=1
&RoomId=880528
&<公共请求参数>
输出示例
{
"Response": {
"RecordTaskSet": [
{
"CreateTime": "2020-08-24T21:53:56+08:00",
"RoomId": 880528,
"TaskId": "gvft1qbrvs2331tcs1tb",
"Status": "FINISHED",
"SdkAppId": 1400127140,
"Result": {
"FinishReason": "USER_CALL",
"ExceptionCnt": 0,
"RoomId": 880528,
"GroupId": "880528",
"RecordStartTime": 1598277240,
"RecordStopTime": 1598277614,
"TotalTime": 368433,
"VideoInfos": [
{
"VideoDuration": 368332,
"UserId": "",
"VideoSize": 10731806,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/0cf156ea197a8012073e6b690f44e530.mp4",
"VideoType": 2,
"VideoPlayTime": 0,
"VideoFormat": "mp4",
"VideoId": "0cf156ea197a8012073e6b690f44e530",
"Width": 1280,
"Height": 960
},
{
"VideoDuration": 368325,
"UserId": "tic_mixstream_880528_custom",
"VideoSize": 12276476,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/ae62799da16a83ab9eb3da0bb37ef89f.mp4",
"VideoType": 3,
"VideoPlayTime": 108,
"VideoFormat": "mp4",
"VideoId": "ae62799da16a83ab9eb3da0bb37ef89f",
"Width": 1624,
"Height": 1000
},
{
"VideoDuration": 181102,
"UserId": "tic_mixstream_880528_101",
"VideoSize": 3743450,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/54797f6b83940a708c7b7aecc2f1d1a9.mp4",
"VideoType": 3,
"VideoPlayTime": 28918,
"VideoFormat": "mp4",
"VideoId": "54797f6b83940a708c7b7aecc2f1d1a9",
"Width": 496,
"Height": 368
},
{
"VideoDuration": 35405,
"UserId": "tiw_web_736",
"VideoSize": 3001045,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/7e562e9d513d12a2e03bea1514cc40fc.mp4",
"VideoType": 0,
"VideoPlayTime": 29475,
"VideoFormat": "mp4",
"VideoId": "7e562e9d513d12a2e03bea1514cc40fc",
"Width": 1280,
"Height": 720
},
{
"VideoDuration": 161885,
"UserId": "tiw_web_310",
"VideoSize": 9974368,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/9ba564cba92925a02a88ef3ee874b586.mp4",
"VideoType": 0,
"VideoPlayTime": 47535,
"VideoFormat": "mp4",
"VideoId": "9ba564cba92925a02a88ef3ee874b586",
"Width": 1280,
"Height": 720
},
{
"VideoDuration": 6085,
"UserId": "tiw_web_736",
"VideoSize": 283329,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/9517ed0696f910865ecaf22a07be4c0f.mp4",
"VideoType": 0,
"VideoPlayTime": 64903,
"VideoFormat": "mp4",
"VideoId": "9517ed0696f910865ecaf22a07be4c0f",
"Width": 960,
"Height": 540
},
{
"VideoDuration": 96787,
"UserId": "tiw_web_736",
"VideoSize": 5604352,
"VideoUrl": "http://whiteboard-cam-test-1257307760.cos.ap-nanjing.myqcloud.com/video/gvft1qbrvs2331tcs1tb/cdda0043fb734600d14324c4364213e2.mp4",
"VideoType": 0,
"VideoPlayTime": 115401,
"VideoFormat": "mp4",
"VideoId": "cdda0043fb734600d14324c4364213e2",
"Width": 1280,
"Height": 720
}
],
"OmittedDurations": [],
"Details": "",
"ErrorCode": 0,
"ErrorMsg": ""
}
}
],
"TotalCount": 151,
"RequestId": "bc309eaa-6d64-11e8-a7fe-5254000b4175"
}
}
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 | 操作失败。 |
InvalidParameter | 参数错误。 |
ResourceUnavailable.NotRegistered | 未开通互动白板。 |
ResourceUnavailable.ServiceExpired | 账户欠费或者互动白板服务已过期。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.SdkAppId | SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。 |