二次开发接口说明目录客户接口说明.................................................................................................... 错误!未定义书签。
短信二次接口技术 (2)支持多种操作体统:WINDOWS、LINUX、UNIX (2)支持多种开发语言:C#、VB、delphi、VC++、ASP、JAVA、.NET 等 (2)支持编码格式:UTF-8编码 (3)第一章发送接口 (3)1.1 请求地址 (3)1.2参数说明 (3)1.3返回值 (3)第二章余额及已发送量查询接口 (5)2.1 请求地址 (5)2.2参数说明 (5)2.3返回值 (5)第三章非法关键词查询 (7)3.1 请求地址 (7)3.2参数说明 (7)3.3返回值 (7)第四章状态报告接口 (9)4.1请求地址 (9)4.2参数说明 (9)4.3返回值 (9)4.4错误返回值——状态报告请求错误返回格式及对应值 (10)第五章上行接口 (10)5.1 请求地址 (10)5.2参数说明 (10)5.3返回值 (10)5.4错误返回值——回复请求错误返回格式及对应值 (11)短信二次接口技术随着移动商务应用和3G无线技术的加速普及和深入发展与用户需求的变化,短信用户群由时尚人群不断向企业、行业用户扩展。
短信作为一种实用、方便、廉价的通信手段,越来越多地成为企业、行业人士日常工作不可或缺的通讯工具;同时,短信应用范围也由通用服务向企业、行业应用领域扩展。
短信应用不再局限于交互游戏等娱乐方式,它已经介入到企业办公、银行、证券、保险、交通、教育、社保、数据采集等领域,已成为企业、行业应用密不可分的一部分。
面向企业、行业的短信业务逐渐成为短信应用的一个重要组成部分,越来越多的企业开始利用短信平台开展各种短信增值业务如:OA管理系统、短信商业信息发布系统、短信客户关系管理系统、短信呼叫中心、进销存系统、短信防伪、生产管理系统、短信数据采集等。
业务系统、网站、客户管理系统、进销存系统、OA、生产管理系统。
手机也势必会成为企业信息化管理、移动商务办公的又一大信息终端。
支持多种操作体统:WINDOWS、LINUX、UNIX支持多种开发语言:C#、VB、delphi、VC++、ASP、JAVA、.NET 等支持开发方式:Http协议支持编码格式:UTF-8编码第一章发送接口1.1 请求地址请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是客户端地址+ 例如::8888/;入口地址一般不会发生变化,当发生变化的时候,会通知接口用户1.2参数说明:8888/?action=send例如:action=send&userid=12&account=账号&password=密码&mobile=,&content=内容&sendTime=&taskName=本次任务描述&checkcontent=1&mobilenumber=10&countnumber=12&telephonenumber=21.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>C# 实例:try{Encoding myEncoding = coding("UTF-8");string param = "action=send&userid=" + userid + "&account=" + code(account, myEncoding) + "&password=" + code(password, myEncoding) + "&mobile=,&content=" + code(content, myEncoding) + "&sendTime=" +code(sendTime, myEncoding) + "&mobilenumber=2&countnumber=2&telephonenumber=0";byte[] postBytes = .GetBytes(param);HttpWebRequest req = (HttpWebRequest)e(":8888/");d = "POST";ntType = "application/x-www-form-urlencoded;charset=UTF-8";ntLength = h;using (Stream reqStream = questStream()){(postBytes, 0, h);}.XmlDocument xmlDoc = new .XmlDocument();using (WebResponse wr = sponse()){StreamReader sr = new StreamReader(wr.GetResponseStream(), .8);.StreamReader xmlStreamReader = sr;(xmlStreamReader);}if (xmlDoc == null){("请求发生异常" );}else {String message = ementsByTagName("message").Item(0).ing();if(message =="ok"){("发送成功" );}else {(message );}}}catch (.WebException WebExcp){("网络错误,无法连接到服务器!" );}第二章余额及已发送量查询接口2.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是:8888/入口地址一般不会发生变化,当发生变化的时候,会通知接口用户2.2参数说明例如:action=overage&userid=12&account=账号&password=密码2.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><returnstatus>status</returnstatus>-------返回状态值:成功返回Success 失败返回:Faild <message>message</message>--------------返回信息提示:见下表<payinfo>payinfo</payinfo>--------------返回支付方式后付费,预付费<overage>overage</overage>-------------返回已发送条数<sendTotal>sendTotal</sendTotal>----返回总点数当支付方式为预付费是返回总充值点数</returnsms>C# 实例:try{Encoding myEncoding = coding("UTF-8");string param = "action=overage&userid=" + userid + "&account=" + code(account, myEncoding) +"&password=" + code(password, myEncoding) ;byte[] postBytes = .GetBytes(param);HttpWebRequest req = (HttpWebRequest)e(":8888/");d = "POST";ntType = "application/x-www-form-urlencoded;charset=UTF-8";ntLength = h;using (Stream reqStream = questStream()){(postBytes, 0, h);}.XmlDocument xmlDoc = new .XmlDocument();using (WebResponse wr = sponse()){StreamReader sr = new StreamReader(wr.GetResponseStream(), .8);.StreamReader xmlStreamReader = sr;(xmlStreamReader);}if (xmlDoc == null){("请求发生异常" );}else {String returnstatus= ementsByTagName("returnstatus").Item(0).ing();String message = ementsByTagName("message").Item(0).ing();String overage= ementsByTagName("overage").Item(0).ing();if(returnstatus=="Success"){("查询余额成功" );}else {(message );}}}catch (.WebException WebExcp){("网络错误,无法连接到服务器!" );}第三章非法关键词查询3.1 请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是:8888/入口地址一般不会发生变化,当发生变化的时候,会通知接口用户3.2参数说明action=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><message>message</message>--------------返回信息提示:见下表</returnsms>C# 实例:try{Encoding myEncoding = coding("UTF-8");string param = "action=overage&userid=" + userid + "&account=" + code(account, myEncoding) + "&password=" + code(password, myEncoding) ;byte[] postBytes = .GetBytes(param);HttpWebRequest req = (HttpWebRequest)e(":8888/");d = "POST";ntType = "application/x-www-form-urlencoded;charset=UTF-8";ntLength = h;using (Stream reqStream = questStream()){(postBytes, 0, h);}.XmlDocument xmlDoc = new .XmlDocument();using (WebResponse wr = sponse()){StreamReader sr = new StreamReader(wr.GetResponseStream(), .8);.StreamReader xmlStreamReader = sr;(xmlStreamReader);}if (xmlDoc == null){("请求发生异常" );}else {String returnstatus= ementsByTagName("returnstatus").Item(0).ing();String message = ementsByTagName("message").Item(0).ing();String overage= ementsByTagName("overage").Item(0).ing();if(returnstatus=="Success"){("查询余额成功" );}else {(message );}}}catch (.WebException WebExcp){("网络错误,无法连接到服务器!" );}第四章状态报告接口4.1请求地址请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是:8888/入口地址一般不会发生变化,当发生变化的时候,会通知接口用户4.2参数说明action=query&userid=12&account=账号&password=密码4.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><statusbox><mobile></mobile>-------------对应的手机号码<taskid>1212</taskid>-------------同一批任务ID<status>10</status>---------状态报告----10:发送成功,20:发送失败<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间</statusbox><statusbox><mobile></mobile><taskid>1212</taskid><status>20</status><receivetime>2011-12-02 22:12:11</receivetime></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接口,地址是:8888/入口地址一般不会发生变化,当发生变化的时候,会通知接口用户5.2参数说明例如:action=query&userid=12&account=账号&password=密码5.3返回值<?xml version="1.0" encoding="utf-8" ?><returnsms><callbox><mobile></mobile>-------------对应的手机号码<taskid>1212</taskid>-------------同一批任务ID<content>你好,我不需要</content>---------上行内容<receivetime>2011-12-02 22:12:11</receivetime>-------------接收时间</callbox><callbox><mobile></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:参数不正确。