满意通短信引擎SDK使用手册.doc

【满意通短信引擎SDK使用手册】编号【满意通短信引擎SDK使用手册】API模块开发平台嵌入说明书【北京亿美软通科技有限公司】【作者：顾鹏】【版本号：1.00】【日期：2004-7-29】目录引言文档版本说明第1章基本功能介绍1.1即时发送短信1.2定时发送短信1.3查询单条短信的价格1.4查询余额1.5注册1.6充值1.7接收短信1.8查询满意通版本信息1.9申请转接服务1.10注销转接服务第2章函数说明2.1Delphi版函数说明及实例2.1.1RegistBoth函数2.1.2GetBalance函数2.1.3Chargeup函数2.1.4Sendsms函数2.1.5SendScheduledSMS函数2.1.6GetReplySMS函数2.2 通用版函数说明及实例2.2.1VB、VB.net中调用函数形式RegisterVB函数GetBalanceVB函数ChargeUpVB函数SendSMSVB函数SendScheSMSVB函数ReceiveSMSVB函数GetPriceVB函数ChangeReciveVB函数CancelChangeReciveVB函数2.2.2C+,Delphi,C#,ASP中调用函数形式简介2.3 JAVA版函数说明及实例2.3.1Client函数2.3.2Regist函数2.3.3GetBalance函数2.3.4ChargUp函数2.3.5SendSMS函数第3章嵌入说明3.1Delphi版嵌入3.2通用版嵌入3.3JAVA版嵌入第4章实例说明4.1Delphi调用Delphi版实例4.2通用版调用实例4.2.1ASP4.2.2VB代码4.2.3Delphi调用通用版代码4.2.4VC代码4.3Java调用实例引言：本技术白皮书编写目的主要为合作伙伴及嵌入服务商提供技术支持的文档说明文档版本说明：版本日期作者说明1.002004-7-29顾鹏第1章 基本功能介绍 在使用各种功能进行各种测试时(如：注册、发送短信、接收短信等等)，请确认网络处在连通状态，并无网络阻塞情况发生。并注意功能测试流程：Register注册软件 ChargeUp向软件存值 SendSMS发送短信 ReceiveSMS接收短信 GetBalance查询余额。1.1 即时发送短信 发送短信到一个用户手机中，也可群发至多用户终端；短信内容的长度最大为70个字符，如果短信内容长度大于70个字，需由开发人员对短信内容进行分割处理，例：一条100个字的短信，需将其分为两条(分别为70字、30字)来发送。确保用户准确完整地接收信息。1.2 定时发送短信 指定日期时间群发或单独发送到指定用户手机中；内容要求同上。1.3 查询单条短信的价格 可以查询单条短信在通满意平台发送时的价格。1.4 查询余额 获得当前注册帐户当前余额。1.5 注册 可以完成软件序列号及完整的企业信息部分的注册功能，并将繁琐的软件注册与企业信息注册两个部分，完整的封装到一个功能模块中，一次完成以上两步操作。1.6 充值 用户利用充值卡号与密码，进行当前序列号的充值。1.7 接收短信 下载用户回复的短消息到本地服务器中。1.8 申请转接服务 申请转接功能后系统将受到的短信直接发送到系统指定的手机中。1.9 注销转接服务 可以通过注销转接服务，取消绑定的手机号码。第2章 函数说明2.1 Delphi版函数说明及实例2.1.1 RegistBoth函数 RegistBoth(softwareSerialNum: PChar; EntName: PChar; LinkMan: PChar; Phone: PChar; Mobile: PChar; Email: PChar; Fax: PChar; sAddress: PChar; Postcode: PChar): boolean; stdcall;函数功能：同时注册软件序列号与企业详细信息的注册；输入参数：软件序列号；企业名称；联系人姓名；联系电话；联系手机；电子邮件；联系传真；公司地址；邮政编码；输出结果：注册成功，函数返回为TRUE；注册失败，函数返回为FALSE；2.1.2 GetBalance函数 GetBalance(softwareSerialNum: Pchar; out unitPrice: real): real;函数功能：获得帐户当前余额；输入参数：软件序列号，待返回的单位价格实数变量；输出结果：帐号余额，同时通过传入的单位价格实数变量返回单位价格。2.1.3 Chargeup函数 ChargeUp(softwareSerialNum: PChar; CardNum: PChar; Password: PChar): boolean;函数功能：用充值卡充值；输入参数：软件序列号；卡号；卡密码；输出结果：充值成功，函数返回为TRUE；充值失败，函数返回为FALSE；2.1.4 Sendsms函数 SendSMS(mobileNums: array of PChar; softwareSerialNum: PChar; smsContent: PChar): boolean;函数功能：发送短消息，立即发送方式；输入参数：手机号码数组；软件序列号；短信内容；输出结果：发送短信成功，函数返回为TRUE；发送短信失败，函数返回为FALSE；2.1.5 SendScheduledSMS函数 SendScheduledSMS(mobileNums: array of PChar; softwareSerialNum: PChar; smsContent: PChar; scheduledTime: PChar): boolean;函数功能：按指定时间发送短消息；输入参数：手机号码数组；软件序列号；短信内容；预定发送时间，格式为“yyyy-mm-dd hh:nn:ss”输出结果：发送短信成功，函数返回为TRUE；发送短信失败，函数返回为FALSE；2.1.6 GetReplySMS函数 GetReplySM(softwareSerialNum: PChar; out SMSTotal: integer): PChar;函数功能：下载用户回复的短消息输入参数：软件序列号；整型变量，用以返回本次下载的短消息数；输出结果：无新短消息，则函数返回值为空，指针为nil；有新短信，函数返回为一个包含全部短信的字符串，格式为短信内容|2003-01-01 00:00:01短信内容|2003-01-01 00:00:02”，即每个短信由三部分组成：手机号+短信内容+时间，分隔符为单竖线；各条短信之间用双竖线|分割；同时，本次下载的短信条数通过传入的整型变量带回。2.2 通用版函数说明及实例2.2.1 VB、VB.net中调用函数形式 RegisterVB函数 RegisterVB (软件序列号，企业名称，联系人姓名，联系电话，联系手机，电子邮件，联系传真，公司地址，邮政编码);函数功能：注册软件序列号；输入参数：软件序列号；企业名称；联系人姓名；联系电话；联系手机；电子邮件；联系传真；公司地址；邮政编码输出结果：注册成功，函数返回值：“998”：网络故障 “999”：网络故障或其它故障 “0”： 注册失败,本软件已注册 “1”： 注册成功 其它：未知故障 GetBalanceVB函数 GetBalanceVB (软件序列号)函数功能：获得帐户当前余额；输入参数：软件序列号；输出结果：帐号余额。函数返回值：“998”：网络故障 “999”：网络故障或其它故障 返回其它实数：为帐号余额 ChargeUpVB函数 ChargeUpVB (软件序列号，卡号，卡密码): 函数功能：用充值卡充值；输入参数：软件序列号；卡号；卡密码；输出结果：充值成功，函数返回值：“998”：网络故障 “999”：网络故障或其它故障 “0”： 充值失败,本存值卡已使用 “1”： 充值成功 其它：未知故障 SendSMSVB函数 SendSMSVB (软件序列号,手机号码, 短信内容):函数功能：发送短消息，立即发送方式；输入参数：软件序列号；手机号码；短信内容；输出结果：发送短信成功，函数返回值：“998”：网络故障 “999”：网络故障或其它故障 “0”： 发送失败 “1”： 发送成功 其它：未知故障 SendScheSMSVB函数 SendScheSMSVB (软件序列号，手机号码，短信内容，预定发送时间): 函数功能：按指定时间发送短消息；输入参数：软件序列号；手机号码；短信内容；预定发送时间，格式为“yyyy-mm-dd hh:nn:ss”输出结果：发送短信成功，函数返回值：“998”：网络故障 “999”：网络故障或其它故障 “0”： 发送失败 “1”： 发送成功 其它：未知故障 ReceiveSMSVB函数 ReceiveSMSVB (软件序列号): 函数功能：下载用户回复的短消息输入参数：软件序列号；输出结果：“997”：没有上行信息 “998”：网络故障 “999”：网络故障或其它故障 其它字符：是用|和|分隔的字符串，需要程序进行解析,格式如:手机号 | 内容 | 时间 | 手机号 | 内容 | 时间 | .的循环格式。 GetPriceVB函数GetPriceVB (软件序列号): 函数功能：通满意平台发送一条短信的价格输入参数：软件序列号；输出结果： “998”：网络故障 “999”：网络故障或其它故障 其它：通满意平台发送一条短信的价格。 ChangeReciveVB函数ChangeReciveVB(软件序列号，手机号)函数功能：申请转接功能输入参数：软件序列号，手机号；输出结果： “1”：申请成功 “2”：申请失败 CancelChangeReciveVB函数CancelChangeReciveVB (软件序列号，手机号)函数功能：注销转接功能输入参数：软件序列号，手机号；输出结果： “1”：注销成功 “2”：注销失败2.2.2 C+,Delphi,C#,ASP中调用函数形式 在C+,Delphi,C#,ASP中调用函数时,函数功能同2.2.1中所介绍的功能、参数、输出结果完全一样，但是函数名略有不同，具体形式如下：Register函数GetBalance函数ChargeUp函数SendSMS函数SendScheSMS函数ReceiveSMS函数GetPrice函数ChangeRecive函数CancelChangeRecive函数2.3 JAVA版函数说明及实例2.3.1Client函数public Client(java.lang.String serialNumber)构造函数 Parameters: serialNumber - 软件序列号字符串2.3.2 regist函数registpublic boolean regist()API软件序列号注册方法 API只需注册一次。 Returns: 成功与否的布尔值2.3.3 getBalance函数getBalancepublic double getBalance()查询余额 Returns: double 余额数值2.3.4 chargUp函数chargUppublic boolean chargUp(java.lang.String cardNo, java.lang.String cardPass)充值方法，为帐号（序列号）充值。 Parameters: cardNo - 充值卡卡号 cardPass - 充值卡密码 Returns: 充值操作结果2.3.5 sendSMS函数sendSMSpublic boolean sendSMS(java.lang.String mobiles, java.lang.String smsContent)短信发送方法 Parameters: mobiles - 手机号码字符串数组，元素最多为1000。 smsContent - 短信内容，最长不超过70个bytes。 Returns:短信发送结果第3章 嵌入说明3.1 Delphi版此动态链接库只是用Delphi开发环境下的嵌入与调用。CustsmsAPI.dll的运行需要HDSerialNumRead.dll的支持。在程序中使用CustsmsAPI.dll，须将CustsmsAPI.dll和HDSerialNumRead.dll两个文件复制到程序文件所在目录下，并在程序中说明需要使用的函数原型。3.2 通用版此动态链接库是用于VC、Delphi、C#在程序中使用，需将CustComm.dll文件复制到程序文件所在目录下，在VB、Dot Net、ASP中调用时，请将CustComm.dll复制到$windir$system目录下使用并在使用前进行注册COM组件, 例：regsvr32 X:XXXASPComm2.dll须将CustComm.dll复制到程序文件所在目录下，并在程序中说明需要使用的函数原型。3.3 JAVA版在Java中调用时，要求j2sdk1.4。将该jar文件添加入Classpath中即可使用，此函数包可在不同开发平台中使用如Windows、Linux系统中使用。第4章 实例说明4.1 Delphi调用Delphi版实例代码 首先，在delphi中进行调用声明，在implementation下添加如下说明： function getBalance(softwareSerialNum: Pchar; out unitPrice: real): real; stdcall; external CustsmsAPI.dll; /获得余额 function chargeUp(softwareSerialNum: PChar; CardNum: PChar; Password: PChar): boolean; stdcall; external CustsmsAPI.dll; /充值 function sendSMS(mobileNums: array of PChar; softwareSerialNum: PChar; smsContent: PChar): boolean; stdcall; external CustsmsAPI.dll; /发送短息 function getReplySM(softwareSerialNum: PChar; out SMSTotal: integer): PChar; stdcall; external CustsmsAPI.dll; /接收短信 function registBoth(softwareSerialNum: PChar; EntName: PChar; LinkMan: PChar; Phone: PChar; Mobile: PChar; Email: PChar; Fax: PChar; sAddress: PChar; Postcode: PChar):boolean; stdcall; external CustsmsAPI.dll; /注册函数 function sendScheduledSMS(mobileNums: array of PChar; softwareSerialNum: PChar; smsContent: PChar; scheduledTime: PChar): boolean; stdcall; external CustsmsAPI.dll; /定时发送短信 对事件进行函数调用4.1.1.注册procedure TForm1.Button2Click(Sender: TObject);var SN, EN, LMan, Pho, Moi, Ema, Fax, Add, Pc: PChar;begin sn:=pchar(edit1.Text); en:=pchar(edit2.Text); lman:=pchar(edit3.Text); pho:=pchar(edit4.Text); moi:=pchar(edit5.Text); ema:=pchar(edit6.Text); fax:=pchar(edit7.Text); add:=pchar(edit8.Text); pc:=pchar(edit9.Text); if registboth(sn,en,lman,pho,moi,ema,fax,add,pc) then showmessage(测试注册成功); else showmessage(测试注册出错); end;4.1.2.短信发送 procedure TForm1.Button3Click(Sender: TObject);var phone: array of pchar; sn,sms: pchar;begin setlength(phone,1); phone0:=pchar(edit10.Text); sms:=pchar(edit13.text); sn:=pchar(edit1.text); if sendsms(phone,sn,sms) then showmessage(短信发送成功) else showmessage(短信发送失败);end;4.1.3.余额查询procedure TForm1.Button5Click(Sender: TObject);var sn: pchar; rmb: real; uprice: real; temp: string;begin sn:=pchar(edit1.Text); rmb:=getBalance(sn,uprice); str(rmb:5:2,temp); edit14.Text:=temp;end;4.1.4.充值procedure TForm1.Button4Click(Sender: TObject);var sn,cn,pw: pchar;begin sn:=pchar(edit1.Text); cn:=pchar(edit11.Text); pw:=pchar(edit12.Text); if chargeup(sn,cn,pw) then showmessage(充值成功) else showmessage(充值失败);end;4.1.5.接收procedure TForm1.Button6Click(Sender: TObject);var sn,su: pchar; i: integer; s1,s2: string;begin sn:=pchar(edit1.Text); su:=getReplySM(sn,i); if sunil then begin showmessage(string(su)+ +inttostr(i) end else showmessage(没有新的消息);end;4.1.6 定时间发送procedure TForm1.Button7Click(Sender: TObject);var Phone: array of PChar; sms,SN,Time: PChar; s1: string;begin SetLength(Phone, 1); Phone0:=PChar(edit19.Text); sms:=PChar(edit18.Text); SN:=PChar(edit1.Text); Time:=PChar(2004-07-05 08:30:00); if SendScheduledSMS(Phone,SN,sms,Time) then showmessage(OK) else showmessage(Fail);end;4.2 通用版调用实例代码4.2.1 ASP代码注册注册注册结果： 返回首页发送即时发送发送结果： 返回首页 定时发送定时发送发送结果： 返回首页 接收接收接收结果： 返回首页余额余额当前余额是：元 返回首页单条价格价格当前价格是：元/条 返回首页 充值存值存值结果： 返回首页申请转接服务申请转接服务申请结果： 返回首页申请转接服务注销转接服务注销结果： 返回首页4.2.2 VB代码函数声明 Option ExplicitPrivate Declare Function GetPriceVB Lib CustComm (ByVal sn As String) As String 价格Private Declare Function GetBalanceVB Lib CustComm (ByVal sn As String) As String 余额Private Declare Function SendSMSVB Lib CustComm (ByVal sn As String, ByVal mn As String, ByVal ct As String) As String 发送Private Declare Function SendScheSMSVB Lib CustComm (ByVal sn As String, ByVal mn As String, ByVal ct As String, ByVal ti As String) As String 定时发送Private Declare Function RegisterVB Lib CustComm (ByVal sn As String, ByVal EntName As String, ByVal LinkMan As String, ByVal Phone As String, ByVal Mobile As String, ByVal Email As String, ByVal Fax As String, ByVal sAddress As String, ByVal Postcode As String) As String 注册Private Declare Function ChargeUpVB Lib CustComm (ByVal sn As String, ByVal acco As String, ByVal pass As String) As String 存值Private Declare Function ReceiveSMSVB Lib CustComm (ByVal sn As String) As String 接收短信Private Declare Function ChangeReciveVB Lib CustComm (ByVal sn As String, ByVal mn As String) As String 申请转接服务Private Declare Function CancelChangeReciveVB Lib CustComm (ByVal sn As String, ByVal mn As String) As String 注销转接服务注册Private Sub Command1_Click() Dim result As String 这里添写软件序列号 企业名称 联系人姓名 联系电话 联系手机 电子邮件 联系传真 公司地址 邮政编码 result = RegisterVB(xxxxx-xx-xxxx-xxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx, xxxxxxxxx) If (result = 998) Or (result = ) Then MsgBox (网络故障) ElseIf (result = 999) Then MsgBox (网络故障或其它故障) ElseIf (Left(result, 1) = 0) Then MsgBox (注册失败,本软件已注册) ElseIf (Left(result, 1) = 1) Then MsgBox (注册成功 & result) Else MsgBox (未知故障) End IfEnd Sub充值Private Sub Command2_Click() Dim result As String 这里添写软件序列号卡号 密码 result = ChargeUpVB(xxxxx-xx-xxxx-xxxxx, 20037319009, 993426) If (result = 998) Or (result = ) Then MsgBox (网络故障) ElseIf (result = 999) Then MsgBox (网络故障或其它故障) ElseIf (result = 0) Then MsgBox (充值失败,本存值卡已使用) ElseIf (result = 1) Then MsgBox (充值成功) Else MsgBox (未知故障) End IfEnd Sub 查询余额Private Sub Command3_Click() 余额 Dim Myresult As String 这里添写软件序列号 Myresult = GetBalanceVB(xxxxx-xx-xxxx-xxxxx) If (Myresult = 998) Or (Myresult = ) Then MsgBox (网络故障) ElseIf (Myresult = 999) Then MsgBox (网络故障或其它故障) Else Myresult = Left(Myresult, Len(Myresult) - 1) & 元 MsgBox (Myresult) End If Text1.Text = StrConv(TempBytes, vbUni