tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Game Multimedia Engine
    Documentation
    Download PDF

    DescribeTaskInfo

    Last updated: 2023-07-06 14:47:53
    Download PDF

    1. API Description

    Domain name for API request: gme.tencentcloudapi.com.

    This API is used to query the recording task in a room.

    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: DescribeTaskInfo.
    Version Yes String Common Params. The value used for this API: 2018-07-11.
    Region No String Common Params. This parameter is not required.
    BizId Yes Integer Application ID.
    RoomId Yes String Room ID.

    3. Output Parameters

    Parameter Name Type Description
    TaskId Integer ID of the ongoing task, which is returned from the StartRecord API.
    Note: This field may return null, indicating that no valid values can be obtained.
    RecordMode Integer Recording mode. Valid values: 1: single stream; 2: mixed streams; 3: single stream and mixed streams.
    Note: This field may return null, indicating that no valid values can be obtained.
    SubscribeRecordUserIds SubscribeRecordUserIds Allowlist or blocklist for stream subscription.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the recording task in a room

    This example shows you how to query the recording task in a room. The task ID is returned in the API response.

    Input Example

    POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskInfo
<Common request parameters>

{
    "RoomId": "9832",
    "BizId": 3400352518
}

    Output Example

    {
    "Response": {
        "SubscribeRecordUserIds": {
            "SubscribeUserIds": [
                3342
            ],
            "UnSubscribeUserIds": [
                7619
            ]
        },
        "RecordMode": 1,
        "RequestId": "h9167d24-a2c6-1125-a5bd-5c023ba721c2",
        "TaskId": 446192236330927912
    }
}

    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
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    InvalidParameterValue.InvalidBizId Invalid BizId.
    InvalidParameterValue.InvalidRoomId Invalid RoomId.
    OperationDenied Operation denied.
    ResourceNotFound.RoomNotFound The room does not exist.
    UnauthorizedOperation Unauthorized operation.
    UnsupportedOperation Operation unsupported.
    UnsupportedOperation.ServiceNotOpened The recording service is not activated.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy