查询二级模板详情-ListSecondTemplate--短信服务-火山引擎

文档中心

立即注册

导航

查询二级模板详情-ListSecondTemplate

最近更新时间：2025.10.13 22:41:39首次发布时间：2025.10.13 22:41:39

短信服务使用方可以调用ListSecondTemplate接口查看二级模板的签名绑定情况与审核状态

请求说明

请求方式：GET
接口地址：https://sms.volcengineapi.com/?Action=ListSecondTemplate&Version=2021-01-11

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	ListSecondTemplate	要执行的操作，取值：ListSecondTemplate
Version	String	是	2021-01-11	API的版本，取值：2021-01-11

Body

名称	类型	是否必填	示例值	描述
subAccounts	Array of String	否	["2dhwher","2dhw234"]	消息组ID集合,如果区分特定的消息组，需要填写，数组为空时针对全局创建
name	String	否	cx_test	模板名称
templateId	String	否	ST_123***	一级模板Id
signatureList	Array of String	否	["签名1","签名2"]	关联的签名列表,二级模板数据量可能比较大，因此，签名，模板，模板名称三个参数里面必须填写一个参数

响应数据

名称	类型	示例值	描述
ResponseMetadata	ResponseMetadata		响应公共参数。
Result	ListSecondTemplateResult		响应业务参数

示例

成功请求示例

请求

https://sms.volcengineapi.com/?Action=ListSecondTemplate&Version=2021-01-11&subAccounts=19cb****&page=1&pageSize=10

响应

{
    "ResponseMetadata":{
        "RequestId":"2022090818181501017423503804EC****",
        "Action":"ListSecondTemplate",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "templateId":"S1T_6ef6****",
                "secondTemplateId":"S2T_6ef6****",
                "content":"【签名1】你的验证码是${code}",
                "createdAt":1652167628,
                "reviewStatus":2,
                "industry":"game",
                "industryCn":"游戏",
                "channelType":"CN_NTC",
                "signature":"签名1",
                "shortUrlConfig":{
                    "isEnabled":"0"
                }
            },
            {
                "templateId":"S1T_6e06****",
                "secondTemplateId":"S2T_6e06****",
                "content":"【签名2】欢迎参加活动，拒收请回复R",
                "createdAt":1652167628,
                "reviewStatus":2,
                "industry":"educate",
                "industryCn":"教育",
                "channelType":"CN_MKT",
                "signature":"签名2",
                "shortUrlConfig":{
                    "isEnabled":"1",
                    "rawUrl":"https://www.volcengine.com/docs/6361/6***0"
                },
                "signatures":["签名1","签名2"]
            }
        ]
    }
}

失败请求示例

请求

https://sms.volcengineapi.com/?Action=ListSecondTemplate&Version=2021-01-11&subAccounts=19cb****&page=1&pageSize=10

响应

{
    "ResponseMetadata": {
        "RequestId":"2022090818181501017423503804EC****",
        "Action":"ListSecondTemplate",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
        "Error": {
            "Code": "1001",
            "Message": "请求参数错误"
        }
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误
200	1007	template check failed	模板申请时，校验失败