短信接口文档
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
Web Service接入模式
Web Service 发送短信模式
Web Service 路径:/WS/LinkWS.asmx
系统提供8个接口: 注册接口Reg、更改密码接口UpdPwd、修改注册信息UpdReg、
查询余额接口SelSum、发送信息接口Send、
群发短信接口 BatchSend 、短信报告接口 GetReportSMS、接收短信Get
注册接口Reg
输入参数:
参数说明类型
LoginName代理商账号String
LoginPwd 代理商密码String
CorpName 企业名称String
LinkMan 联系人String
Tel 联系电话String
Mobile 联系人手机String
Email 邮件String
Memo 其他备注String
CorpID 用户账号String
Pass 用户密码String
输出参数:
输出返回值参数状态说明
OK 注册成功
错误文本失败
C# 实例:
try
{
Dxt.LinkWS LinkWs=new dxt.LinkWS();
String ReS=LinkWs.Reg(LoginName, LoginPwd, CorpName, LinkMan, Tel, Mobile, Email, CorpID, Pass);
if(ReS=="OK")
{
MessageBox.Show("注册成功" );
}
else
{
MessageBox.Show("注册失败!" );
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
}
更改密码UpPwd
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
NewPwd 新密码String
输出参数:
输出返回值参数状态说明
0 密码修改成功
–1 账号未注册
–2 其他错误
–3 密码错误
C# 实例:
try
{
Dxt.LinkWS LinkWs=new Dxt.LinkWS();
int
UpdPwd=LinkWs.Reg(CorpID.Text.Trim(),Pwd.Text.Trim(),NewPwd.Text.Trim());
if(ReS==0)
{
MessageBox.Show("密码修改成功" );
}
else if(ReS==-1)
{
MessageBox.Show("账号未注册" );
}
else if(ReS==-2)
{
MessageBox.Show("其他错误!" );
}
else if(ReS==-3)
{
MessageBox.Show("密码错误!" );
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
修改注册信息 UpdReg
输入参数:
参数说明类型CorpID 账号String Pwd 密码String CorpName 企业名称String LinkMan 联系人String Tel 联系电话String Mobile 联系人手机String Email 邮件String Memo 其他备注String
输出参数:
输出返回值参数状态说明
0 修改成功
–1 账号未注册
–2 其他错误
–3 密码错误
C# 实例:
try
{
Dxt.LinkWS LinkWs=new dxt.LinkWS();
ReS=LinkWs.UpdReg(CorpID.Text.Trim(),Pwd.Text.Trim(),CorpName.Text.Trim(),LinkMan.Text.Tr im(),Tel.Text.Trim(),Mobile.Text.Trim(),Email.Text.Trim(),Memo.Text.Trim());
if(ReS==0)
{
MessageBox.Show("成功修改注册信息" );
}
else if(ReS==-1)
{
MessageBox.Show("帐号未注册!" );
}
else if(ReS==-2)
{
MessageBox.Show("其他错误!" );
}
else if(ReS==-3)
{
MessageBox.Show("帐号密码不匹配!" );
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
查询余额SelSum
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
输出参数:
输出返回值参数状态说明
0 剩余条数
–1 账号未注册
–2 其他错误
–3 密码错误
C# 实例:
try
{
Dxt.LinkWS LinkWs=new dxt.LinkWS();
int ReS=LinkWs.SelSum(CorpID.Text.Trim(),Pwd.Text.Trim());
if(ReS>=0)
MessageBox.Show("还剩"+ReS.ToString()+"条" );
}
else if(ReS==-1)
{
MessageBox.Show("帐号未注册!" );
}
else if(ReS==-2)
{
MessageBox.Show("其他错误!" );
}
else if(ReS==-3)
{
MessageBox.Show("帐号密码不匹配!" );
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
}
发送短信 Send(返回状态报告ID)
输入参数:
参数说明类型
CorpID 账号String
Pwd 密码String
Mobile 发送手机号码String
Content 发送内容(需要UrlEncode)String
Cell 子号String
SendTime 定时发送时间String 2012/2/6 17:02:00 输出参数:
输出返回值参数状态说明
大于0的数字发送成功(得到大于0的数字、作为取报告的id)
–1 账号未注册
–2 其他错误
–3 密码错误
–4 手机号格式不对
–5 余额不足
–6 定时发送时间不是有效的时间格式
–7 禁止10小时以内向同一手机号发送相同短信
-10 需要审核的信息
C# 实例:
try
{
Dxt.LinkWS LinkWs=new Dxt.LinkWS();
int
ReS=LinkWs.Send2(CorpID.Text.Trim(),Pwd.Text.Trim(),SendMobile.Text.ToString().Trim(),Sen dContent.Text.ToString().Trim(),"",SendTime.Text.ToString().Trim());
if (ReS == 0)
{
MessageBox.Show("发送成功!" );
}
else if(ReS==-1)
{
MessageBox.Show("帐号未注册!") ;
}
else if(ReS==-2)
{
MessageBox.Show("其他错误!") ;
}
else if(ReS==-3)
{
MessageBox.Show("帐号密码不匹配!") ;
}
else if(ReS==-4)
{
MessageBox.Show("手机号码不正确!") ;
}
else if(ReS==-5)
{
MessageBox.Show("余额不足!") ;
}
else if(ReS==-6)
{
MessageBox.Show("定时发送时间不是有效时间!") ;
}
else if(ReS==-7)
{
MessageBox.Show("禁止10小时之内向同一手机发送相同内容") ;
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
}
群发短信 BatchSend(返回状态报告ID)
输入参数:备注:相同内容的号码尽量一个包提交(一次性最多支持600个号码)。
提高
内容处理的速度
参数说明类型
CorpID 账号String
Pwd 密码String
Mobile 发送手机号码(最多600个)String
Content 发送内容(需要UrlEncode) String
Cell 子号String
SendTime 定时发送时间String(2012/2/6 17:02:00)输出参数:
输出返回值参数状态说明
大于0的数字发送成功(得到大于0的数字、作为取报告的id)
–1 账号未注册
–2 其他错误
–3 帐号或密码错误
–4 一次提交信息不能超过600个手机号码
–5 余额不足,请先充值
–6 定时发送时间不是有效的时间格式
–8 发送内容需在3到250字之间
-9 发送号码为空
-10 需要审核的信息
try
{
Dxt.LinkWS LinkWs=new Dxt.LinkWS();
int R = WSS.BatchSend(CorpID, Pwd, textBox1.Text, textBox2.Text, "", "");
if (R==0)
{
MessageBox.Show("发送成功进入审核阶段!");
}
else if(R==1)
{
MessageBox.Show("直接发送成功!!");
}
else if(R==-1)
{
MessageBox.Show("帐号未注册!");
}
else if(R==-2)
{
MessageBox.Show("其他错误!");
}
else if(R==-3)
{
MessageBox.Show("帐号或密码错误!");
}
else if(R==-4)
{
MessageBox.Show("一次提交信息不能超过600个手机号码!");
}
else if(R==-5)
{
MessageBox.Show("企业号帐户余额不足,请先充值再提交短信息!"); }
else if(R==-6)
{
MessageBox.Show("定时发送时间不是有效时间格式!");
}
else if(R==-8)
{
MessageBox.Show("发送内容需在3到250个字之间");
}
else if(R==-9)
{
MessageBox.Show("发送号码为空");
}
}
catch(.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!");
}
接收短信 Get
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
输出参数:
输出返回值参数状态说明
字符串接受短信的内容
–1 账号未注册
–2 其他错误
–3 密码错误
返回格式为:||手机号#上行内容#发送时间#子号||手机号#上行内容#发送时间#子号……C# 实例:
try
{
Dxt.LinkWS LinkWs=new Dxt.LinkWS();
string result=LinkWs.Get(CorpID.Text.Trim(),Pwd.Text.Trim());
if(result=="")
{
MessageBox.Show("没有上行信息");
}
else if(result=="-1")
{
MessageBox.Show("帐号未注册!") ;
}
else if(result=="-2")
{
MessageBox.Show("其他错误!") ;
}
else if(result=="-3")
{
MessageBox.Show("帐号密码不匹配!" );
}
else
{
string ReGet="";
result=result.Replace("||","|");
string[] temp=result.Split("|".ToCharArray());
for(int i=0;i<temp.Length;i++)
{
if(temp[i].Trim()!="")
{
string[] temp1=temp[i].Split("#".ToCharArray());
if(temp1.Length>2)
{
ReGet+="第"+i.ToString()+"条回复,手机号:
"+temp1[0]+",内容:"+temp1[1]+",回复时间:"+temp1[2]+",回复号码:"+temp1[3]+"\n";
}
}
}
MessageBox.Show(ReGet.ToString().Trim());
}
}
catch (.WebException WebExcp)
{
MessageBox.Show("网络错误,无法连接到服务器!" );
短信报告接口 GetReportSMS
输入参数
参数说明类型CorpID 帐号String Pwd 密码String 输出参数:
输出返回值参数状态说明
成功
ID+'$$$$$'+号码+''$$$$$'+时
间+'$$$$$'+报告标志
+'$$$$$'+报告+'|||'
错误文本失败
string R = WSS.GetReportSMS(CorpID, Pwd, "");
MessageBox.Show(R.ToString());
Http接入模式
注册接口Reg
输入参数:
参数说明类型LoginName代理商账号String LoginPwd 代理商密码String CorpName 企业名称String LinkMan 联系人String Tel 联系电话String Mobile 联系人手机String Email 邮件String Memo 其他备注String CorpID 用户账号String Pass 用户密码String 输出参数:
输出返回值参数状态说明
0 注册成功
–1 账号已经注册
–2 其他错误
–3 账号密码不匹配
调用方式:
/http/Reg.aspx?LoginName=string&LoginPwd=string&CorpName=string&LinkMan=stri ng&Tel=string&Mobile=string&Email=string&CorpID=string&Pass=string
注:* 号由相应的信息代替。
更改密码UpPwd
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
NewPwd 新密码String
输出参数:
输出返回值参数状态说明
0 密码修改成功
–1 账号未注册
–2 其他错误
–3 密码错误
调用方式:
/http/UpdPwd.aspx?CorpID=string&Pwd=string&NewPwd=string
修改注册信息 UpdReg
输入参数:
参数说明类型
CorpID 账号String
Pwd 密码String
CorpName 企业名称String
LinkMan 联系人String
Tel 联系电话String
Mobile 联系人手机String
Email 邮件String
Memo 其他备注String
输出参数:
输出返回值参数状态说明
0 修改成功
–1 账号未注册
–2 其他错误
–3 密码错误
调用方式:
/http/UpdReg.aspx?CorpID=string&Pwd=string&CorpName=string&LinkMan=string&Te l=string&Mobile=string&Email=string&Memo=string
查询余额SelSum
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
输出参数:
输出返回值参数状态说明
0 剩余条数
–1 账号未注册
–2 其他错误
–3 密码错误
调用方式:
/http/SelSum.aspx?CorpID=string&Pwd=string
发送短信 Send(返回状态报告ID)
输入参数:
参数说明类型
CorpID 账号String
Pwd 密码String
Mobile 发送手机号码String
Content 发送内容(需要UrlEncode) String
Cell 子号String
SendTime 定时发送时间String(14)
输出参数:
输出返回值参数状态说明
大于0的数字发送成功(得到大于0的数字、作为取报告的id)
–1 账号未注册
–2 其他错误
–3 密码错误
–4 手机号格式不对
–5 余额不足
–6 定时发送时间不是有效的时间格式
–7 禁止10小时以内向同一手机号发送相同短信
/http/Send.aspx?CorpID=string&Pwd=string&Mobile=string&Content=string&SendTi me=string
群发短信 BatchSend(返回状态报告ID)
输入参数:备注:相同内容的号码尽量一个包提交(一次性最多支持600个号码)。
提高内容处理的速度
参数说明类型
CorpID 账号String
Pwd 密码String
Mobile 发送手机号码(最多600个)String
Content 发送内容(需要UrlEncode) String
Cell 子号String
SendTime 定时发送时间String(14)
固定14位长度字符串,比如:20060912152435代表2006年9月12日15时24分35秒,为空表示立即发送
输出参数:
输出返回值参数状态说明
大于0的数字发送成功(得到大于0的数字、作为取报告的id)
–1 账号未注册
–2 其他错误
–3 帐号或密码错误
–4 一次提交信息不能超过600个手机号码
–5 余额不足,请先充值
–6 定时发送时间不是有效的时间格式
–8 发送内容需在3到250字之间
-9 发送号码为空
/http/BatchSend.aspx?CorpID=string&Pwd=string&Mobile=string&Content=string&S endTime=string
接收短信 Get
输入参数
参数说明类型
CorpID 帐号String
Pwd 密码String
输出参数:
输出返回值参数状态说明
字符串接受短信的内容
–1 账号未注册
–2 其他错误
–3 密码错误
调用方式:
/http/Get.aspx?CorpID=string&Pwd=string
短信2报告接口 GetReportSMS
输入参数
参数说明类型CorpID 帐号String Pwd 密码String 输出参数:
输出返回值参数状态说明
成功
ID+'$$$$$'+号码+''$$$$$'+时
间+'$$$$$'+报告标志
+'$$$$$'+报告+'|||'
错误文本失败
/http/GetReportSMS.aspx?CorpID=string&Pwd=string。