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

概览

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

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

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

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

URL

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

支持格式

http 请求方式

是否需要授权

是

参阅 API 授权和验证机制

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

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

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

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

MMS_CONTENT参数

注意：

1. mms_content 为json数组类型。
2. 彩信模板最大支持9页，mms_content参数中每一组数据为一页，并且依次排序。
3. 彩信模板每一页必须至少包含一种类型数据，媒体文件或者文字。
4. 单模板仅支持一种媒体类型，图片或音频，即图片+文字，或音频+文字，并将彩信标题+签名+媒体文件+正文文字的大小总和控制在 2 MB 以内，支持 mp4, 3gp 格式，超过 2MB 的视频将被压缩到 2MB，最大可上传 20MB 的视频文件 。
5. 媒体文件中的数据必须是 base64 编码，并通过 type 参数正确的说明文件类型。
6. 单个图片或音频文件的大小应控制在 2MB 以内。

MMS_CONTENT参数JSON数据示列

图片+文字

[
    {
        "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方法获取模板列表

发送 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审核通过
    "template_reject_reason": "您的短信模板包含强制屏蔽词或敏感内容，请重新修改后提交",   //模板未通过原因
     "cm_status": "审核通过",              //中国移动运营商审核状态   审核通过/审核驳回
     "cu_status": "审核通过",                //中国联通运营商审核状态
     "ct_status": "审核通过"                //中国电信运营商审核状态
    }
}

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

发送 CURL

curl -d 'appid=your_appid&signature=your_appkey&mms_title=POST方法测试&mms_signature=【SUBMAIL】&mms_subject=post标题提交测试&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 参数
}

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

发送 CURL

curl --data 'appid=your_appid&signature=your_appkey&mms_title=POST方法测试&mms_signature=【SUBMAIL】&mms_subject=post标题提交测试&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 方法删除短信模板

发送 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 模板状态描述

返回值

请求成功

{
    "status":"success"
}

请求失败

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

错误代码

参阅 API 错误代码