查询短信一级模板列表-ListSmsTemplateV2SDK--短信服务-火山引擎

文档中心

立即注册

导航

查询短信一级模板列表-ListSmsTemplateV2SDK

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

短信服务使用方可以调用ListSmsTemplateV2SDK，查询短信模板列表。

请求说明

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

请求参数

Query

名称	类型	是否必填	示例值	描述
Action	String	是	ListSmsTemplateV2SDK	要执行的操作，取值：ListSmsTemplateV2SDK
Version	String	是	2021-01-11	API的版本，取值：2021-01-11
SubAccounts	Array of String	否	["A123*","B123*"]	消息组ID列表,传空时,需要有全局权限,查询所有数据
templateId	String	否	S1T_712****	模版ID
name	String	否	testTemplate	模版名称
content	String	否	模板内容	模板内容
signature	String	否	测试签名1	一级模板被签名绑定
page	Int	是	1	分页查询，页码
pageSize	Int	是	10	分页查询，每页数量

响应数据

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

示例

成功请求示例

请求

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

响应

{
    "ResponseMetadata":{
        "RequestId":"202209081707130102080361061D37****",
        "Action":"ListSmsTemplateV2SDK",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "templateId":"S1T_6ed6****",
                "name":"test",
                "content":"你的验证码是${code}",
                "createdAt":1652167628,
                "channelType":"CN_NTC",
                "signatures":["签名1","签名2"]
                "shortUrlConfig":{
                    "isEnabled":"0"
                }
            },
            {
                "templateId":"S1T_6df4****",
                "name":"测试",
                "content":"a.z****d.cn/8**s，回T退订",
                "createdAt":1648135626,
                "channelType":"CN_MKT",
                "shortUrlConfig":{
                    "isEnabled":"1",
                    "rawUrl":"https://www.volcengine.com/docs/6361/6***0"
                },
                "signatures":["签名1","签名2"]
            }
        ]
    }
}

失败请求示例

请求

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

响应

{
    "ResponseMetadata": {
        "RequestId":"202209081707130102080361061D37****",
        "Action":"ListSmsTemplateV2SDK",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1",
        "Error": {
            "Code": "1001",
            "Message": "invalid subAccount"
        }
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误
200	1015	exceed qps limit	超过接口频控限制