接口地址:url/http/submitSms
说明:该地址是短信服务平台提供的服务地址,其中只需要修改url部分,采用post方法提交请求。
例如:http://sz.iveng.com/sms/http/submitSms
批理发送地址:http://sz.iveng.com/sms/http/batchSubmitSms(注意,用此批理发送地址会进入人工审核)
请求参数定义
功能 |
发送短信(发送内容相同的一条或者多条短信)。 |
输入参数说明 |
account:帐号(短信服务平台提供) password:密码(短信服务平台提供,需用MD5加密,32位,加密后字母全部为小写,例如:“123.com” 加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确) smsType:短信业务类型(短信服务平台提供) message:下行请求参数,xml格式,如下。 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MtMessage> <content>sms test</content> <phoneNumber>15001710000</phoneNumber> <phoneNumber>15001710008</phoneNumber> <phoneNumber>15001710009</phoneNumber> <sendTime>2013-05-1613:38:19</sendTime> <smsId>4acadda1-5806-4492-9a82-b7ab3f1c8ec0</smsId><subCode></subCode> <templateId></templateId> </MtMessage>
说明: content:接收短信内容 phoneNumber:接收短信手机号(可以有多个,但一次不超过1万个) sendTime:发送时间(可选) smsId: 短信标识(uuid,可选) subCode:扩展子码(可选) templateId:模板ID(可选) |
输出说明 |
xml格式,如下: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MtMessageRes> <resDetail> <phoneNumber>15001710000</phoneNumber> <stat>r:000</stat> <statDes>提交成功</statDes> </resDetail> <resDetail> <phoneNumber>15001710008</phoneNumber> <stat>r:000</stat> <statDes>提交成功</statDes> </resDetail> <resDetail> <phoneNumber>15001710009</phoneNumber> <stat>r:000</stat> <statDes>提交成功</statDes> </resDetail> <smsId>4acadda1-5806-4492-9a82-b7ab3f1c8ec0</smsId><subStat>r:000</subStat> <subStatDes>处理成功</subStatDes> </MtMessageRes>
说明: subStat:值为r:000时表示该请求被成功受理;其他值(1.1.5)则表示该请求受理失败,此时将不会出现resDetail标签。 smsId:短信标识,如果客户端请求时,填写了smsId,则该值等于请求时客户端的smsId;否则该值为短信服务平台自动生成。 |
示例1
|
执行post请求, uri: http://IP/sms/http/submitSms;params:{message=<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MtMessage><content>【群雄逐鹿2】战役活动一上线,领取新英雄!另奉助战礼包,共含5600群雄2虎符,登录背包即可打开!7天有效!请大人速来领取。</content><phoneNumber>189xxxxxxxx</phoneNumber></MtMessage>, smsType=xx, account=xx, password=f561aaf6ef0bf14d4208bb46a4ccb3ad}
|
示例2 |
执行get请求, http://IP/sms/http/submitSms?account=xx&password=f561aaf6ef0bf14d4208bb46a4ccb3ad&smsType=xx&message=<MtMessage><content>test</content><phoneNumber>189xxxxxxx</phoneNumber><templateId></templateId></MtMessage>
|
接口地址:url/http/getReply
说明:该地址是短信服务平台提供的服务地址,其中只需要修改url部分,采用post方法提交请求。例如:http://sz.iveng.com/sms/http/getReply
请求参数定义
功能 |
获取上行短信。 |
输入参数说明 |
account:帐号(短信服务平台提供) password:密码(短信服务平台提供,需用MD5加密,32位,加密后字母全部为小写,例如:“123.com” 加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确) |
输出说明 |
xml格式,如下: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MoMessageRes> <resDetail> <content>短信上行测试002</content> <phoneNumber>15000792702</phoneNumber> <subCode>1</subCode> <revTime>2013-05-16T14:26:37.561+08:00</revTime> </resDetail> <resDetail><content>短信上行测试001</content> <phoneNumber>15000792701</phoneNumber> <subCode>1</subCode> <revTime>2013-05-16T14:26:41.585+08:00</revTime> </resDetail> <resDetail><content>短信上行测试003</content> <phoneNumber>15000792703</phoneNumber> <subCode>1</subCode> <revTime>2013-05-16T14:26:31.527+08:00</revTime> </resDetail> <revStat>r:000</revStat> <revStatDes>获取上行短信条数:3</revStatDes> </MoMessageRes> |
接口地址:url/http/getReportWithTime
说明:该地址是短信服务平台提供的服务地址,其中只需要修改url部分,采用post方法提交请求。
例如: http://sz.iveng.com/sms/http/getReportWithTime
请求参数定义
功能 |
发送短信(发送内容相同的一条或者多条短信)。 |
输入参数说明 |
account:帐号(短信服务平台提供) password:密码(短信服务平台提供,需用MD5加密,32位,加密后字母全部为小写,例如:“123.com” 加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确) |
输出说明 |
xml格式,如下: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ReportMessageRes> <resDetail> <phoneNumber>15001710000</phoneNumber> <smsId>4acadda1-5806-4492-9a82-b7ab3f1c8ec0</smsId> <stat>r:000</stat> <statDes>发送成功</statDes> <revTime>2017-10-11 10:10:30</revTime> </resDetail> <resDetail> <phoneNumber>15001710009</phoneNumber> <smsId>4acadda1-5806-4492-9a82-b7ab3f1c8ec0</smsId> <stat>r:000</stat> <statDes>发送成功</statDes> <revTime>2017-10-11 10:10:30</revTime> </resDetail> <resDetail> <phoneNumber>15001710008</phoneNumber> <smsId>4acadda1-5806-4492-9a82-b7ab3f1c8ec0</smsId> <stat>r:000</stat> <statDes>发送成功</statDes> <revTime>2017-10-11 10:10:30</revTime> </resDetail> <subStat>r:000</subStat> <subStatDes>获取状态报告记录数:3</subStatDes> </ReportMessageRes> |
接口地址:url/http/getBalance
说明:该地址是短信服务平台提供的服务地址,其中只需要修改url部分,采用post方法提交请求。
例如:http://sz.iveng.com/sms/http/getBalance
请求参数定义
功能 |
查询账号余额。 |
输入参数说明 |
account:帐号(短信服务平台提供) password:密码(短信服务平台提供,需用MD5加密,32位,加密后字母全部为小写,例如:“123.com” 加密后应该是“cbff36039c3d0212b3e34c23dcde1456”可以用此例子验证加密方法是否正确) |
输出说明 |
xml格式,如下: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <BalanceRes> <revStat>r:000</revStat> <revStatDes>您的短信余额为:5970 条</revStatDes> </BalanceRes> |
见“接入常见问题”
接口地址:客户提供
方式:POST
请求参数定义
参数名称 |
描述 |
phone |
手机号 |
msgid |
消息id |
nstat |
状态。0:成功;其他:失败 |
errcode |
状态描述 |
revTime |
回执时间。格式yyyy-MM-dd HH:mm:ss |
返回值:
0:接收成功;
其他:接收失败,系统会重推3次
例子:
http://客户url?phone=138001380000&msgid=123&nstat=0&errcode=DELIVRD&revTime=2017-01-01 10:10:30
接口地址:客户提供
方式:POST
请求参数定义
参数名称 |
描述 |
phoneNumber |
手机号 |
content |
上行内容,utf8编码 |
subCode |
子号码 |
返回值:
0:接收成功;
其他:接收失败,系统会重推3次
例子:
http://客户url?phoneNumber=138001380000&content=%E4%B8%8A%E8%A1%8C&subCode=12