获取短信模板列表GetSmsTemplateAndOrderList

最近更新时间：2023.04.20 19:36:39

首次发布时间：2023.01.17 16:20:40

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

接口说明

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

请求参数

参数	数据类型	是否必填	示例值	描述
AccessKey	string	是	AKLTNzEzY2****	发送请求的火山引擎账号的 Access Key ID。您可以登录密钥管理页面获取。
SecretKey	string	是	RGTLuSHvnYxn****	发送请求的火山引擎账号的 Secret Access Key。您可以登录密钥管理页面获取。
ServiceName	string	是	volcSMS	服务名称。短信服务的服务名称为`volcSMS`。
Region	string	是	cn-north-1	区域名称。短信服务的区域名称为`cn-north-1`。
Content-Type	string	是	application/json;charset=utf-8	指定请求消息体的结构化格式。短信服务的 Content-Type 为`application/json;charset=utf-8`。

Query

参数	是否必填	数据类型	示例值	描述
Action	是	string	GetSmsTemplateAndOrderList	接口名称。该接口固定值为GetSmsTemplateAndOrderList。
Version	是	string	2021-01-11	接口版本。短信服务接口版本为`2021-01-11`。
subAccount	是	string	A123****	消息组ID
area	是	string	cn	国家/地区 cn：中国大陆 overseas：国际/中国港澳台 all：所有
templateId	否	string	ST_712****	模版ID
name	否	string	test	模版名称
channelType	否	string	CN_OTP	模版类型 CN_OTP：国内验证码 CN_NTC：国内通知短信 CN_MKT：国内营销短信 I18N_OTP：国际验证码短信 I18N_MKT：国际营销短信
content	否	string	你的验证码是${code}	模版内容

返回参数

请求响应数据以JSON格式返回，以下仅列出了短信业务逻辑相关的字段，其他公共返回参数详见返回结果。

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见Result。

ResponseMetadata

参数	数据类型	描述
RequestId	string	请求 ID。
Action	string	请求的接口名称。
Version	string	请求的版本号。
Service	string	请求的服务名称。
Region	string	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

参数	数据类型	描述
list	[]SmsTemplateInfo	模版列表，包含的参数说明请参见SmsTemplateInfo。

SmsTemplateInfo

参数	数据类型	描述
id	string	ID
templateId	string	模板ID
channelType	string	短信类型 CN_OTP：国内验证码 CN_NTC：国内通知短信 CN_MKT：国内营销短信 I18N_OTP：国际验证码短信 I18N_MKT：国际营销短信
channelTypeName	string	短信类型名称 CN_OTP：国内验证码 CN_NTC：国内通知短信 CN_MKT：国内营销短信 I18N_OTP：国际验证码短信 I18N_MKT：国际营销短信
name	string	模板名称
content	string	模板内容
status	int	审核状态，1: 审核中，2: 未通过，3: 已开通，4: 已关闭，5: 免审
isOrder	bool	是否是审核工单
reason	string	审核原因
createdTime	int	创建时间
shortUrlConfig	shortUrlConfig	短链接配置，只有营销短信有这个参数
isEnabled	string	短链接配置开关。0: 未启用，1:启用
rawUrl	string	转短链接的原始长链接

Error

参数	数据类型	描述
Code	string	错误码。
Message	string	错误信息。

示例

请求示例

https://sms.volcengineapi.com/?Action=GetSmsTemplateAndOrderList&Version=2021-01-11&area=cn&subAccount=19cb0b72

返回示例

正确返回示例

{
    "ResponseMetadata":{
        "RequestId":"202209081707130102080361061D370281",
        "Action":"GetSmsTemplateAndOrderList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "list":[
            {
                "id":"59510",
                "templateId":"ST_6ed69cd9",
                "name":"test",
                "content":"你的验证码是${code}",
                "status":3,
                "reason":"",
                "createdTime":1652167628,
                "channelType":"CN_NTC",
                "channelTypeName":"国内通知短信",
                "isOrder":true,
                "shortUrlConfig":{
                    "isEnabled":"0"
                }
            },
            {
                "id":"55040",
                "templateId":"ST_6df45f41",
                "name":"测试",
                "content":"a.zjytxd.cn/8fJs，回T退订",
                "status":3,
                "reason":"",
                "createdTime":1648135626,
                "channelType":"CN_MKT",
                "channelTypeName":"国内营销短信",
                "isOrder":false,
                "shortUrlConfig":{
                    "isEnabled":"1",
                    "rawUrl":"https://www.volcengine.com/docs/6361/67380"
                }
            }
        ]
    }
}

错误返回示例

{
    "ResponseMetadata": {
        "RequestId":"202209081707130102080361061D370281",
        "Action":"GetSmsTemplateAndOrderList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1",
        "Error": {
            "Code": "ZJ10200",
            "Message": "请求参数错误"
        }
    }
}

错误码

如果您在返回结果中遇到错误消息，可以使用下表作为详细信息和解决方案的指南。其中火山引擎网关公共错误码请参考火山引擎网关公共错误码。

Code	Message	说明
1001	错误描述	参数错误
1015	exceed qps limit	超过接口频控限制
1999	错误描述	系统错误