二次开发接口说明.docx
《二次开发接口说明.docx》由会员分享，可在线阅读，更多相关《二次开发接口说明.docx（14页珍藏版）》请在冰点文库上搜索。
二次开发接口说明
二次开发接口说明
短信二次接口技术
随着移动商务应用和3G无线技术的加速普及和深入发展与用户需求的变化，短信用户群由时尚人群不断向企业、行业用户扩展。
短信作为一种实用、方便、廉价的通信手段，越来越多地成为企业、行业人士日常工作不可或缺的通讯工具；同时，短信应用范围也由通用服务向企业、行业应用领域扩展。
短信应用不再局限于交互游戏等娱乐方式，它已经介入到企业办公、银行、证券、保险、交通、教育、社保、数据采集等领域，已成为企业、行业应用密不可分的一部分。
面向企业、行业的短信业务逐渐成为短信应用的一个重要组成部分，越来越多的企业开始利用短信平台开展各种短信增值业务如：
OA管理系统、短信商业信息发布系统、短信客户关系管理系统、短信呼叫中心、进销存系统、短信防伪、生产管理系统、短信数据采集等。
业务系统、网站、客户管理系统、进销存系统、OA、生产管理系统。
手机也势必会成为企业信息化管理、移动商务办公的又一大信息终端。
支持多种操作体统：
WINDOWS、LINUX、UNIX
支持多种开发语言：
C#、VB、delphi、VC++、ASP、JAVA、.NET等
支持开发方式：
Http协议
支持编码格式：
UTF-8编码
第一章发送接口
1.1请求地址
请求地址是客户接口程序调用时请求的url地址，采用的是httppost接口，地址是
客户端地址+例如：
:
8888/;
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
1.2参数说明
:
8888/?
action=send
参数名称
含义
说明
userid
企业id
企业ID
account
发送用户帐号
用户帐号，由系统管理员
password
发送帐号密码
用户账号对应的密码
mobile
全部被叫号码
发信发送的目的号码.多个号码之间用半角逗号隔开
content
发送内容
短信的内容
sendTime
定时发送时间
为空表示立即发送，定时发送格式2010-10-2409:
08:
10
action
发送任务命令
设置为固定的:
send
checkcontent
是否检查内容包含非法
关键字
当设置为1时表示需要检查，默认0为不检查
taskName
任务名称
本次任务描述100个字以内可以为空
countnumber
号码总数量
本次提交的号码总数量
mobilenumber
手机号码数量
本次提交的手机号码数量
telephonenumber
小灵通或座机号码数
本次提交的小灵通或座机号码数数量
例如：
action=send&userid=12&account=账号&password=密码&mobile=,&content=内容&sendTime=&taskName=本次任务描述&checkcontent=1&mobilenumber=10&countnumber=12&telephonenumber=2
1.3返回值
在接收到客户端发送的http请求后，返回以xml的方式返回处理结果。
格式为：
xmlversion="1.0"encoding="utf-8"?
>
status----------返回状态值：
成功返回Success失败返回：
Faild
message----------返回信息：
见下表
remainpoint----------返回余额
taskID-----------返回本次任务的序列ID
successCounts--成功短信数：
当成功后返回提交成功短信数
返回信息提示
说明
ok
提交成功
用户名或密码不能为空
提交的用户名或密码为空
发送内容包含sql注入字符
包含sql注入字符
用户名或密码错误
表示用户名或密码错误
短信号码不能为空
提交的被叫号码为空
短信内容不能为空
发送内容为空
包含非法字符：
表示检查到不允许发送的非法字符
对不起，您当前要发送的量大于您当前余额
当支付方式为预付费是，检查到账户余额不足
其他错误
其他数据库操作方面的错误
Ｃ#实例：
try{
EncodingmyEncoding=coding（"UTF-8"）;
stringparam="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）;
HttpWebRequestreq=（HttpWebRequest）e（":
8888/"）;
d="POST";
ntType="application/x-www-form-urlencoded;charset=UTF-8";
ntLength=h;
using（StreamreqStream=questStream（））
{
（postBytes,0,h）;
}
.XmlDocumentxmlDoc=new.XmlDocument（）;
using（WebResponsewr=sponse（））
{
StreamReadersr=newStreamReader（wr.GetResponseStream（）,.8）;
.StreamReaderxmlStreamReader=sr;
（xmlStreamReader）;
}
if（xmlDoc==null）
{
（"请求发生异常"）;
}
else{
Stringmessage=ementsByTagName（"message"）.Item（0）.ing（）;
if（message=="ok"）{
（"发送成功"）;
}
else{
（message）;
}
}
}
catch（.WebExceptionWebExcp）
{
（"网络错误，无法连接到服务器！
"）;
}
第二章余额及已发送量查询接口
2.1请求地址
请求地址是客户接口程序调用的时候请求的url地址，采用的是httppost接口，地址是
:
8888/
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
2.2参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
action
任务名称
设置为固定的：
overage
例如：
action=overage&userid=12&account=账号&password=密码
2.3返回值
xmlversion="1.0"encoding="utf-8"?
>
status-------返回状态值：
成功返回Success失败返回：
Faild
message--------------返回信息提示：
见下表
payinfo--------------返回支付方式后付费，预付费
overage-------------返回已发送条数
sendTotal----返回总点数当支付方式为预付费是返回总充值点数
返回信息提示
说明
返回空
查询成功
将返回相应的支付方式、账户使用条数、总充值点数
用户名或密码不能为空
提交的用户名或密码为空
用户名或密码错误
表示用户名或密码错误
Ｃ#实例：
try{
EncodingmyEncoding=coding（"UTF-8"）;
stringparam="action=overage&userid="+userid+"&account="+code（account,myEncoding）+"&password="+code（password,myEncoding）;
byte[]postBytes=.GetBytes（param）;
HttpWebRequestreq=（HttpWebRequest）e（":
8888/"）;
d="POST";
ntType="application/x-www-form-urlencoded;charset=UTF-8";
ntLength=h;
using（StreamreqStream=questStream（））
{
（postBytes,0,h）;
}
.XmlDocumentxmlDoc=new.XmlDocument（）;
using（WebResponsewr=sponse（））
{
StreamReadersr=newStreamReader（wr.GetResponseStream（）,.8）;
.StreamReaderxmlStreamReader=sr;
（xmlStreamReader）;
}
if（xmlDoc==null）
{
（"请求发生异常"）;
}
else{
Stringreturnstatus=ementsByTagName（"returnstatus"）.Item（0）.ing（）;
Stringmessage=ementsByTagName（"message"）.Item（0）.ing（）;
Stringoverage=ementsByTagName（"overage"）.Item（0）.ing（）;
if（returnstatus=="Success"）{
（"查询余额成功"）;
}
else{
（message）;
}
}
}
catch（.WebExceptionWebExcp）
{
（"网络错误，无法连接到服务器！
"）;
}
第三章非法关键词查询
3.1请求地址
请求地址是客户接口程序调用的时候请求的url地址，采用的是httppost接口，地址是
:
8888/
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
3.2参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
action
任务名称
设置为固定的：
checkkeyword
content
检测发送内容
需要发送的内容
例如：
action=checkkeyword&userid=12&account=账号&password=密码&content=内容
3.3返回值
xmlversion="1.0"encoding="utf-8"?
>
message--------------返回信息提示：
见下表
返回信息提示
说明
用户名或密码不能为空
提交的用户名或密码为空
用户名或密码错误
表示用户名或密码错误
包含非法字符
检查出来包含非法关键词
未包含非法字符
未检查出非法关键词
Ｃ#实例：
try{
EncodingmyEncoding=coding（"UTF-8"）;
stringparam="action=overage&userid="+userid+"&account="+code（account,myEncoding）+"&password="+code（password,myEncoding）;
byte[]postBytes=.GetBytes（param）;
HttpWebRequestreq=（HttpWebRequest）e（":
8888/"）;
d="POST";
ntType="application/x-www-form-urlencoded;charset=UTF-8";
ntLength=h;
using（StreamreqStream=questStream（））
{
（postBytes,0,h）;
}
.XmlDocumentxmlDoc=new.XmlDocument（）;
using（WebResponsewr=sponse（））
{
StreamReadersr=newStreamReader（wr.GetResponseStream（）,.8）;
.StreamReaderxmlStreamReader=sr;
（xmlStreamReader）;
}
if（xmlDoc==null）
{
（"请求发生异常"）;
}
else{
Stringreturnstatus=ementsByTagName（"returnstatus"）.Item（0）.ing（）;
Stringmessage=ementsByTagName（"message"）.Item（0）.ing（）;
Stringoverage=ementsByTagName（"overage"）.Item（0）.ing（）;
if（returnstatus=="Success"）{
（"查询余额成功"）;
}
else{
（message）;
}
}
}
catch（.WebExceptionWebExcp）
{
（"网络错误，无法连接到服务器！
"）;
}
第四章状态报告接口
4.1请求地址
请求地址是客户接口程序调用的时候请求的url地址，采用的是httppost接口，地址是
:
8888/
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
4.2参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
action
任务名称
设置为固定的：
query
例如：
action=query&userid=12&account=账号&password=密码
4.3返回值
xmlversion="1.0"encoding="utf-8"?
>
-------------对应的手机号码
1212-------------同一批任务ID
10---------状态报告----10：
发送成功，20：
发送失败
2011-12-0222:
12:
11-------------接收时间
1212
20
2011-12-0222:
12:
11
4.4错误返回值——状态报告请求错误返回格式及对应值
xmlversion="1.0"encoding="utf-8"?
>
1-------------错误码
用户名或密码不能为空-------------错误描述
1：
用户名或密码不能为空
2：
用户名或密码错误
3：
该用户不允许查看状态报告
4：
参数不正确
第五章上行接口
5.1请求地址
请求地址是客户接口程序调用的时候请求的url地址，采用的是httppost接口，地址是
:
8888/
入口地址一般不会发生变化，当发生变化的时候，会通知接口用户
5.2参数说明
参数名称
含义
说明
userid
企业id
企业ID
account
用户帐号
用户帐号，由系统管理员
password
帐号密码
用户账号对应的密码
action
任务名称
设置为固定的：
query
例如：
action=query&userid=12&account=账号&password=密码
5.3返回值
xmlversion="1.0"encoding="utf-8"?
>
-------------对应的手机号码
1212-------------同一批任务ID
你好，我不需要---------上行内容
2011-12-0222:
12:
11-------------接收时间
1212
你好，本次活动路线是怎么的
2011-12-0222:
12:
11
5.4错误返回值——回复请求错误返回格式及对应值
xmlversion="1.0"encoding="utf-8"?
>
1-------------错误码
用户名或密码不能为空-------------错误描述
1：
用户名或密码不能为空
2：
用户名或密码错误
3：
该用户不允许查看状态报告
4：
参数不正确
升级会员 