一纬短信平台开发接口规范3.doc

短信平台接口规范 电：4006761898纬短信平台接口规范 版本 4.0 上海一纬信息技术有限公司编写:(签名) 年 月 日复查:(签名) 年 月 日批准:(签名) 年 月 日修改记录版本号日期备注修订人1.02009.32.02010.63.02010.12antony4.02011.5增加GET方式antony目录1.概述32.接口定义32.1获取基本信息32.2发送短信POST方式42.3修改密码42.4接收信息52.5 接收短信投票52.6 接收互动留言/投票62.7 GET方式发送短信73.服务器返回信息说明74.常见问题问答84.常见接口DEMO94.1 PHP接口（短信群发类）94.2 PHP语言-互动留言DEMO104.3 ASP语言-短信投票111. 概述上海一纬为客户提供短信平台开发接口(SDK开发包)。接入客户可根据自身需求进行二次开发，可与自己的传统业务相连接，开发出具有自己特色的短信平台。 如用于SMS、OA、CRM、SCM等各种软件行业应用系统，为传统软件加入移动商务应用功能。 平台优势： 1、全面支持中国移动、中国联通、中国电信短信业务平台，适应多种通讯方式及通讯网络，实现覆盖全国手机用户。 2、标准化开发包。支持多种主流开发语言、多种运行环境 (WINDOWS/UNIX/LINUX)。 3、全面、丰富的SDK 接口，为SDK 用户提供灵活、快速的开发应用基础。 4、采用国际标准的API编码方式，并提供标准的API开发文档。提高您的开发效率 5、先进的后台系统架构，支撑大发送量，稳定、高效。 多层结构、均衡负载。 6、国内唯一提供短信互动功能（短信投票、短信留言等）的平台。7、典型应用：与Web嵌入 与OA嵌入 与ERP嵌入 与CRM嵌入 团购网站接入 软件开发商嵌入 . 本开发文档的部分规范如下：l 通讯协议是HTTP的（POST方式提交内容）。l 请求应答过程中使用的中文编码格式为UTF-8。l 请求应答过程中使用的文件编码格式为Base64。l 入口IP地址 /api.php 或/api.phpl Ip和端口地址（具体询问业务员）2. 接口定义2.1获取基本信息1.接口提交：post模式2.接口参数：/api.php序号参数名称含义1username用户登录名，一般为手机号2password用户密码 3、返回值 - 0 /登录信息，0为正确，1为错误。 229293 /短信余额 2012年02月28日 11:23 /帐户到期日期，每充值一次自动续延一年。 1 /是否在线 1|2|3/扩展应用，不用理会 2.2发送短信POST方式1.接口提交：post模式2.接口参数：序号参数名称含义1username用户登录名，一般为手机号2password用户密码3methodmethod=sendsms4mobile13800000000.多个号码为半角逗号隔开5msgmsg=信息内容多个号码用“,”分隔 3、返回值 - 0 /发送信息反馈，0为正确，1为错误 1715622 /发送标识ID，一般用不着。 2.3修改密码1.接口提交：post模式2.接口参数：序号参数名称含义1username用户登录名，一般为手机号2password用户密码3methodmethod=changepassword4newpasswordnewpassword=newpassword 3、返回值 - 0 /发送信息反馈，0为正确，1为错误 密码已修改 /发送信息反馈，密码已成功修改 2.4接收信息1.接口提交：post模式2.接口参数：序号参数名称含义1username用户登录名，一般为手机号2password用户密码3methodmethod=getreply,具体请洽技术4sizesize=20 3、返回值 - 0 /发送信息反馈，0为正确，1为错误- /回复信息标志开始 159XXX52989 /回复短信的用户手机号 2010-12-04 20:00 /接收信息的时间- - /回复的内容 0 /信息获取的方式 34716 /信息接收的ID 1291464004 /原始的UNIX时间 /信息接收标识结束- 159XXX52989 2010-12-04 19:58 - - 0 34713 1291463892 2.5 接收短信投票1.接口提交：post模式2、接口文件 /api.php3.接口参数： 序号参数名称含义1username用户登录名，一般为手机号2password用户密码3methodmethod= getvote4id投票指令码的ID，需开通后才有。详细请联系技术人员。 3、返回值 - 0 /发送信息反馈，0为正确，1为错误- /投票标识开始 1001 /投票编号 张三 /投票说明 0 /投票票数 - 1002 李四 0 2.6 接收互动留言/投票1.接口提交：post模式2、接口文件 /12114api.php3.接口参数：序号参数名称含义1username用户登录名，一般为手机号2password用户密码3codecode=指令码4Sizesize=读取条数，设置大于0的正整数则读取相应数量的留言，否则读取最新留言。用于投票项目则返回每一条记录。可选参数5newreplynewreply=新回复，修改回复内容，仅用于留言互动。可选参数返回格式测试 /test12114api.htm 4、返回值 - 0 /接收信息状态，0为正确，1为错误- 13508XXX766 /上行的手机号码 2010-11-20 19:43 /上行留言的时间 5#白杨你好#首先祝大家节日快乐！我觉得大家跑出租都是为了生活吧？希望各位师兄师弟们保重身体。 /上行留言的内容 108918 /上行留言的标识ID1/投票会多返回一个票数字段,仅限特殊应用，详细请咨询技术 - 1391XXX6716 2010-11-15 17:29 5#测试 108899 2.7 GET方式发送短信特别建议：除非是单条应用类短信或技术原因，一般不建议使用GET方式。*Get传输的数据量小：这主要是因为受URL长度限制；而Post可以传输大量的数据*GET方式不安全：Post传输数据时，不需要在URL中显示出来，而Get方法要在URL中显示。1.接口提交：get模式2.接口参数：/api2.php?username=登录名&password=密码&method=sendsms&mobile=手机号&msg=abc 序号参数名称含义1username用户登录名，一般为手机号2password用户密码3methodmethod=sendsms4mobile13800000000.多个号码为半角逗号隔开5msgmsg=信息内容 3、返回值 - 0 /发送信息反馈，0为正确，1为错误 1715622 /发送标识ID，一般用不着。 3.服务器返回信息说明0、发送成功1、缺少登录信息2、登录信息错误3、帐号已过期4、未知方法5、手机号码、信息内容为空6、额度已用完7、发送条数超过XXX条，请等待管理员审核8、新密码为空其他的是从群发服务器直接返回的10、手机号码为空11、短信内容为空12、短信内容中有禁用词13、输入手机号码格式不正确14、输入小灵通号码格式不正确15、小灵通号码不是网通的号码16、号码不是手机或小灵通号码17、小灵通短信长度不能超过50个字18、时间格式错误21、手机号码格式不对22、短信内容为空30、密码错误40、灵信帐号不存在41、费用不足42、帐号过期43、达到每日最多发送量44、TaskID不合法3100、没有信息3099、发送失败3098、参数错误3097、序列号密码错误4.常见问题问答常见问题：一、为什么总是提示没有登录？答：原因1：这是因为您没有使用POST方式来提交数据的原因。你可能是以GET方式来提交的。请将每个参数均以POST的方式来提交就不会产生这种问题了。我们API暂不支持GET方式，因为GET不太安全且对字数有限制，不方便提交大量数据。 原因2：您的登录名是中文名称，而您没有对中文进行编码处理。请使用UTF8对编码做一下处理就可以了。二、为什么提交成功之后是乱码？ 这也是因为您的提交对中文没有进行编码处理的原因引起的。请使用UTF8编码对传输数据进行一下处理就可以了。三、我从什么地方可以得到具体的返回结果？ 您可以使用/testapi.htm 找到对应功能，提交后会在下面的窗口显示值，您只要会对XML进行处理就可以了。4.常见接口DEMO4.1 PHP接口（短信群发类）以下为最土团购程序使用的短信接口。如需完整源码，请至下载。?phpfunction sms_send($phone, $content) global $INI;if (mb_strlen($content, UTF-8) 20) return 短信长度低于20汉字？长点吧;$api = /api.php;$post=array();$postusername=$INIsmsuser;$postpassword=$INIsmspass;$postmethod=sendsms;$postmobile=$phone;$postmsg=$content;$res = Utility:HttpRequest($api,$post);return trim(strval($res)=0 ? true : strval($res);function sms_secret($mobile, $secret, $enable=true) global $INI;$funccode = $enable ? 订阅 : 退订;$content = $INIsystemsitename，您的手机号：$mobile 短信$funccode功能认证码：$secret。;sms_send($mobile, $content);function sms_coupon($coupon) global $INI;$coupon_user = Table:Fetch(user, $couponuser_id);if ( $couponconsume = Y| $couponexpire_time $coupon,user = $user,);$content = trim(preg_replace(/s+/,$content);if (true=($code=sms_send($coupon_usermobile, $content) Table:UpdateCache(coupon, $couponid, array(sms = array(sms + 1),);return true;return $code;4.2 PHP语言-互动留言DEMO手机号：密码：指令码：读取条数：全部新留言 最新条0 & $_POSTa=1)?&size=.intval($_POSTisize):);echo 提交网址：.$u.?.$d.;$c=send_post($u, $d);if($c=)echo 服务器连接错误;elseecho 返回内容：.htmlspecialchars($c,ENT_QUOTES);?4.3 ASP语言-短信投票%Function PostHttpPage(PostUrl,PostData) Dim xmlHttp Dim RetStr Set xmlHttp = CreateObject(Msxml2.ServerXMLHTTP) xmlHttp.Open POST, PostUrl, False XmlHTTP.setRequestHeader Content-Length, Len(PostData) xmlHttp.setRequestHeader Content-Type, application/x-www-form-urlencoded;charset=UTF-8 xmlHttp.Send PostData If Err.Number 0 Then Set xmlHttp=Nothing PostHttpPage = $False$ Exit Function End If PostHttpPage=bytesToBSTR2(xmlHttp.responseBody,gb2312) Set xmlHttp = nothingEnd FunctionFunction BytesToBstr2(strBody,CodeBase) dim obj set obj=Server.CreateObject(Adodb.Stream) obj.Type=1 obj.Mode=3 obj.Open obj.Write strBody obj.Position=0 obj.Type=2 obj.Charset=CodeBase BytesToBstr2=obj.ReadText obj.Close set obj=nothingEnd FunctionFunction getDate(var_date,var_format) if v