tencent cloud

APIs

DescribeNoticeContents

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-06-10 15:03:13

1. API Description

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

This API is used to obtain the notification content list.

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: DescribeNoticeContents.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region No String Common Params. This parameter is not required for this API.
Filters.N No Array of Filter
  • name
    Filter by [notification content template name].
    Type: String
    Required: No
  • noticeContentId
    Filter by [notification content template ID].
    Type: String
    Required: No

  • Each request can have up to 10 Filters. The upper limit of Filter.Values is 100.
    Offset No Integer Page offset. Default value: 0
    Limit No Integer Maximum number of entries per page. Default value: 20. Maximum value: 100.

    3. Output Parameters

    Parameter Name Type Description
    NoticeContents Array of NoticeContentTemplate Notification content template list.
    TotalCount Integer Total number of notification content templates that meet the conditions.
    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 Obtaining Notification Content Configuration List

    Obtaining Notification Content Configuration List

    Input Example

    POST / HTTP/1.1
    Host: cls.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeNoticeContents
    <Common request parameters>
    
    {
        "Filters": [
            {
                "Key": "name",
                "Values": [
                    "notice-name"
                ]
            }
        ],
        "Offset": 0,
        "Limit": 10
    }
    

    Output Example

    {
        "Response": {
            "NoticeContents": [
                {
                    "NoticeContentId": "noticetemplate-d20a21f7-f6ac-4a7b-ba1b-1aa49be5fed1",
                    "Name": "notice-name",
                    "Type": 0,
                    "NoticeContents": [
                        {
                            "Type": "Sms",
                            "TriggerContent": {
                                "Title": "title",
                                "Content": "this is content",
                                "Headers": []
                            },
                            "RecoveryContent": {
                                "Title": "title",
                                "Content": "this is content",
                                "Headers": [
                                    "Content-Type:application/json"
                                ]
                            }
                        }
                    ],
                    "Flag": 0,
                    "Uin": 100001,
                    "SubUin": 100001,
                    "CreateTime": 1693213128,
                    "UpdateTime": 1693213128
                }
            ],
            "TotalCount": 1,
            "RequestId": "d20a21f7-f6ac-4a7b-ba1b-1aa49be5fed1"
        }
    }
    

    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
    FailedOperation.TagQpsLimit The frequency of tag service requests is limited.
    InternalError Internal error.
    InvalidParameter Incorrect parameter.
    MissingParameter Missing parameter.
    OperationDenied Operation denied.
    OperationDenied.ACLFailed ACL verification failed.
    OperationDenied.AccountDestroy The account has been terminated.
    OperationDenied.AccountIsolate The account has overdue payments.
    OperationDenied.AccountNotExists The account does not exist.

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan