ApplyVmsTemplate - 申请视频短信模板--短信服务-火山引擎

文档中心

立即注册

导航

ApplyVmsTemplate - 申请视频短信模板

最近更新时间：2024.01.29 14:41:46首次发布时间：2023.03.01 16:55:06

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

请求说明

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

请求参数

Query

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

Body

名称	类型	是否必填	示例值	描述
subAccount	String	是	6df8****	消息组ID
name	String	是	cnTest	模板名称；不能重复，最多15个字符
signature	String	是	测试签名	签名
theme	String	是	火山引擎测试	模板主题（视频短信手机端展示题目），最多15个字符
channelType	String	是	CN_VMS	发送类型，当前仅有`CN_VMS`
contents	VmsTemplateContent	是		模版内容
shortUrlConfig	shortUrlConfigReq	否		短链配置

响应数据

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

示例

成功请求示例

请求

{
    "subAccount": "6e2****",
    "channelType": "CN_VMS",
    "name": "测试1",
    "theme": "测试视频短信",
    "signature": "火山引擎测试",
    "contents": [{
        "sourceType": "text/string",
        "content": "测试${code}，拒收请回复R"
        }, {
        "sourceType": "image/jpg",
        "content": "/9j/4AAQSkZJRgABAQ*******************************************************************************************************************************EAMKlCELjICEIVSH/2Q=="
        }]
}

响应

{
    "ResponseMetadata": {
            "RequestId": "202303011124032D653CC93EFD818E****",
            "Service": "volcSMS",
            "Region": "cn-north-1",
            "Action": "ApplyVmsTemplate",
            "Version": "2021-01-11"
    },
    "Result": {
            "templateId": "VT_7482****"
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
200	1001	参数错误	参数错误
200	1999	系统错误	系统错误
200	1007	template check failed	模板申请时，校验失败
200	1016	未开通视频短信权限	账号未开通视频短信权限