获取通知内容模板

最近更新时间: 2026-10-10 00:14:48

1. 接口描述

接口请求域名： cls.api3.fincloud.tencent.com。

获取通知内容模板

默认接口请求频率限制：20次/秒。

接口更新时间：2025-03-27 16:30:14。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeNoticeContents
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters	否	否	Array of Filter	name 按照【通知内容模板名称】进行过滤。类型：String 必选：否 noticeContentId 按照【通知内容模板ID】进行过滤。类型：String 必选：否每次请求的Filters的上限为10，Filter.Values的上限为100。示例值：查看
Offset	否	否	Int64	分页的偏移量，默认值为0。示例值： 1
Limit	否	否	Int64	分页单页限制数目，默认值为20，最大值100。示例值： 1

3. 输出参数

参数名称	类型	描述
NoticeContents	Array of NoticeContentTemplate	通知内容模板列表。示例值：查看
TotalCount	Int64	符合条件的通知内容模板总数。示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
InternalError	内部错误。
OperationDenied	操作被拒绝。
OperationDenied.ACLFailed	ACL校验失败。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountNotExists	账户不存在。

5. 示例

示例1 获取通知内容配置列表。

获取通知内容配置列表。

输入示例

POST / HTTP/1.1
Host: cls.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribeNoticeContents
<Common Parameters>

{
  "Filters": [
    {
      "Key": "name",
      "Values": [
        "notice-name"
      ]
    }
  ],
  "Offset": 0,
  "Limit": 10
}

输出示例

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