售前咨询
4008-753-365 , (021) 6695-7999
* 在线交谈可咨询售前、售后等问题,在您开始接入 SUBMAIL 产品时,售前顾问和售后技术支持工程师可帮助您解决遇到的任何使用问题
售前顾问咨询 09:00 - 20:00 (24x7)
购物车
在线商务咨询
咨询热线:4008 753 365 (021) 6695 7999
返回顶部

API: MMS/template

 

   概览

 

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

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

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

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

 

   URL
<备> https://api.mysubmail.com/mms/template
<备> https://api.submail.cn/mms/template
   支持格式
json
https://api.mysubmail.com/mms/template.json
默认
xml
https://api.mysubmail.com/mms/template.xml
 
   http 请求方式
GET
获取全部模板列表,或获取指定的单个模板
POST
创建一个新的彩信模板,并提交至 SUBMAIL 进行人工审核
PUT
编辑或更新一个彩信模板,并提交至 SUBMAIL 进行人工审核
DELETE
删除一个彩信模板
   MMS/template GET 方法(获取模板列表)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的彩信应用 ID

template_id

string

可选

模板ID(可选)

要获取单个模板,请将在此参数中提交该模板ID。为空则获取最新的1000个彩信模板

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   MMS/template POST 方法(创建模板)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的彩信应用 ID

mms_title

string

可选

模板标题

创建模板时可以在此参数中提交当前模板的标题,作为模板标记

mms_signature

string

必需

彩信模板签名

请使用您的公司名或应用、APP、网站名作为您的彩信签名,请将彩信签名和彩信标题的字符总和控制在64个字符以内。

mms_subject

string

必需

彩信模板标题

彩信标题通常显示在彩信的顶部,请将彩信签名和彩信标题的字符总和控制在64个字符以内。

mms_content

json

必需

彩信模板正文

彩信正文为jsonArray类型,具体参数展示参考MMS_CONTEANT参数表,以及参数示列。

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   MMS/template PUT 方法(更新模板)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的彩信应用 ID

template_id

string

必需

需要更新的模板 ID

在 SUBMAIL >MMS >项目中查看你所创建的短信项目标记。请参见 获取项目或地址薄的开发者标识

mms_title

string

可选

模板标题(可选)

创建模板时可以在此参数中提交当前模板的标题,作为模板标记

mms_signature

string

必需

短信模板签名

请使用您的公司名或应用、APP、网站名作为您的彩信签名,请将彩信签名和彩信标题的字符总和控制在64个字符以内。

mms_subject

string

必需

彩信模板标题

彩信标题通常显示在彩信的顶部,请将彩信签名和彩信标题的字符总和控制在64个字符以内。

mms_content

json

必需

彩信模板正文

彩信正文为jsonArray类型,具体参数展示参考MMS_CONTEANT参数表,以及参数示列。

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   MMS/template DELETE 方法(删除模板)请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短信应用 ID

template_id

string

必需

需要删除的模板 ID

在 SUBMAIL >MMS >项目中查看你所创建的短信项目标记。请参见 获取项目或地址薄的开发者标识

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   MMS_CONTENT参数
参数
类型
必需/可选
默认
描述

text

string

可选

文字内容。

jsonArray数组中text参数与媒体(image或者audio)文件参数不能同时为空。

image

json

可选

彩信图片

image参数为json类型还包含image.data ,image.type两个参数。具体数据格式参考代码示列。

image.data

base64

携带图片时必需

图片BASE64数据。

单页上传的图片需要通过文件流进行base64编码处理成string类型

image.type

string

携带图片时必须

图片类型。

 支持类型 image/jpg, image/jpeg, image/png, image/gif

audio

json

可选

音频文件。

audio参数为json类型还包含audio.data ,audio.type两个参数。具体数据格式参考代码示列。

audio.data

base64

携带音频时必需

音频BASE64数据。

audio参数为json类型还包含audio.data ,audio.type两个参数。具体数据格式参考代码示列。

audio.type

string

携带音频时必需

音频类型。

 支持类型 audio/mp3, audio/wav, audio/midi

注意:

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

  

   MMS_CONTENT参数JSON数据示列