ApplySmsTemplate - 申请短信模板--短信服务-火山引擎

文档中心

立即注册

导航

ApplySmsTemplate - 申请短信模板

最近更新时间：2024.09.23 11:19:35首次发布时间：2023.01.16 22:57:39

短信服务使用方可以调用ApplySmsTemplate接口申请短信模板。

请求说明

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

请求参数

Query

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

Body

名称	类型	是否必填	示例值	描述
subAccount	String	是	6df8****	消息组ID
area	String	是	cn	发送的国家/地区 cn：中国大陆 overseas：国际/中国港澳台
channelType	String	是	CN_OTP	短信类型 CN_OTP：国内验证码 CN_NTC：国内通知短信 CN_MKT：国内营销短信 I18N_OTP：国际验证码短信 I18N_MKT：国际营销短信
name	String	是	cx_test	模板名称
content	String	是	你的验证码是${code}	模板内容
desc	String	否	用于发送注册验证码	模板用途
shortUrlConfig	shortUrlConfig	否		当需要使用短链接配置时传入此参数

响应数据

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

示例

成功请求示例

请求

{
    "subAccount":"6df8****",
    "area":"cn",
    "name":"cx_test",
    "channelType":"CN_OTP",
    "desc":"用于发送注册验证码",
    "content":"你的验证码是${code}"
}

响应

{
    "ResponseMetadata":{
        "RequestId":"2022090818181501017423503804EC****",
        "Action":"ApplySmsTemplate",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result":{
        "applyId":"1****0",
        "templateId":"ST_712d****",
        "Name":"cx_test",
        "content":"你的验证码是${code}",
        "status":1,
        "reason":"",
        "createdTime":1662632296,
        "channelType":"CN_OTP",
        "channelTypeName":"国内验证码"
    }
}

失败请求示例

请求

{
    "subAccount":"6df8****",
    "area":"cn",
    "name":"cx_test",
    "channelType":"I18N_OTP",
    "desc":"用于发送注册验证码",
    "content":"你的验证码是${code}"
}

响应

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

错误码

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

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