API: SMS/Template - 短信模板管理

概览

sms/template 是 SUBMAIL 的短信模板 API。

使用 sms/template 可以获取、创建、编辑或删除您的短信模板。

sms/template API 使用 HTTP 规范中的 GET, POST, PUT, DELETE 方法对模板进行操作，使用 GET 方法获取单个或全部模板、POST 方法创建新的短信模板并提交至 SUBMAIL 人工审核、PUT 方法更新或编辑一个短信模板，或使用 DELETE 方法删除一个模板。

短信模板引擎支持 SUBHOOK 异步推送状态，短信模板在后台人工审核后，会使用 SUBHOOK 进行主动推送状态。

URL

https://api-v4.mysubmail.com/sms/template

支持格式

http 请求方式

• GET 获取全部模板列表，或获取指定的单个模板
• POST 创建一个新的短信模板，并提交至 SUBMAIL 进行人工审核
• PUT 编辑或更新一个短信模板，并提交至 SUBMAIL 进行人工审核
• DELETE 删除一个短信模板

是否需要授权

是

参阅 API 授权和验证机制

sms/template GET 方法（获取模板列表）请求参数

sms/template POST 方法（创建模板）请求参数

sms/template PUT 方法（更新模板）请求参数

sms/template DELETE 方法（删除模板）请求参数

代码示列

使用 CURL GET方法获取模板列表

发送 CURL

curl -s "https://api-v4.mysubmail.com/sms/template.json?appid=your_appid&signature=your_appkey"

返回

{
    "status": "success",
    "start_row": 1,
    "end_row": 50,
    "templates": [
        {
            "template_id": "uMnmq2",
            "sms_title": "",
            "sms_signature": "【SUBMAIL】",
            "sms_content": "测试模板 驳回",
            "add_date": 1654470015,
            "edit_date": 1654470015,
            "template_status": "3",
            "template_status_description": "未通过审核",
            "template_reject_reson": "您好，您的短信无法通过审核，请联系您的专属客服解决！"
        },
        {
            "template_id": "EJfYNv",
            "sms_title": "",
            "sms_signature": "【SUBMAIL】",
            "sms_content": "测试模板 通过",
            "add_date": 1654470008,
            "edit_date": 1654470008,
            "template_status": "2",
            "template_status_description": "通过审核"
        }

         ]
}

使用 CURL POST方法提交短信模板

发送 CURL

curl -d "appid=your_appid&signature=your_appkey&sms_title=POST方法测试&sms_signature=【SUBMAIL】&sms_content=您的验证码是：@var(code)，请在10分钟内输入。" http://api.mysubmail.com/sms/template.json

返回

{
    "status": "success",
    "template_id": "FsoAF3"    // API 返回的模板ID，作为请求 API 的 PROJECT 参数
}

使用 CURL PUT 方法修改短信模板

发送 CURL

curl --data "appid=your_appid&signature=your_appkey&template_id=FsoAF3&sms_title=PUT方法更新模板测试&sms_signature=【SUBMAIL】&sms_content=您的验证码是：@var(code)，请在30分钟内输入。" -X put http://api.mysubmail.com/sms/template.json

返回

{
    "status":"success"
}

使用 CURL DELETE 方法删除短信模板

发送 CURL

curl --data "appid=your_appid&signature=your_appkey&template_id=FsoAF3" -X delete http://api.mysubmail.com/sms/template.json

返回

{
    "status":"success"
}

template_status 模板状态描述

返回值

请求成功

{
    "status":"success"
}

请求失败

{
    "status":"error",
    "code":"1xx",
    "msg":"error sms"
}

错误代码

参阅 API 错误代码