You need to enable JavaScript to run this app.
导航

GetSmsTemplateAndOrderList - 获取短信模板列表

最近更新时间2024.01.29 14:41:45

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

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

请求说明

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

请求参数

Query

名称
类型
是否必填
示例值
描述
Action
String

GetSmsTemplateAndOrderList

要执行的操作,取值:GetSmsTemplateAndOrderList

Version
String

2021-01-11

API的版本,取值:2021-01-11

subAccount
String

A123****

消息组ID

area
String

cn

国家/地区范围

  • cn:中国大陆
  • overseas:国际/中国港澳台
  • all:全部
templateId
String

ST_712****

模版ID

name
String

testTemplate

模版名称

channelType
String

CN_OTP

模版类型

  • CN_OTP
  • CN_NTC
  • CN_MKT
  • I18N_OTP
  • I18N_MKT
content
String

你的验证码是${code}

模版内容

响应数据

名称
类型
示例值
描述
ResponseMetadata
ResponseMetadata

响应公共参数

Result
GetSmsTemplateAndOrderListResp

响应业务参数

示例

成功请求示例

请求

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

响应

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

失败请求示例

请求

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

响应

{
    "ResponseMetadata": {
        "RequestId":"202209081707130102080361061D37****",
        "Action":"GetSmsTemplateAndOrderList",
        "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

超过接口频控限制