DescribeWhiteboardPush

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: DescribeWhiteboardPush.
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. This API only supports: ap-singapore.
SdkAppId	Yes	Integer	SdkAppId of the whiteboard application.
TaskId	Yes	String	ID of the whiteboard push task.

3. Output Parameters

Parameter Name	Type	Description
FinishReason	String	Reason for push stop. - AUTO: Pushing automatically stops because no upstream audio/video or whiteboard operation occurs in the room for a long time. - USER_CALL: The API for stopping pushing is called. - EXCEPTION: An exception occurred.
TaskId	String	ID of the whiteboard push task.
Status	String	Status of the push task. - PREPARED: Push in preparation (including entering the room and starting the push service). - PUSHING: Pushing in progress. - STOPPED: Pushing stopped.
RoomId	Integer	Room ID.
GroupId	String	Group ID of the whiteboard.
PushUserId	String	User ID of the push task.
PushStartTime	Integer	Actual push start time, which is a Unix timestamp in seconds.
PushStopTime	Integer	Actual push stop time, which is a Unix timestamp in seconds.
ExceptionCnt	Integer	Number of exceptions during push.
IMSyncTime	Integer	IM timestamp corresponding to the first frame of the whiteboard push video. The timestamp is used for time synchronization between IM messages and the whiteboard push video during playback.
Backup	String	Result information of the backup push task. Note: This parameter may return null, indicating that no valid values can be obtained.
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 Querying a whiteboard push task

Input Example

https://tiw.intl.tencentcloudapi.com/?Action=DescribeWhiteboardPush
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<Common request parameters>

Output Example

{
    "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"
    }
}

Example2 Querying failed whiteboard push tasks

Input Example

https://tiw.intl.tencentcloudapi.com/?Action=DescribeWhiteboardPush
&SdkAppId=1400000001
&TaskId=ghucnligqtgtvk2624mb
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "d290f1ee-6c54-4b01-90e6-d701748f0851"
    }
}

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

Tencent Cloud CLI 3.0

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
FailedOperation.WhiteboardPush	Whiteboard push failed. For more information, see the error description.
InvalidParameter.BodyParameterTypeUnmatched	The parameter type does not match.
InvalidParameter.TaskNotFound	The task to query does not exist.
ResourceUnavailable.NotRegistered	TIW is not enabled.
ResourceUnavailable.ServiceExpired	The account is in arrears or the TIW service has expired.
UnauthorizedOperation.SdkAppId	The SdkAppId does not exist or does not match the current Tencent Cloud account.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

tencent cloud

Sign Up

Log in

Compute

Microservice

Data Migration

Database SaaS Tool

Data Security

Application Security

Big Data

Voice Technology

Internet of Things

Stream Services

Cloud Real-time Rendering

Management and Audit Tools

Edge Computing

Serverless

Relational Database

Networking

Business Security

Domains & Websites

Face Recognition

AI Platform Service

Middleware

Media On-Demand

Game Services

Developer Tools

Container

Essential Storage Service

Enterprise Distributed DBMS

CDN and Acceleration

Security Services

Enterprise Applications

Tencent Big Model

Natural Language Processing

Communication

Media Process Services

Education Sevices

Monitor and Operation

Distributed cloud

Data Process and Analysis

NoSQL Database

Network Security

Cloud Security

Office Collaboration

Image Creation

Optical Character Recognition

Interactive Video Services

Media SDK

Cloud Resource Management

More

1. API Description

2. Input Parameters

3. Output Parameters

4. Example

Example1 Querying a whiteboard push task

Input Example

Output Example

Example2 Querying failed whiteboard push tasks

Input Example

Output Example

5. Developer Resources

SDK

Command Line Interface

6. Error Code