查询白板推流任务

最近更新时间:2024-03-12 01:56:23

我的收藏

1. 接口描述

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

查询推流任务状态与结果

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeWhiteboardPush。
Version String 公共参数,本接口取值:2019-09-19。
Region String 公共参数,详见产品支持的 地域列表
SdkAppId Integer 客户的SdkAppId
示例值:1400000001
TaskId String 白板推流任务Id
示例值:ghucnligqtgtvk2624mb

3. 输出参数

参数名称 类型 描述
FinishReason String 推流结束原因,
- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
- USER_CALL: 主动调用了停止推流接口
- EXCEPTION: 推流异常结束
示例值:USER_CALL
TaskId String 需要查询结果的白板推流任务Id
示例值:ghucnligqtgtvk2624mb
Status String 推流任务状态
- PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
- PUSHING: 表示推流已开始
- STOPPED: 表示推流已停止
示例值:STOPPED
RoomId Integer 房间号
示例值:12345
GroupId String 白板的群组 Id
示例值:12345
PushUserId String 推流用户Id
示例值:tic_push_user_12345_abcde
PushStartTime Integer 实际开始推流时间,Unix 时间戳,单位秒
示例值:1611128339
PushStopTime Integer 实际停止推流时间,Unix 时间戳,单位秒
示例值:1611128339
ExceptionCnt Integer 推流过程中出现异常的次数
示例值:0
IMSyncTime Integer 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
示例值:0
Backup String 备份推流任务结果信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询白板推流任务

输入示例

https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardPush
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<公共请求参数>

输出示例

{
    "Response": {
        "ExceptionCnt": 0,
        "FinishReason": "USER_CALL",
        "GroupId": "880528",
        "IMSyncTime": 0,
        "PushStartTime": 1610591726,
        "PushStopTime": 1610591759,
        "PushUserId": "tic_push_user_880528_test1",
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "RoomId": 880528,
        "Status": "STOPPED",
        "Backup": "",
        "TaskId": "g42lfmu5uc3lpoqrqvvb"
    }
}

示例2 查询推流失败的白板推流任务

输入示例

https://tiw.tencentcloudapi.com/?Action=DescribeWhiteboardPush
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<公共请求参数>

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.WhiteboardPush",
            "Message": "code: 40006, msg: 2021-01-13 22:34:42, TRTC onError, code: -70003, msg: The UserSig in use is illegal. Please regenerate UserSig through official API. (FYI: https://cloud.tencent.com/document/product/269/32688 )\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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation.WhiteboardPush 白板推流失败,具体请参考错误描述。
InvalidParameter.BodyParameterTypeUnmatched 参数类型不匹配。
InvalidParameter.TaskNotFound 需要查询的任务不存在。
ResourceUnavailable.NotRegistered 未开通互动白板。
ResourceUnavailable.ServiceExpired 账户欠费或者互动白板服务已过期。
UnauthorizedOperation.SdkAppId SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。