CreateBlindWatermarkTemplate

Last updated: 2025-12-02 14:26:25Download PDF

1. API Description

Domain name for API request: mps.intl.tencentcloudapi.com.

This API is used to create a user-defined digital watermark template with an upper limit of 1000.

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: CreateBlindWatermarkTemplate.
Version	Yes	String	Common Params. The value used for this API: 2019-06-12.
Region	No	String	Common Params. This parameter is not required for this API.
Type	Yes	String	Digital watermark type. Valid values: blind-basic: basic copyright digital watermark; blind-nagra: NAGRA watermark.
TextContent	Yes	String	Text content of the digital watermark. The length cannot exceed 64 characters. After NAGRA watermark templates are created, the text content cannot be modified.
Name	No	String	Digital watermark template name, which supports Chinese, English, digits, underscores (_), hyphens (-), and periods (.). The length cannot exceed 64 characters.
Comment	No	String	Description information of the digital watermark template. The length cannot exceed 256 characters.

3. Output Parameters

Parameter Name	Type	Description
Definition	Integer	Unique identifier of the digital watermark template.
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 Creating a Digital Watermark Template

This example shows you how to create a digital watermark template.

Input Example

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

{
    "Name": "Digital watermark template 1",
    "Comment": "Digital watermark",
    "Type": "blind-nagra",
    "TextContent": "Digital watermark text"
}

Output Example

{
    "Response": {
        "Definition": 10,
        "RequestId": "93dda61a-c2c5-465d-a78c-0860997fb01b"
    }
}

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
FailedOperation.InvalidMpsUser	Operation failed: unauthorized MPS user.
InternalError	Internal error.
InternalError.GenDefinition	Internal error: failed to generate template ID.
InvalidParameterValue.Comment	Parameter error: template description.
InvalidParameterValue.DuplicatedTextContent	Duplicated watermark text.
InvalidParameterValue.Name	Incorrect parameter value: `Name` exceeds the length limit.
InvalidParameterValue.Type	Parameter error: incorrect `Type` value.
LimitExceeded.TooMuchTemplate	Limit reached: the number of templates exceeds the limit.