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

API: Message/template

 

   概览

 

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

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

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

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

 

   URL
<主> https://api.mysubmail.com/message/template
<备> https://api.submail.cn/message/template
   支持格式
json
https://api.mysubmail.com/message/template.json
默认
xml
https://api.mysubmail.com/message/template.xml
 
   http 请求方式
GET
获取全部模板列表,或获取指定的单个模板
POST
创建一个新的短信模板,并提交至 SUBMAIL 进行人工审核
PUT
编辑或更新一个短信模板,并提交至 SUBMAIL 进行人工审核
DELETE
删除一个短信模板
   Message/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 授权与验证机制  >  授权和验证方式

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

appid

string

必需

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

sms_title

string

可选

模板标题(可选)

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

sms_signature

string

必需

短信模板签名

请使用您的公司名或应用、APP、网站名作为您的短信签名,请将签名字数控制在2-10个字符以内,并使用全角大括号“【”和“】”包括,如:“【SUBMAIL】”

sms_content

string

必需

短信模板正文

提交短信模板正文,请将模板正文字数控制在256个字符以内。可使用文本变量 参阅 了解如何创建和使用文本变量

timestamp

UNIX 时间戳

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

sign_type

string

可选

normal

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

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

signature

string

必需

应用密匙 或 数字签名

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

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

appid

string

必需

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

template_id

string

必需

需要更新的模板 ID

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

sms_title

string

可选

模板标题(可选)

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

sms_signature

string

必需

短信模板签名

请使用您的公司名或应用、APP、网站名作为您的短信签名,请将签名字数控制在2-10个字符以内,并使用全角大括号“【”和“】”包括,如:“【SUBMAIL】”

sms_content

string

必需

短信模板正文

提交短信模板正文,请将模板正文字数控制在256个字符以内。可使用文本变量 参阅 了解如何创建和使用文本变量

timestamp

UNIX 时间戳

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

sign_type

string

可选

normal

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

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

signature

string

必需

应用密匙 或 数字签名

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

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

appid

string

必需

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

template_id

string

必需

需要删除的模板 ID

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

timestamp

UNIX 时间戳

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

sign_type

string

可选

normal

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

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

signature

string

必需

应用密匙 或 数字签名

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

   代码示例

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


 

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


 

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


 

 


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


 

 

    template_status 模板状态描述
template_status : 0
未提交审核
template_status : 1
正在审核
template_status : 2
审核通过
template_status : 3
未通过审核

 

   返回码