产品与服务

测试时，请使用正式内容进行测试，请勿给同一手机号连续发送相同内容，运营商已进行规则调整以应对短信炸弹问题。

接口说明：客户接口部分提供http url方式的接口，根据客户需求可以提供相应接口，接口编码方式采用统一的UTF-8

第一章 发送接口

1.1 请求地址

请求地址是客户接口程序调用时请求的url地址，采用的是http post 接口，地址是

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

接口通用信息

1.2参数说明

http://*.*.*/sms.aspx

http://*.*.*/smsGBK.aspx

示例

action=send&userid=12&account=账号&password=密码&mobile=13800000000 &content=内容&sendTime=&extno=

1.3返回值

在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。格式为：

<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<returnstatus>status</returnstatus> ---------- 返回状态值：成功返回Success 失败返回：Faild
<message>message</message> ---------- 返回信息：见下表
<remainpoint> remainpoint</remainpoint> ---------- 返回余额
<taskID>taskID</taskID>  -----------  返回本次任务的序列ID
<successCounts>successCounts</successCounts> --成功短信数：当成功后返回提交成功短信数
</returnsms>

第二章 余额及已发送量查询接口

2.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

http://*.*.*/sms.aspx
http://*.*.*/smsGBK.aspx

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

2.2参数说明

http://*.*.*/sms.aspxaction=overage&userid=12&account=账号&password=密码

<?xml version="1.0" encoding="utf-8" ?> 
<returnsms> 
<returnstatus>status</returnstatus>-------返回状态值：成功返回Sucess 失败返回：Faild 
<message>message</message>--------------返回信息提示：见下表 
<payinfo>payinfo</payinfo>--------------返回支付方式  后付费，预付费 
<overage>overage</overage>-------------返回余额 
<sendTotal>sendTotal</sendTotal>----返回总点数  当支付方式为预付费是返回总充值点数 
</returnsms>

返回信息提示	说明
返回空	查询成功 将返回相应的支付方式、账户使用条数、总充值点数
用户名或密码不能为空	提交的用户名或密码为空
用户名或密码错误	表示用户名或密码错误

第三章 非法关键词查询

3.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

http://*.*.*/sms.aspx 
http://*.*.*/smsGBK.aspx

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

3.2参数说明

例如：

action=checkkeyword&userid=12&account=账号&password=密码&content=内容

3.3返回值

 <?xml version="1.0" encoding="utf-8" ?>
  <returnsms>
  <message>message</message>--------------返回信息提示：见下表
  </returnsms>
  

第四章 状态报告接口

4.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

http://*.*.*/statusApi.aspx

 <?xml version="1.0" encoding="utf-8" ?>
  <returnsms>
  <message>message</message>--------------返回信息提示：见下表
  </returnsms>
  

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

4.2参数说明

例如：

action=query&userid=12&account=账号&password=密码 

4.3返回值

<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<statusbox>
<mobile>1380000000</mobile>-------------对应的手机号码
<taskid>1212</taskid>-------------同一批任务ID
<status>10</status>---------状态报告----10：发送成功，20：发送失败 
<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间 
<errorcode>DELIVRD</errorcode>-上级网关返回值，不同网关返回值不同，仅作为参考
</statusbox> 
<statusbox> 
<mobile>1380000000</mobile> 
<taskid>1212</taskid> 
<status>20</status>
<receivetime>2011-12-02 22:12:11</receivetime>
<errorcode>2</errorcode>
</statusbox>
</returnsms>

4.4错误返回值——状态报告请求错误返回格式及对应值

<?xml version="1.0" encoding="utf-8" ?> 
<returnsms> 
<errorstatus> 
<error>1</error>-------------错误码 
<remark>用户名或密码不能为空</remark>-------------错误描述 
</errorstatus> 
</returnsms> 

1：用户名或密码不能为空

2：用户名或密码错误

3：该用户不允许查看状态报告

4：参数不正确

第五章 上行接口

5.1 请求地址

请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是

http://*.*.*/callApi.aspx

入口地址一般不会发生变化，当发生变化的时候，会通知接口用户

5.2参数说明

例如：

action=query&userid=12&account=账号&password=密码

5.3返回值

<?xml version="1.0" encoding="utf-8" ?>
<returnsms>
<callbox>
<mobile>13800000000</mobile>-------------对应的手机号码
<taskid>1212</taskid>-------------同一批任务ID
<content>你好，我不需要</content>---------上行内容
<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间 
</callbox>
<callbox>
<mobile>13800000000</mobile>
<taskid>1212</taskid>
<content>你好，本次活动路线是怎么的</content>
<receivetime>2011-12-02 22:12:11</receivetime>
</callbox>
</returnsms>

5.4错误返回值——回复请求错误返回格式及对应值

<?xml version="1.0" encoding="utf-8" ?>
<returnsms> 
<errorstatus> 
<error>1</error>-------------错误码
<remark>用户名或密码不能为空</remark>-------------错误描述
</errorstatus>
</returnsms>

1：用户名或密码不能为空

2：用户名或密码错误

3：该用户不允许查看状态报告

4：参数不正确

彩信接口

1. 概述

2.接口定义

2.1.彩信下发接口

接口定义：实时彩信下发接口。
接口提交：http://*.*.*/sendmms.aspx
接口参数：

完整彩信下行中POSTDATA例子：

action=send&userid=12&account=zhouyang&password=123456&mobile=138********,135********&title= 
adadadaadad&starttime=&content=3,txt|zsSxvg==,jpg|4AAQSkZJRgABAgAAZABk; 
3,gif|ExghIhcXGRcXIiQdIB8fIB0kJCssLywrJDk5Pj45OUFBQ

说明：
1：目前的资源类型只支持：文本(txt)，GIF图片(gif)，JPG图片(jpg)
2：彩信标题（title）加上base64解码后彩信内容（content）总长度不能超过45K

状态码：
状态，消息唯一编号：处理成功后，返回的这次发送结果和这个消息的唯一标识。
（例子：100:27349872349823）
失败后只返回错误码
0：参数不对
1：用户名或密码不能为空
2：用户名或密码错误
3：号码为空
4：内容为空
5：单次提交号码不能超过2000个
6：余额不足
7：提交任务失败
8：其他错误
9：彩信文件大于100K
10:该用户不支持彩信