申请视频短信模板ApplyVmsTemplate

最近更新时间：2023.04.17 15:55:18

首次发布时间：2023.03.01 16:55:06

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

接口说明

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

请求参数

参数	数据类型	是否必填	示例值	描述
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	是	ApplyVmsTemplate	接口名称。该接口固定值为`ApplySmsTemplate`。
Version	string	是	2021-01-11	接口版本。短信服务接口版本为`2021-01-11`。

Body

参数	类型	是否必填	示例值	描述
subAccount	string	是	6df864b1	消息组ID
name	string	是	cn_test	模板名称不能重复
theme	string	是	火山引擎测试	模板主题（视频短信手机端展示题目）
signature	string	否	签名	供应商报备
contents	json数组	否	模版内容	视频短信模板内容，目前不支持短链

contents

参数	类型	是否必填	示例值	描述
sourceType	string	是	类型	文本：text/string jpg图片：image/jpg png图片：image/png gif图片：image/gif mp4视频：video/mp4 mp3音频：audio/mp3
content	string	是	内容	文本类型：传string utf-8 其他类型：转base64编码

返回参数

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

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

ResponseMetadata

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

Result

参数	数据类型	描述
templateId	string	模板ID

Error

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

示例

请求示例

{
    "subAccount": "****",
    "channelType": "",
    "name": "SDK测试1",
    "theme": "SDK测试视频短信",
    "signature": "火山引擎测试",
    "contents": [{
        "sourceType": "text/string",
        "content": "测试${code}，T退订"
        }, {
        "sourceType": "image/jpg",
        "content": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAkGBwgHBgkIBwgKCgkLDRYPDQwMDRsUFRAWIB0iIiAdHx8kKDQsJCYxJx8fLT0tMTU3Ojo6Iys/RD84QzQ5OjcBCgoKDQwNGg8PGjclHyU3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3Nzc3N//AABEIAHgAeAMBIgACEQEDEQH/xAAbAAABBQEBAAAAAAAAAAAAAAAAAQIEBQYDB//EADsQAAEEAgAEAwQFCgcAAAAAAAEAAgMEBREGEiExEyJBBxQyURUjQlKBJDNDYWJxkaLR8BY1cnSCsbP/xAAaAQACAwEBAAAAAAAAAAAAAAADBAACBQEG/8QAHxEAAgMAAwEBAQEAAAAAAAAAAAECAxEEITESIkEy/9oADAMBAAIRAxEAPwCSU1Kjst3DGAKn4dLZOO5xLryR+T+VXB7Kl4ZDTx3MX/c6fyoV3+Q1K7PUwNJ3VOYFV2uIcRX6SXYS79l21mt4aKLIJdrI2OMLUpb9HYOxO0t6PPkBP/Jqh/4o4laXOk4ZkI16TAoLmiyRuNoWTpccY4hguVrdZx6O8SF3QrTUr1O/E6SlOyUN76XFNEw7Jd9E0oVzg7aCdpukKEweOyE3Z9EKFcMMhGh80LdMrA9EyrDjaNoZye5HFyt6tP2v75VByFkzyDGU+Y3ZunT7DT9paHA8GY+gznvNF6f1dJ1LVn8vkRj+Rvj1vSsbc4j4uDm1g/G47fV4d53KyxPBmIxznSuidZnPd8x31WjZHDBEIazeSMdgEnL6b2say5j6hghaQAGj8Al3sbDVUcV5G1j8TJPSj5ntHU/JN4RyNnI4aGew0BzkH6bCpIn2quOc1wvxQuYR5uYbWbbw5cwj3ZHhezI+Lu6oD5XtVhxpirWTxZr0iGTtdza5tcykcJ1LlPExV8jLzPaNb3v7StCbONHXh3Pw52J5ZGYJ2H6yB58zVcheaZ33rhjP/T0ADYJiRMwDe16YPN1Hqm4S0E0LpCVCucE0hKkXdIYJQ8hf92c2vCzxbMx5WsHcfrT8hebRrh7duneeSJrevmPZXPC+FNX8uyREl946kdQ1aXJ5KrWIRpp+mT+HcFBi2c7w59x488p9VdHokidrslcsG61yemhXX8jDpIlKRJykFwR/KW8pTa8TIY+Rg0F06dSS0fvVJkOLcNj+ZlidxcDryN2uJsso6XZ6po7rIn2hYfld4EVp5+QjXfB8ZY/MztrVhLHMRs7b2RYpnXEn8YYxuSwlmFjRzvGgVL4WuPv4WvPJ8XINqFxZkxjsU5x1zv8AgBU/hygcXiK9Uu24N8yZrbAyRaoSBKmUDBIhC6Qx3C2Asmb6XyIDJHfmGfcH9VqGs0mskLiBoAfILttJW3uTCwgoeCdh0Sb2lPVIlW2wmAmyaEJeTrXdKsn7QcqauJFaE/XTu5QpGOsmGZs5S5xPPYdVn8GjGNFhP51dqOPrVhpkQ366b0XTG0WY+lDXY0DQBd07qYQG8zvTScjXiG6q+uyDkLDadOSYxhvKOnptWXs7xcOFwkt7LERzy+YOd3AVDyjiHKe7A/kVXrO5W1ivc4smfDTmfFiq55Rr9IutA7CXw7FY4pzcubujWPhIEEZHxFbtrei5160FWvHBWaGxsGg0dguwRIRwSlIEBCVFKAhCFCESNul010RrSULKY0hqO6cULhYQ6CwPtPh8OhFcb3jlBat67ayPtNruk4Ykc39FyuP4K8PSFbDN4zGS/eaq7iG4a2Pe1n52byAJ3DtgWMbXfsEgDmVfWgkznEzqvNuGu7mC0E+htSyBKzdSTBcGxxRbjsXHsErh05t83db/AIVx7cZhKtQD4Wgl3zKyvtEpMt2MFRB2TKGL0JrGxsaxvQNGtKuCdk+iNlL8OKoyXLDZHRsLW8sbeZxLnBoAHr1IVeOI/Hqzz06TwK03hWG3ZBWMR5WuG+b58wS8Yf5Ef91W/wDeNUd4wyuztKb3jmt5qNsXu8bXu52QxSjo4ga+rKIvBQsxxRK4gCvjCT2Ay0f9Foqz5pIGPsxCGUjzRh/MGn5b9VhrpdfxwjmluurW27Y+OjXHiN1zeUh3XoCenoFuKdqO9Ugtwc3hTxtlZzDR04bH/a6Q6oQhcIcd7ShInBZQwCNJeiRTTqEXCxBFahmrTN5mvYQW/Nd1wsWalJr7Nyw2EfrVkWZ4nBZkwHv2Jsn64HUR9T8luvZlhZqlGfIXhqaxv+Cda4z4IsP8Wy19gj4XugcQurePeDo6/My6BroIxC7on4p4Vd3WEeUHIcfQwHrHRi59fwW6avPvZx71f4gyWdkhcyKUeG0u/v8AcvQgF3+gpPorOJqFjJYaSrTe1k7pYXNc7Xl5ZGuJ6+oAKpbWEsU7mP8Ay6xPPayr5pLQiYHRn3V7AQNco1yt7juteEvVEwGYP6OOIv3bFjI5Dwao8Ks1tRhbKJG+I8aZH027uW69Atdw9DJX4fxkMzCySOpE1zHDRaQwbCnh2kqhBEIQuEOSEIWN9DADulCaneitH9E0r8xkoMXUfYncAGjYBPdeTZG7mcxO3L5OsXVWfDWB+H9assvbm4i4j8J2zRqu8zfRzlfsaGdGjQHYBbHC4n0tkButzog4yth5YRNBBG8OGw3W+X9lS8BWx5uPq5LHRF36CR8beqpHtGFynjhpZTn8rhrpzq6tNL4Q+E6kHnjctN0pLwTc3ptaVaGrGY4I2saD2aNBSQqXhTJx5Cq0uP1zAGTA/e7BXX4pKyCixiEtQJ3omhLtDaLBpA7o2gd1XCCoQhcIckIQsJjAKu4hyLcVibFo/Yb0SIR+P6Q894Rjf9GGxN1kldzOPzWgB5u4Qhes4qyCM21/og5KD3irNEG76bb/AKk3AW5H0NP6uhPJojqhCPJdAyRwturxHkIgdNsQ87m77cq3yELNv9GKfAHRLtCEAMKlCELjICEIVSH/2Q=="
        }]
}

返回示例

正确返回示例

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

错误返回示例

{
    "ResponseMetadata": {
        "Action": "ApplyVmsTemplate",
        "Error": {
            "Code": "1007",
            "CodeN": 0,
            "Message": "模版名称重复"
        },
        "Region": "cn-north-1",
        "RequestId": "202302151413404AE263DD84671850386D",
        "Service": "volcSMS",
        "Version": "2021-01-11"
    }
}

接口说明

请求参数

Header

Query

Body

返回参数

ResponseMetadata

Result

Error

示例

请求示例

返回示例