提交模板
提交方式:httppost
提交地址:
参数格式:jsonBody=JSON字符串
参数描述:
序号
参数
说明
1
userName
必填参数。用户名
2
password
必填参数。MD5(username +MD5(API用户密码)),采用32位小写MD5
3
templateName
必填参数。模板名称
4
title
必填参数。标题
5
sign
必填参数。签名
6
templateType
选填参数。默认0,0-静态模板,1-变量模板
7
content
必填参数。模板内容格式:JSON,变量则用 #p_1#,#p_2#, #p_3#, …,#p_10# 占位。 最多支持 10 个变量,文字变量在使用时有长度限制: 纯中文变量 不超过 10 个字,数字 字母 英文符号 不超过 20 位”
,详见附录1
注:内容为base64加密,提交时使用URLEncode对json字符串做utf-8编码
返回格式:JSON字符串
参数名
类型
说明
statusCode
Integer
返回码:请求成功为1;请求失败为0
statusDesc
String
错误信息描述
templateId
String
模板ID, 提交失败不返回
模板信息查询
可以按照查询条件查询已提交的模板信息。
提交方式:httppost
提交地址:
参数格式:jsonBody= JSON字符串
参数描述:
序号
参数
说明
1
userName
必填参数。用户名
2
password
必填参数。MD5(username +MD5(API用户密码)),采用32位小写MD5
3
templateName
选填参数。模板名称
4
templateId
选填参数。模板编号
注:提交时使用URLEncode对json字符串做utf-8编码
返回格式:JSON字符串
参数名
类型
说明
statusCode
Integer
返回码:请求成功为1;请求失败为0
statusDesc
String
错误信息描述
templates
String
模板信息json数组,失败不返回,成功返回包括templateName,templateId,templateParams,status四个字段(status=0未审核,status=1审核通过,status=2审核拒绝)
返回实例:{"statusCode":1,"statusDesc":"查询成功","templates":[{"templateName":"视频短信测试","templateId":"1105373307900843008",“templateParams”:“”,"status":0}]}
模板审核结果推送
平台将客户提交的模板审核状态按照客户提供的服务地址推送给客户。
推送方式:http post
推送格式:checkreport=JSON字符串。
内容参数:
参数名
类型
说明
statusCode
Integer
返回码:statusCode=1审核通过,statusCode=2审核拒绝
statusDesc
String
状态描述
templateId
String
模板ID
示列:
checkreport={ "statusCode" : 1, "statusDesc" :"审核成功", "templateId" : "20150602103851791397"}
按模板提交信息
提交方式:httppost
提交地址:
参数格式:jsonBody=JSON字符串。
参数描述:
序号
参数
说明
1
userName
必填参数。用户名
2
password
必填参数。MD5(username +MD5(API用户密码)),采用32位小写MD5
3
mobile
必填参数。合法的手机号码
备注说明:多个号码间用英文逗号分隔,如果发送变量模板,变量部分号码格式为:mobile##变量1$$变量2$$变量3…$$变量10,变量提交顺序需要与变量模板中变量顺序一致。
一次发送不能超过500个手机号码
多个发送号码不能重复
4
templateId
必填参数。模板ID
5
ext
选填参数,扩展码,用户定义扩展码,长度需后台设置
6
msgid
选填参数,用户自定义msgid,不为空时,查询或推送状态报告中的msgid参数用此msgid,为空时,用平台侧生成msgid,及提交相应中msgid
返回参数为JSON字符串
参数名
类型
说明
statusCode
Integer
返回码:请求成功为1;请求失败为0
statusDesc
String
提示信息
msgid
String
与提交中msgid一致原样返回,提交为空时,由平台测产生msgid
示例
失败 {"statusDesc":"用户名或密码错误","statusCode":0}成功 {"statusDesc":"提交成功","statusCode":1," msgid":"30201605302153192"}
状态报告推送
推送方式:http post
推送格式:report=JSON字符串。
内容参数:
参数名
类型
说明
statusCode
Integer
返回码:请求成功为1;请求失败为0
statusDesc
String
状态描述
msgid
String
与提交中msgid一致原样返回,提交为空时,由平台测产生msgid
mobile
String
手机号码
statusTime
Long
状态报告时间戳
示例:
report=[{ "statusCode" : 1, "statusDesc" :"发送成功", "msgid" : "20150602103851791397", "userNumber" :"13812345678", "statusTime":1515440340651},
{ "statusCode" : 0, "statusDesc" :"发送失败", "msgid" : "20150602103851791397", "userNumber" :"13912345678", "statusTime":1515440340651}]
附录1模板内容
彩信模板参数content字段JSON格式:
示例:
"frames":[
{
{
"content":"2wBDAAcEBAQFBAcFBQcKBwUHCgwJBwcJDA0LCw",
"type":"video/mp4"
},
{
"content":"/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAcEBAQFBAcFBQcKBwUHCgwJBwcJDA0LCw",
"type":"image/jpg"
},
{
"content":"hello world",
"type":"text/plain"
}
}
]
内容为标准json格式字符串 以下是对单个字段含义解释。
frames为彩信帧数 一帧可以包含文本text或图片img或音频video中的一种元素内容
content为每帧元素的内容 所有内容均需使用base64编码后传输(包括纯文本)
type为内容类型 取值范围:
值
描述
text/plain
纯文本
image/jpg
jpg/jpeg图片
video/mp4
视频