tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ExtractTraceWatermark

Last updated: 2024-06-07 17:59:03

    1. API Description

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

    This API is used to extract the user ID of a user that distributed a video containing a digital watermark.

    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: ExtractTraceWatermark.
    Version Yes String Common Params. The value used for this API: 2018-07-17.
    Region No String Common Params. This parameter is not required.
    Url Yes String The URL of the media on which digital watermark extraction is to be performed.
    FileId No String The ID of the file specified by Url.
  • Note: This parameter is required.
    		•
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    SessionContext No String The source context, which is used to pass through user request information. The ExtractTraceWatermarkComplete callback and the ProcedureStateChanged callback will return the value of this parameter. It can contain up to 1,000 characters.
    SessionId No String The session ID, which is used for de-duplication. If there was a request with the same session ID in the last three days, an error will be returned for the current request. The session ID can contain up to 50 characters. If you do not pass this parameter or pass in an empty string, duplicate sessions will not be identified.
    TasksPriority No Integer The task priority, which can be a value from -10 to 10. The higher the value, the higher the priority. If this parameter is left empty, 0 will be used.
    ExtInfo No String A reserved parameter.

    3. Output Parameters

    Parameter Name Type Description
    TaskId String The task ID.
    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 Extracting the user ID of a user that distributed a video containing a digital watermark

    This example shows you how to extract the user ID of a user that distributed a video containing a digital watermark.

    Input Example

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

{
    "Url": "http://example.com/path/file.mp4",
    "FileId": "123422"
}

    Output Example

    {
    "Response": {
        "RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
        "TaskId": "125xxx65-procedurev2-bffb15f07530b57bc1aabb01fac74bca"
    }
}

    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

    There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy