📄 manual.txt
字号:
Etot API 使用说明
======
Java版 Etot API 1.0 release
----------------------------
安装
------------
1:将安装盘中的etot_api目录拷贝到任意路径.
2:修改环境变量CLASSPATH,确认包含etot_api目录所在的完整路径.
例如:
CLASSPATH=E:\package\twinbays\etot_api;d:\oracle\ora81\orb\classes\share.zip
3:编辑etot_api/conf/xboxp.ini,填写实际的配置.
4:安装过程结束.
5:您可以编辑etot_api\com\twinbays\etot\t\XboxAPIT.java,存盘编译后,执行
java com.twinbays.etot.t.XboxAPIT send 命令,测试一下安装是否正确。
6:请注意
1)不要修改etot_api目录及下级子目录的目录名、文件名和目录结构.
2)一些jsp环境,如tomcat,在第一次使用Etot API前可能需要重新启动.
使用
------------
说明
1:Receive类
Deliver类和Result类的基类,用于接收操作.
源代码
package com.twinbays.etot ;
public class Receive
{
/*
成员变量m_bType的值用于标明是服务请求或发送结果.
0x32 标明为服务请求Deliver
0x31 标明为发送结果Result
*/
public byte m_bType ;
}
2:Deliver类
Receive类的子类,用于接收操作,封装一条服务请求的数据.
源代码
package com.twinbays.etot ;
public class Deliver extends Receive
{
/*
主叫号码
*/
public String m_strSrcNo ;
/*
GSM协议类型,用于非Nokia手机下载铃声和图片,详细解释请参考GSM03.40中的9.2.3.9
*/
public byte m_bTpUid ;
/*
GSM协议类型,用于非Nokia手机下载铃声和图片,详细解释请参考GSM03.40中的9.2.3.23
*/
public byte m_bTpUdhi ;
/*
服务请求的编码,0为ASCII,4为Binary,15为GBK
*/
public byte m_bEncoded ;
/*
服务请求内容的长度
*/
public int m_nMsgLength ;
/*
服务请求的内容,用户可自行转换为字符串或2进制对象
*/
public byte[] m_abMsg ;
}
3:result
Receive类的子类,用于接收操作,封装一条发送结果的数据.
源代码
package com.twinbays.etot ;
public class Result extends Receive
{
/*
对应SendSMS调用的返回值,或SendBatchSMS调用返回的数组元素
*/
public int m_nOid ;
/*
本次发送结果对应发送请求的已发送次数
*/
public int m_nCurrTimes ;
/*
本次发送时间,格式为YYYYMMDDhhmmss
*/
public String m_strSendTime ;
/*
发送方式,如"S"
*/
public String m_strSendMode ;
/*
被叫号码
*/
public String m_strDestNo ;
/*
发送结果状态,'S'为成功,'F'为失败
*/
public String m_strState ;
/*
付费号码
*/
public String m_strChargeNo ;
}
4:XboxAPI
入口类,提供方法用于发送一条短信到一个或多个被叫号码,或接收一条或多条Deliver和Result。
方法sendSMS,用于发送一条短信到一个被叫号码
public int sendSMS( String __strDestNo, String __strSvcType, int __nLength,
String __strContent, byte __nTpUid, byte __nTpUdhi, String __strScheduleTime,
short __nExpireTime, short __nTimes, short __nInterval, String __strChargeNo )
throws ApiInitException
入口参数:
__strDestNo 被叫手机号码,字符串,最长21字节
__strSvcType 服务类型,字符串,最长10字节
__nLength 发送内容的长度(字节数),应等于__abContent.length
__abContent 发送的内容,字节数组。
__nTpUid 通常为0,仅用于向非Nokia手机发送铃声和图片
__nTpUdhi 通常为0,仅用于向非Nokia手机发送铃声和图片
__strScheduleTime 发送时间,字符串,长度为14,格式为YYYYMMDDhhmmss,null表示立即发送
__nExpireTime 有效时间(分钟),0为使用短信中心缺省值;
__nTimes 发送次数,0无效
__nInterval 每次发送的间隔时间(分钟),0无效
__strChargeNo 付费手机号码,字符串,最长21字节;如为null或空串("")表示由被叫付费;如为"0"表示由SP付费。
返回值
整型,表示该条短消息的OID,0表示失败。
方法sendBatchSMS,用于发送一条短信到多个被叫号码
public int sendBatchSMS( String __strDestNo, String __strSvcType, int __nLength,
String __strContent, String __strScheduleTime,
short __nExpireTime, short __nTimes, short __nInterval, String __strChargeNo )
throws ApiInitException
入口参数:
__strDestNo 被叫手机号码,字符串,如有多个号码用逗号隔开
__strSvcType 服务类型,字符串,最长10字节
__nLength 发送内容的长度(字节数),应等于__abContent.length
__abContent 发送的内容,字节数组。
__strScheduleTime 发送时间,字符串,长度为14,格式为YYYYMMDDhhmmss,null表示立即发送
__nExpireTime 有效时间(分钟),0为使用短信中心缺省值;
__nTimes 发送次数,0无效
__nInterval 每次发送的间隔时间(分钟),0无效
__strChargeNo 付费手机号码,字符串,最长21字节;如为null或空串("")表示由被叫付费;如为"0"表示由SP付费。
返回值
整型数组,元素对应于每条短消息的OID.
方法RecvMsg,用于接收一条或多条Deliver和Result
public Receive[] recvMsg( byte __nMaxRecv ) throws ApiInitException
入口参数:
__nMaxRecv 最多接收Deliver和Result的条数,byte类型
返回值
Receive数组,包含Deliver和Result信息
5.ApiInitException类
异常,包含错误信息.可以调用toString()方法打印出错信息.
例子
参见etot_api\com\twinbays\etot\t\XboxAPIT.java
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -