二次开发接口说明.docx

1、二次开发接口说明二次开发接口说明短信二次接口技术随着移动商务应用和3G无线技术的加速普及和深入发展与用户需求的变化，短信用户群由时尚人群不断向企业、行业用户扩展。短信作为一种实用、方便、廉价的通信手段，越来越多地成为企业、行业人士日常工作不可或缺的通讯工具；同时，短信应用范围也由通用服务向企业、行业应用领域扩展。短信应用不再局限于交互游戏等娱乐方式，它已经介入到企业办公、银行、证券、保险、交通、教育、社保、数据采集等领域，已成为企业、行业应用密不可分的一部分。面向企业、行业的短信业务逐渐成为短信应用的一个重要组成部分，越来越多的企业开始利用短信平台开展各种短信增值业务如：OA管理系统、短信商业

2、信息发布系统、短信客户关系管理系统、短信呼叫中心、进销存系统、短信防伪、生产管理系统、短信数据采集等。业务系统、网站、客户管理系统、进销存系统、OA、生产管理系统。手机也势必会成为企业信息化管理、移动商务办公的又一大信息终端。 支持多种操作体统：WINDOWS、LINUX、UNIX支持多种开发语言：C#、VB、delphi、VC+、ASP、JAVA、.NET 等支持开发方式：Http协议支持编码格式：UTF-8编码第一章 发送接口1.1 请求地址 请求地址是客户接口程序调用时请求的url地址，采用的是http post 接口，地址是客户端地址+ 例如：:8888/; 入口地址一般不会发生变化，

3、当发生变化的时候，会通知接口用户 1.2参数说明:8888/?action=send参数名称含义说明userid企业id企业IDaccount发送用户帐号用户帐号，由系统管理员password发送帐号密码用户账号对应的密码mobile全部被叫号码发信发送的目的号码.多个号码之间用半角逗号隔开 content发送内容短信的内容sendTime定时发送时间为空表示立即发送，定时发送格式2010-10-24 09:08:10action发送任务命令设置为固定的:sendcheckcontent是否检查内容包含非法关键字当设置为1时表示需要检查，默认0为不检查taskName任务名称本次任务 描述10

4、0个字以内 可以为空countnumber号码总数量本次提交的号码总数量mobilenumber手机号码数量本次提交的手机号码数量telephonenumber小灵通或座机号码数本次提交的小灵通或座机号码数数量例如：action=send&userid=12&account=账号&password=密码&mobile=,&content=内容&sendTime=&taskName=本次任务描述&checkcontent=1&mobilenumber=10&countnumber=12&telephonenumber=21.3返回值 在接收到客户端发送的http请求后，返回以xml的方式返回处理

5、结果。格式为：status - 返回状态值：成功返回Success 失败返回：Faildmessage - 返回信息：见下表 remainpoint - 返回余额taskID - 返回本次任务的序列IDsuccessCounts -成功短信数：当成功后返回提交成功短信数返回信息提示说明ok提交成功用户名或密码不能为空提交的用户名或密码为空发送内容包含sql注入字符包含sql注入字符用户名或密码错误表示用户名或密码错误短信号码不能为空提交的被叫号码为空短信内容不能为空发送内容为空包含非法字符：表示检查到不允许发送的非法字符对不起，您当前要发送的量大于您当前余额当支付方式为预付费是，检查到账户余额

6、不足其他错误其他数据库操作方面的错误# 实例：tryEncoding 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&cou

7、ntnumber=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 (WebRes

8、ponse 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)(网络错误，无法

9、连接到服务器！ );第二章 余额及已发送量查询接口2.1 请求地址 请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是:8888/ 入口地址一般不会发生变化，当发生变化的时候，会通知接口用户 2.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：overage例如：action=overage&userid=12&account=账号&password=密码2.3返回值status-返回状态值：成功返回Success 失败返回：Fai

10、ldmessage-返回信息提示：见下表payinfo-返回支付方式 后付费，预付费overage-返回已发送条数sendTotal-返回总点数 当支付方式为预付费是返回总充值点数返回信息提示说明返回空查询成功将返回相应的支付方式、账户使用条数、总充值点数用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误# 实例：tryEncoding myEncoding = coding(UTF-8);string param = action=overage&userid= + userid + &account= + code(account, myEncoding) +

11、&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();u

12、sing (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()

13、;String overage= ementsByTagName(overage).Item(0).ing();if(returnstatus=Success)(查询余额成功 );else (message );catch (.WebException WebExcp)(网络错误，无法连接到服务器！ );第三章 非法关键词查询3.1 请求地址 请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是:8888/ 入口地址一般不会发生变化，当发生变化的时候，会通知接口用户 3.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由

14、系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：checkkeywordcontent检测发送内容需要发送的内容例如：action=checkkeyword&userid=12&account=账号&password=密码&content=内容3.3返回值message-返回信息提示：见下表返回信息提示说明用户名或密码不能为空提交的用户名或密码为空用户名或密码错误表示用户名或密码错误包含非法字符检查出来包含非法关键词未包含非法字符未检查出非法关键词# 实例：tryEncoding myEncoding = coding(UTF-8);string para

15、m = 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 reqStre

16、am = 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(retur

17、nstatus).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/

18、入口地址一般不会发生变化，当发生变化的时候，会通知接口用户 4.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：query例如：action=query&userid=12&account=账号&password=密码4.3返回值 -对应的手机号码1212-同一批任务ID10-状态报告-10：发送成功，20：发送失败2011-12-02 22:12:11-接收时间1212202011-12-02 22:12:114.4错误返回值状态报告请求错误返回格式及对应值 1-错误

19、码用户名或密码不能为空-错误描述1：用户名或密码不能为空2：用户名或密码错误3：该用户不允许查看状态报告4：参数不正确第五章 上行接口5.1 请求地址 请求地址是客户接口程序调用的时候请求的url地址，采用的是http post接口，地址是:8888/ 入口地址一般不会发生变化，当发生变化的时候，会通知接口用户 5.2参数说明参数名称含义说明userid企业id企业IDaccount用户帐号用户帐号，由系统管理员password帐号密码用户账号对应的密码action任务名称设置为固定的：query例如：action=query&userid=12&account=账号&password=密码5.3返回值 -对应的手机号码1212-同一批任务ID你好，我不需要-上行内容2011-12-02 22:12:11-接收时间1212你好，本次活动路线是怎么的2011-12-02 22:12:115.4错误返回值回复请求错误返回格式及对应值 1-错误码用户名或密码不能为空-错误描述1：用户名或密码不能为空2：用户名或密码错误3：该用户不允许查看状态报告4：参数不正确