互动白板搜索白板推流任务-服务端 API-文档中心-腾讯云

1. 接口描述

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

根据房间号搜索白板推流任务

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeWhiteboardPushSearch。
Version	是	String	公共参数，本接口取值：2019-09-19。
Region	是	String	公共参数，详见产品支持的地域列表。

3. 输出参数

参数名称	类型	描述
WhiteboardPushTaskSet	Array of WhiteboardPushTaskSearchResult	推流任务搜索结果集合
TotalCount	Integer	推流总任务数示例值：1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 成功

输入示例

https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardPushSearch
&Offset=0
&Limit=1
&RoomId=101069223
&<公共请求参数>

输出示例

{
    "Response": {
        "WhiteboardPushTaskSet": [
            {
                "CreateTime": "2021-01-15T12:43:57+08:00",
                "RoomId": 101069223,
                "TaskId": "01bjgeeigsh31f3rh00c",
                "Status": "STOPPED",
                "SdkAppId": 1400313729,
                "PushUserId": "tic_push_user_101069223_107991",
                "Result": {
                    "RoomId": 101069223,
                    "GroupId": "101069223",
                    "FinishReason": "USER_CALL",
                    "ExceptionCnt": 0,
                    "PushStartTime": 1610685839,
                    "PushStopTime": 1610685852,
                    "IMSyncTime": 0,
                    "ErrorCode": 0,
                    "ErrorMsg": ""
                }
            }
        ],
        "TotalCount": 1,
        "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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InvalidParameter	参数错误。
InvalidParameter.SdkAppIdNotFound	SdkAppId不存在或格式错误。
ResourceUnavailable.NotRegistered	未开通互动白板。
ResourceUnavailable.ServiceExpired	账户欠费或者互动白板服务已过期。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.SdkAppId	SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。

搜索白板推流任务

本页目录：