tencent cloud

互动白板

产品简介
产品概述
使用限制
购买指南
计费概述
产品定价
免费试用
购买指引
欠费说明
月功能费计费说明
白板时长计费说明
文档转码计费说明
课中录制计费说明
退费说明
计费常见问题
服务端 API
History
Introduction
API Category
Making API Requests
Whiteboard Push APIs
Other APIs
Document Transcoding APIs
Real-Time Recording APIs
Statistics Query APIs
Whiteboard Snapshot APIs
Recording Video Generation APIs
Data Types
Error Codes
联系我们
服务协议
服务等级协议
相关协议
隐私协议
数据处理和安全协议

DescribeRecordSearch

PDF
聚焦模式
字号
最后更新时间: 2025-10-30 22:03:35

1. API Description

Domain name for API request: tiw.intl.tencentcloudapi.com.

This API is used to query real-time recording tasks by room ID.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeRecordSearch.
Version Yes String Common Params. The value used for this API: 2019-09-19.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.

3. Output Parameters

Parameter Name Type Description
RecordTaskSet Array of RecordTaskSearchResult The set of queried recording tasks.
TotalCount Integer Number of recording tasks.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Success.

Input Example

https://tiw.intl.tencentcloudapi.com/?Action=DescribeRecordSearch
&Offset=0
&Limit=1
&RoomId=880528
&<Common request parameters>

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
FailedOperation Operation failed.
InvalidParameter A parameter error occurred.
ResourceUnavailable.NotRegistered TIW is not enabled.
ResourceUnavailable.ServiceExpired The account is in arrears or the TIW service has expired.
UnauthorizedOperation Unauthorized operation.
UnauthorizedOperation.SdkAppId The SdkAppId does not exist or does not match the current Tencent Cloud account.

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈