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

概覽

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

使用 sms/template 可以獲取、創(chuàng)建、編輯或刪除您的短信模板。

sms/template API 使用 HTTP 規(guī)范中的 GET, POST, PUT, DELETE 方法對模板進行操作，使用 GET 方法獲取單個或全部模板、POST 方法創(chuàng)建新的短信模板并提交至 SUBMAIL 人工審核、PUT 方法更新或編輯一個短信模板，或使用 DELETE 方法刪除一個模板。

短信模板引擎支持 SUBHOOK 異步推送狀態(tài)，短信模板在后臺人工審核后，會使用 SUBHOOK 進行主動推送狀態(tài)。

URL

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

支持格式

http 請求方式

• GET 獲取全部模板列表，或獲取指定的單個模板
• POST 創(chuàng)建一個新的短信模板，并提交至 SUBMAIL 進行人工審核
• PUT 編輯或更新一個短信模板，并提交至 SUBMAIL 進行人工審核
• DELETE 刪除一個短信模板

是否需要授權

是

參閱 API 授權和驗證機制

sms/template GET 方法（獲取模板列表）請求參數(shù)

sms/template POST 方法（創(chuàng)建模板）請求參數(shù)

sms/template PUT 方法（更新模板）請求參數(shù)

sms/template DELETE 方法（刪除模板）請求參數(shù)

代碼示列

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

發(fā)送 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": "您好，您的短信無法通過審核，請聯(lián)系您的專屬客服解決！"
        },
        {
            "template_id": "EJfYNv",
            "sms_title": "",
            "sms_signature": "【SUBMAIL】",
            "sms_content": "測試模板 通過",
            "add_date": 1654470008,
            "edit_date": 1654470008,
            "template_status": "2",
            "template_status_description": "通過審核"
        }

         ]
}

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

發(fā)送 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 參數(shù)
}

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

發(fā)送 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 方法刪除短信模板

發(fā)送 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 模板狀態(tài)描述

返回值

請求成功

{
    "status":"success"
}

請求失敗

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

錯誤代碼

參閱 API 錯誤代碼