八优短信HTTP网接口文档.doc

八优短信网，HTTP接口文档提交连接/Api/BayouSmsApiEx.aspx编码方式Gb2312返回值说明返回值使用XML方式，xml中的标签，统一使用小写格式提交方式建议使用POST方式修改文档时间2011-10-18技术支持QQ917897075群发短信功能标识：func=sendsms 功能：向一个或多个号码发送短信 参数列表参数说明是否必填类型username账户必须stringpassword登录密码，调用接口时，需要32位md5必须stringmobiles要发送的号码，多个号码用英文逗号隔开必须stringmessage短信内容,发送时要在GB2312编码下两次URL必须string extno106行业用户发送短信时，指定一个扩展号码。如果不需要指定扩张号码，则传空。如果为非空，提交的扩展号，会覆盖掉用户在管理后台设置的扩展号码，所以如果需要在连接中提交了非空的扩展号，就需要针对各个运营商分别设置 （扩展号必须为数字，否则忽略掉）必须stringsmstype指定短信和号码的对应方式，0 表示 一个或多个号码对应一个短信内容，1 表示 号码和内容一一对应，也就是多个号码对应多个内容可选inttimertype发送定时短信时需要提供定时的类型（发送定时时，必须提供此参数） 1 只发一次 2 每天一次3每周一次 4 每月一次 5 每年一次可选inttimerflag1 表示 本次提交的是定时信息0 标识 本次提交的是非定时信息如果设置 为0 那么和定时相关的所有的参数都会被忽略掉（发送定时信息时，必须提供）可选inttimervalue定时时间 格式：yyyy-mm-dd hh:mm:ss如： 2011-09-05 01:01:01可选stringtimerid每次定时提交的标识，定时发送时必须提供，可以默认为0，可重复此标识主要用来 调用接口删除定时当要删除本次提交的定时时，只要提供该ID就可以删除了可选int 返回格式： 0xxx2010-05-15 04:01:200 返回字符串标签说明： 0 节点中的内容表示错误码，0 为执行成功 非0 标识执行失败 失败的具体原因可以在errordescription节点找相应的描述 xxx此节点的内容是对错误码的进一步说明即错误描述 0 此节点的内容对应的剩余条数 调用样例：发送一条短信：Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码&message=url(url(短信内容)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码&message=url(url(短信内容)&extno=77)发送多个号码对应一条短信：Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码,号码,号码&message=url(url(短信内容) &extno=88)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码,号码,号码&message=url(url(短信内容) &extno=)发送号码和内容一一对应：（添加一个smstype参数，号码内容一一对应）Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码1,号码2,号码3&message=url(url(短信内容1), url(url(短信内容2),url(url(短信内容3)&smstype=1)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码1,号码2,号码3&message=url(url(短信内容) ,url(url(短信内容2),url(url(短信内容3)&smstype=1)定时发送：（在非定时发送的参数基础上添加timerflag,timertype,timervalue,timerid）定时发送一条短信：Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码&message=url(url(短信内容)&timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码&message=url(url(短信内容) &timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)定时发送多个号码对应一条短信：Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码,号码,号码&message=url(url(短信内容) &timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码,号码,号码&message=url(url(短信内容) &timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)定时发送号码和内容一一对应：（添加一个smstype参数，号码内容一一对应）Httpget(/Api/BayouSmsApiEx.aspx?func=sendsms&username=账户&password=md5(密码)&mobiles=号码1,号码2,号码3&message=url(url(短信内容1), url(url(短信内容2),url(url(短信内容3)&smstype=1&timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)Httppost(/Api/BayouSmsApiEx.aspx,func=sendsms&username=账户&password=md5(密码)&mobiles=号码1,号码2,号码3&message=url(url(短信内容) ,url(url(短信内容2),url(url(短信内容3)&smstype=1&timerid=12&timerflag=1&timertype=1&timervalue=2011-10-10 10:10:10)获取回复信息(网站版)网站提供连接，八优后台推送 功能：获取回复短信 参数列表：参数说明是否必填类型clientid用户ID,此ID和账户相关，但不能改变必须stringmsg接受的回复信息内容必须stringmobile回复短信的号码必须stringreceivetime 回复短信到达时间必须stringdestmobile网关号码必填string 实例：Http:/?clientid=0&msg=1&mobile=2&receivetime=3&destmobile=4&用户提供的额外参数用户提供的额外参数: 这个参数是更具用户的需求添加的，帮助用户辨别推送标志或其他用途。获取回复信息(软件版，用户主动获取回复)功能标识 func=getreply 功能：获取回复短信 参数列表：参数说明是否必填类型username账户必须stringpassword登录密码，调用接口时，需要32位md5必须stringmsgcount一次最多取出多少回复 建议值 20必须intencodetype 指定获取回复内容的加密方式，默认为空（不加密）。现在接受加密方式：base64 必须string 返回格式：（普通格式）0xxx2010-05-15 04:01:20013162550089!CDATAxxxx12010-05-15 04:01:2013162550089!CDATAxxxx12010-05-15 04:01:20base64格式:0xxx2010-05-15 04:01:20013162550089!CDATAbase64(xxxx)12010-05-15 04:01:2013162550089!CDATAbase64(xxxx) 12010-05-15 04:01:20 返回字符串标签说明： 这个标签中的内容表示所有的回复 这个标签中的内容标识一条回复内容回复短信的号码回复的短信内容回复的时间回复到号码(发短信出去的号码) 调用样例：Httpget(/Api/BayouSmsApiEx.aspx?func=getreply&username=帐号&password=md5(密码)&msgcount=20&encodetype=)Httppost(/Api/BayouSmsApiEx.aspx,func=getreply&username=帐号&password=md5(密码)&msgcount=20&encodetype=)Httppost(/Api/BayouSmsApiEx.aspx,func=getreply&username=帐号&password=md5(密码)&msgcount=20&encodetype=base64) 删除定时：功能标识：func=deletetimer 功能：删除提交的定时 参数列表参数说明是否必填类型username账户必须stringpassword登录密码，调用接口时，需要32位md5必须stringt