更新时间:2020-05-22 17:18:29 浏览量: 作者:admin 来源:浙江蔚蓝信息



短信验证码、通知- API文档

短信验证码、短信通知API文档下载:点击下载  

1.接口说明:

用户在遵循HTTP协议的前提下,可通过GET和POST方式提交短信发送请求

post请求地址使用UTF-8编码,建议使用UTF-8格式编码进行提交

http://47.104.16.186:8888/sms.aspx --使用UTF-8编码格式
post请求地址使用GBK编码格式
http://47.104.16.186:8888/smsgbk.aspx--使用GBK编码格式

 

2. POST方式提交短信请求到短信平台

 

http://47.104.16.186:8888/sms.aspx?action=send(注意:在调用接口时使用x-www-form-urlencoded 编码格式)

 

提交参数说明:
序号 请求参数 请求参数说明
1 userid 发送用户ID
2 account 发送用户帐号
3 password 发送帐号密码
4 mobile 发送的手机号码
5 content 发送的短信内容
6 sendTime 定时发送短信的时间
7 action 发送任务命令 发送时为:send
8 checkcontent 是否检查内容包含非法关键字,当设置为1的时表示要检查,0表示不用检查
9 taskName 任务名称 100字以内,可以为空
10 countnumber 本次提交号码的总数
10 mobilenumber 本次提交的手机号码数量
11 telephonenumber 本次提交的小灵通或座机号码数数量(如果没有可以不填)

 

发送短信提交示例:

网址?action=send&userid=企业ID&account=账号&password=密码&mobile=15023239810&content=内容&sendTime=&taskName=任务描述
&checkcontent=1&mobilenumber=10&countnumber=12&telephonenumber=1

当成功提交短信之后服务器返回特定格式的xml,其结构如下:

<?xml version="1.0" encoding="UTF-8"?>
 <returnsms>
 <returnstatus>Success</returnstatus>
 <message>ok</message >
 <remainpoint>3</remainpoint>
 <taskID>13</taskID>
 <successCounts>2</successCounts>
 </returnsms>
Response返回结果结构描述:
序号 响应参数 响应参数描述
1 returnstatus 状态返回码-success表示成功 -Faild表示失败
2 message 返回信息描述
3 remainpoint 剩余余额
4 taskID 返回本次任务的序列号ID
5 successCounts 提交成功数:当提交成功后返回提交成功短信数
message状态码(返回信息)描述:
message(返回内容描述) 内容描述
ok 提交成功
用户名或密码不能为空 用户名或密码不能为空
发送内容包含sql注入字符 包含SQL注入字符
用户名或密码错误 表示用户名或密码错误 表示用户名或密码错误
短信号码不能为空 提交的被叫号码为空
短信内容不能为空,发送内容为空 发送内容为空
包含非法字符: 表示检查到不允许发送的非法字符
对不起,您当前要发送的量大于您当前余额 当支付方式为预付费是,检查到账户余额不足
其他错误 因运营商规则变化,如有返回值在上述表格中找不到,请咨询您的专属客服

3.帐户余额查询:

账户查询请求地址:

http://47.104.16.186:8888/sms.aspx?action=overage --使用UTF-8编码格式
账户查询请求地址:
http://47.104.16.186:8888/smsgbk.aspx?action=overage --使用GBK编码格式

 

参数说明:
序号 请求参数 请求参数描述
1 userid 发送用户ID
2 account 用户帐号
3 password 账号密码
4 action 任务名称
查询余额提交示例:
http://47.104.16.186:8888/sms.aspx?action=overage&userid=12&account=账号&password=密码

当提交余额查询请求之后服务器返回特定格式的xml,其结构如下:

<?xml version="1.0" encoding="utf-8" ?/>
  <returnsms>   <returnstatus> status </returnstatus>
  <message> message </message >
  <payinfo> payinfo </payinfo>
  <overage> overage </overage>
  <sendTotal> sendTotal </sendTotal >
</returnsms>

查询完成之后返回xml参数说明:
序号 响应参数 响应参数描述
1 returnstatus 返回状态值:成功返回Success 失败返回:Faild
2 message 返回信息描述
3 payinfo 返回支付方式 后付费,预付费
4 overage 返回已发送条数
4 sendTotal 返回总点数 当支付方式为预付费是返回总充值点数
message参数(返回代码)值说明:
序号 message参数(返回内容描述) 内容描述
1 返回空 查询成功将返回相应的支付方式、账户使用条数、总充值点数
2 用户名或密码不能为空 提交的用户名或密码为空
3 用户名或密码错误 表示用户名或密码错误

4.状态报告查询:

短信状态报告请求地址:

http://47.104.16.186:8888/statusApi.aspx

 

参数说明:
序号 请求参数 参数描述
1 userid 发送用户ID
2 account 用户帐号
3 password 账号密码
4 action 任务名称
状态提交示例:
http://47.104.16.186:8888/statusApi.aspx?action=query&userid=12&account=账号&password=密码

当提交状态报告到服务器后返回特定格式的xml,其结构如下:

<?xml version="1.0" encoding="utf-8" ?>
 <returnsms>
 <status>
  <mid> 121212121212 </mid>
  <mobile> 15023239810 </mobile >
  <status> 10 </status>
  <taskid> 1212 </taskid>
  <createtime > 2011-12-02 22:12:11 </createtime >
  </status>
  <status>
  <mid>121212121212</mid>
  <mobile> 15023239810 </mobile >
  <status> 10 </status>
  <taskid> 1212 </taskid>
  <createtime > 2011-12-02 22:12:11 </createtime >
  </status>
< /returnsms>

返回xml参数说明:
序号 响应参数 响应参数描述
1 mid 系统里面对应的唯一的mid
2 mobile 对应的手机号码
3 status 10表示发送成功,20表示发送失败
4 createtime 发送时间
4 sendTotal 返回总点数 当支付方式为预付费是返回总充值点数
message参数(返回代码)值说明:
序号 message(参数内容) 参数描述
1 返回空 查询成功将返回相应的支付方式、账户使用条数、总充值点数
2 用户名或密码不能为空 提交的用户名或密码为空
3 用户名或密码错误 表示用户名或密码错误

5.上行(客户回复)状态报告查询:
 

 

短信回复查询地址:
http://47.104.16.186:8888/callApi.aspx
 

 

 
参数说明:
序号 请求参数 请求参数描述
1 userid 发送用户ID
2 account 用户帐号
3 password 账号密码
4 action 任务名称
短信回复提交示例:
http://47.104.16.186:8888/callApi.aspx?action=query&userid=12&account=账号&password=密码 

当提交请求之后服务器返回特定格式的xml,其结构如下:

<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<callbox>
<mobile>13390893212</mobile>-------------对应的手机号码
<taskid>1212</taskid>-------------同一批任务ID
<content>你好,我不需要</content>---------上行内容
<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间
<extno>01</extno>----子号,即自定义扩展号
</callbox>
</returnsms>

 

返回xml参数说明:
序号 响应参数 参数描述
1     mobile     客户回复的手机号码
2     taskid 对应的任务ID
3 content 客户回复的短信内容
4 receivetime 客户回复时间
4 extno 扩展号码
message(返回代码)值说明:
序号 响应参数值 参数值描述
1 返回空 查询成功将返回相应的支付方式、账户使用条数、总充值点数
2 用户名或密码不能为空 提交的用户名或密码为空
3 用户名或密码错误 表示用户名或密码错误

6.密码修改:

密码修改地址:
http://47.104.16.186:8888/sms.aspx
参数说明:
序号 请求参数 请求参数描述
1 userid 发送用户ID
2 account 用户帐号
3 password 账号密码
4 action 任务名称
5 newpwd 新的密码
6 renewpwd 重复新的密码

修改密码提交示例:
http://47.104.16.186:8888/sms.aspx?action= changespwd&userid=12&account=账号&password=密码&newpwd=新密码&renewpwd=新密码

提交返回值:
当提交请求之后服务器返回特定格式的xml,其结构如下:
 

<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus>-------返回状态值:成功返回Success失败返回:Faild
<message>message</message>--------------返回信息提示:见下表
< checkCounts > </ checkCounts >--------------预留字段
</returnsms>

 

返回xml参数说明:
 

 

序号 响应参数 参数描述
1     returnstatus     返回状态值,返回success表示成功,返回Faild表示失败
2     message 返回状态描述值
3 checkCounts 预留字符可不管
     
message(返回代码)值说明:
 
序号 响应参数值 参数值描述
1 密码修改成功  密码修改成功
2 用户名或密码不能为空 提交的用户名或密码为空
3 用户名或密码错误 表示用户名或密码错误


 


如有遇到问题可联系专属客服及技术进行解答:电话:18958365276、qq:2010456530 、470219410、 微信:18958365276