API: MMS/Template - 彩信模板管理

概覽

MMS/template 是 SUBMAIL 的彩信模板 API。

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

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

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

URL

<主> https://api-v4.mysubmail.com/mms/template

支持格式

http 請求方式

是否需要授權(quán)

是

參閱 API 授權(quán)和驗證機(jī)制

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

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

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

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

MMS_CONTENT參數(shù)

注意：

1. mms_content 為json數(shù)組類型。
2. 彩信模板最大支持9頁，mms_content參數(shù)中每一組數(shù)據(jù)為一頁，并且依次排序。
3. 彩信模板每一頁必須至少包含一種類型數(shù)據(jù)，媒體文件或者文字。
4. 單模板僅支持一種媒體類型，圖片或音頻，即圖片+文字，或音頻+文字，并將彩信標(biāo)題+簽名+媒體文件+正文文字的大小總和控制在 2 MB 以內(nèi)，支持 mp4, 3gp 格式，超過 2MB 的視頻將被壓縮到 2MB，最大可上傳 20MB 的視頻文件 。
5. 媒體文件中的數(shù)據(jù)必須是 base64 編碼，并通過 type 參數(shù)正確的說明文件類型。
6. 單個圖片或音頻文件的大小應(yīng)控制在 2MB 以內(nèi)。

MMS_CONTENT參數(shù)JSON數(shù)據(jù)示列

圖片+文字

[
    {
        "image":{
            "data":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr………………", 
            "type":"image/jpeg"
        },
        "text":"test-image"
    }
]

視頻+文字

[
    {
        "video":{
            "data":"/9j/4QAYRXhpZgAASUkqAAgBBBBBBBBBBP/sABFEdWNr………………",
            "type":"video/mp4"
        },
        "text":"test-video"
    }
]

音頻+文字

[
    {
        "audio":{
            "data":"/9j/4QAYRXhpZgAASUkqAAgBBBBBBBBBBP/sABFEdWNr………………",
            "type":"audio/wav"
        },
        "text":"test-audio"
    }
]

圖片+文字：多頁

[
    {
        "image":{
            "data":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr………………", 
            "type":"image/jpeg"
        },
        "text":"text1"
    },{
        "image":{
            "data":"/9j/4QAYRXhpZgAASUkqBBBBBBBBBBBBBBBBBBBP/sABFEdWNr………………", 
            "type":"image/jpeg"
        },
        "text":"text2"
    },{
        "image":{
            "data":"/9j/4QAYRXhpZgAASUkqAAgCCCCCCCCCCCCCCCP/sABFEdWNr………………", 
            "type":"image/jpeg"
        },
        "text":"text3"
    }
] 

代碼示例

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

發(fā)送 CURL

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

返回

{
"status": "success",
"template": {
    "template_id": "FIJe14",
    "mms_title": "賬戶更改郵箱驗證碼",
    "mms_signature": "【SUBMAIL】",
    "mms_content": [
    {
        "image":{                           
                     "url":"https://xxxxxxxxxxx/xxxl32d5a1.png", 
                      "type":"image/png"
                      },
       "text":"您的驗證碼是1234."
    }
                             ]
    "mms_subject":"郵箱更改通知",
    "create_at": "2016-01-08 21:28:04",
    "edit_at": "2016-01-08 21:28:04",
    "template_status": "2",
    "template_status_description": "通過審核",   //SUBMAIL審核通過
     "cm_status": "審核通過",              //中國移動運營商審核狀態(tài)   審核通過/審核駁回
     "cu_status": "審核通過",                //中國聯(lián)通運營商審核狀態(tài)
     "ct_status": "審核通過"                //中國電信運營商審核狀態(tài)
    }
}

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

發(fā)送 CURL

curl -d 'appid=your_appid&signature=your_appkey&mms_title=POST方法測試&mms_signature=【SUBMAIL】&mms_subject=post標(biāo)題提交測試&mms_content=[
    {
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr…", 
                        "type":"image/jpeg"
                      },
       "text":"text1"
    },{
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqAAgBBBBBBBBBBBBBBBAP/sABFEdWNr…", 
                        "type":"image/jpeg"
                      },
        "text":"text2"
    },{
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqCCCCCCCCCCCCCCCCCC/sABFEdWNr…", 
                        "type":"image/jpeg"
                     },
       "text":"text3"
    }
]
 ' http://api-v4.mysubmail.com/mms/template.json

返回

{
    "status": "success",
    "template_id": "FsoAF3"    // API 返回的模板ID，作為請求 API 的 PROJECT 參數(shù)
}

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

發(fā)送 CURL

curl --data 'appid=your_appid&signature=your_appkey&mms_title=POST方法測試&mms_signature=【SUBMAIL】&mms_subject=post標(biāo)題提交測試&mms_content=[
    {
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNr…", 
                        "type":"image/jpeg"
                      },
        "text":"text1"
    },{
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqAAgABBBBBBBBBBBBAP/sABFEdWNr…", 
                        "type":"image/jpeg"
                       },
        "text":"text2"
    },{
        "image":{
                        "data":"/9j/4QAYRXhpZgAASUkqAAgCCCCCCCCCCCCP/sABFEdWNr…", 
                        "type":"image/jpeg"
                      },
       "text":"text3"
    }
]'
   http://api-v4.mysubmail.com/mms/template.json

返回

{
    "status":"success"
}

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

發(fā)送 CURL

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

返回

{
    "status":"success"
}

template_status 模板狀態(tài)描述

返回值

請求成功

{
    "status":"success"
}

請求失敗

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

錯誤代碼

參閱 API 錯誤代碼