亿美短信平台SDK4.2.0(JAVA版)用户手册
亿美软通短信平台SDK4.2.0（JAVA版）
用户手册
作者：北京亿美软件科技有限公司
完成日期：2010-12-13
签收人：
签收日期：
修改情况记录：
北京亿美软通科技有限公司
地址：北京市朝阳区光华路4号东方梅地亚中心C座20层（100026）
网址：https://www.wendangku.net/doc/8f17894556.html,手机快捷网址：https://www.wendangku.net/doc/8f17894556.html,
电话：010-******** 传真：010-********
售前咨询：400-810-7255 售后服务：400-779-7255
手机中文实名：亿美软通亿美移动商务
目录
用户手册 (1)
1亿美软通SDK开发说明 (3)
1.1简介 (3)
1.2背景 (3)
1.3定义 (3)
1.3.1接口调用流程 (5)
2数据结构说明 (6)
2.1上行数据结构 (6)
2.2状态报告数据结构 (6)
3功能介绍及使用 (7)
3.1实例化客户端 (7)
3.2注册序列号 (7)
3.3注册企业信息 (8)
3.4注销序列号 (10)
3.5查询单价 (10)
3.6查询余额 (11)
3.7序列号充值 (12)
3.8发送即时短信 (13)
3.9发送即时短信（带扩展号） (14)
3.10发送即时短信（带字符编码） (15)
3.11发送即时短信（带扩展号和字符编码） (16)
3.12发送即时短信（带扩展号，字符编码和短信ID） (17)
3.13发送定时短信 (19)
3.14发送定时短信（带字符编码） (20)
3.15发送定时短信（带扩展号） (21)
3.16发送定时短信（带扩展号和字符编码） (22)
3.17接收短信 (24)
3.18接收状态报告 (24)
3.19修改密码 (25)
4配置及环境要求 (26)
4.1配置日志信息 (26)
4.2查看日志 (26)
4.3客户端配置 (27)
4.4J A V A环境要求 (28)
5开发建议 (28)
5.1准备工作 (28)
5.2网络测试 (28)
5.3开发建议 (28)
5.4项目检查 (28)
6常见问题解答 (29)
6.1系统找不到指定的路径 (29)
6.2关于序列号优先级 (29)
6.3关于短信优先级 (29)
6.4余额不足时短信发送 (29)
6.5客户网络环境条件 (29)
6.6异常处理 (30)
6.7无法连接到服务器 (30)
1亿美软通SDK开发说明
1.1简介
亿美短信SDK：是针对独立软件开发商（ISV）和系统集成商（SI）的软件开发及技术产品服务的需求，提供的短信通讯开发组件（SDK，Software Development Kit)
1.2背景
系统名称：亿美SDK移动商务开发组件
项目开发者：北京亿美软通科技有限公司
1.3定义
MT Message Terminal——下行短信，即向手机终端发送短信
MO Message Original——上行短信，即手机用户向特服号码发送短信
企业特服号码由亿美为SDK用户分配的属于该用户专用的特服号码。每个
软件序列号对应一个企业特服号码。
扩展号码基于企业特服号码，企业自行扩展维护的子号码（最大15位），类似电话分机号码。
软件序列号由亿美分配给SDK用户，用来身份验证、计费的标识信息
EUCP Emay Unified Communication Platform——亿美统一通讯平台
EUCP实现了统一的接入，提供统一的服务
多运营商（中国移动、中国联通、中国网通、中国电信）的统一接入及服务提供，
只需通过一个SDK接入EUCP即可统一的与上述运营商的手机用户进行短信通讯
余额与SDK帐户即软件序列号对应的帐户余额，只有拥有足够的余额才能进行成功的短信
收发操作
KEY值默认情况下，注册序列号后，序列号会与电脑的硬件信息绑定，这样一个序列号只
能在一台定机器上使用。如果设置Key值，注册序列号后，序列号不会与电脑的硬件信息绑定，这样，一个序列号就可以在多台机器上使用（不同的电脑上设置相同的Key值即可）。
优先级发送短信时，可以定义短信的优先级别，重要的短信定义的优先级可以高一些，普通短信可以使用低一点的优先级。可以定义1-5 共5个级别的优先级，其中1为最低优先级，5为最高优先级
1.3.1接口调用流程
接口调用流程如下：
序列号注册
●序列号首次使用时执行一次，类似于信用卡激活操作一样只需激活一次即可。
●序列号注销后再次使用时执行一次
序列号注销
●序列号更换服务器前执行一次
●序列号停用时执行一次
发送短信和接受短信
●使用前提：序列号注册完成
●可以多次循环使用短信接口
其他功能接口
●使用前提：序列号注册完成
●需要时执行
2数据结构说明
2.1上行数据结构
●所属类：MO
2.2状态报告数据结构
●所属类：StatusReport
3功能介绍及使用
3.1 实例化客户端
●功能简介
SDK客户端的构造方式,实例化客户端Client类后即可通过该实例调用短信发送等函数.
●构造函数
public Client(String serialNumber, String key) throws Exception
●参数详解
●代码演示
import cn.emay.sdk.client.api.Client;
Client c = new Client("3SDK-EMS-0130-AAAAA","123456");
3.2注册序列号
●功能介绍
完成对序列号的注册。
●序列号说明
(1)软件序列号首次使用必须注册，就像信用卡首次使用必须激活一样。
(2)软件序列号只需注册成功一次即可，注册成功后，即使重启电脑，都不需再次注册序列号。
(3)序列号注册成功后，需记住密码并妥善保管。
(4)试用SDK接口时，亿美提供测试序列号，并提供适当测试余额。
(5)正式应用SDK接口时，亿美提供正式序列号，在应用时，只需重新注册一次序列号即可，其它
接口不变。
●函数声明
public int registEx(String serialpass)
●参数详解
●代码演示
i mport cn.emay.sdk.client.api.Client;
/**
* 测试函数
*/
public void testTegistEx(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int i=sdkclient.registEx("123456");
System.out.println("函数结果:"+i);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
函数结果:0
●返回值
3.3 注册企业信息
●功能介绍
用户序列号激活以后便可以通过该接口注册自己企业的详细信息，如果要修企业的某个信
息，那么可重新调用该接口
●函数声明
public int registDetailInfo(String name, String linkMan, String phoneNum, String
mobile,String email, String fax, String address, String postcode)
●参数详解
●代码演示
public void testRegistDetailInfo(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.registDetailInfo("企业名称", "联系人", "固话", "手机", "邮件
", "传真", "企业地址", "邮政编码");
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信发送结果:0
●返回值
3.4 注销序列号
●功能介绍
用户注销以后就不能再识别发送短信，接受上行短信等接口，只有重新注册以后才能重
新使用
●函数声明
public int logout()
●参数详解
无
●代码演示
public void testLogout(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.logout();
System.out.println("短信注销结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信注销结果:0
●返回值
3.5 查询单价
●功能介绍
返回一条短信的费用
●函数声明
public double getEachFee()
●参数详解
无
●代码演示
public void testGetEachFee(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
double a=sdkclient.getEachFee();
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信发送结果:0.1
●返回值
3.6 查询余额
●功能介绍
获得序列号的剩余金额
●函数声明
public double getBalance()throws Exception
●参数详解
无
●代码演示
public void testGetBalance(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
double a=sdkclient.getBalance();
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信发送结果:1427.0
3.7 序列号充值
●功能介绍
获得充值卡,可利用短信的方式进行充值
●函数声明
public int chargeUp(String cardNo,String cardPass)
●参数详解
●代码演示
public void testChargeUp(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.chargeUp("23456654646546465", "876459");
System.out.println("短信充值结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信充值结果:0
●返回值
3.8 发送即时短信
●功能介绍
短信发送函数,调用该函数会即时的下发短信，支持单发和群发。
●函数声明
public int sendSMS(String[] mobiles,String smsContent, int smsPriority)
●参数详解
●代码演示
public void testSendSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendSMS(new String[] {"138********"}, "测试内容", 3);
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信发送结果:0
●返回值
3.9 发送即时短信（带扩展号）
●功能介绍
扩展号:类似电话的分机号，它可以区分自己的某种业务代码或短信类别。
带扩展号的需要申请才可使用，其它可参考发送即时短信（3.8节）
●函数声明
public int sendSMS(String[] mobiles,String smsContent, String addSerial, int
smsPriority)
●参数详解
●代码演示
public void testSendSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendSMS(new String[] {"138********"}, "测试内容",”123456”, 3);
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●返回值
3.10 发送即时短信（带字符编码）
●功能介绍
参考发送即时短信（3.8节）
●函数声明
public int sendSMSEx(String[] mobiles,String smsContent, String srcCharset, int
smsPriority)
●参数详解
●代码演示
public void testSendSMSEx(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendSMSEx(new String[] {"138********"}, "测试内容",”GBK”, 3);
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●返回值
3.11 发送即时短信（带扩展号和字符编码）
●功能介绍
扩展号:类似电话的分机号，它可以区分自己的某种业务代码或短信类别。
带扩展号的需要申请才可使用，其它可参考发送即时短信（3.8节）
●函数声明
public int sendSMSEx(String[] mobiles,String smsContent, String addSerial, String
srcCharset,int smsPriority)
●参数详解
●代码演示
public void testSendSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendSMSEx(new String[] {"138********"}, "测试内容
",”123456”,”GBK”, 3);
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●返回值
3.12 发送即时短信（带扩展号，字符编码和短信ID）
●功能介绍
扩展号:类似电话的分机号，它可以区分自己的某种业务代码或短信类别。
带扩展号的需要申请才可使用，其它可参考发送即时短信（3.8节）
此方法可以调用（3.18节）的方法获取信息的状态报告。
●函数声明
public int sendSMSEx(String[] mobiles,String smsContent, String addSerial, String
srcCharset,int smsPriority, long smsID)
●参数详解
●代码演示
public void testSendSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendSMSEx(new String[] {"138********"}, "测试内容",”123456”,”gbk”, 3,12345678);
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●返回值
3.13 发送定时短信
●功能介绍
系统可根据自定义时间进行短信发送，该条短信会在指定的时间发送到用户的手机
号中，支持单发和群发。
●函数声明
public int sendScheduledSMS(String[] mobiles, String smsContent, String sendTime)
●参数详解
●代码演示
p ublic void testsSendScheduledSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendScheduledSMS(new String[] {"138********"}, "测试内
容", "20030101101010");
System.out.println("短信发送结果:"+a);
} catch (Exception e) {
e.printStackTrace();
}
}
●演示结果
SDKServer:/192.168.1.67 connected !
method:THREADGROUP:收发服务线程启动
method:THREADGROUP:未发送超时监控启动
短信发送结果:0
●返回值
3.14 发送定时短信（带字符编码）
●功能介绍
参考发送定时短信（3.13节）
●函数声明
public int sendScheduledSMSEx(String[] mobiles, String smsContent, String
sendTime,String srcCharset)
●参数详解
●代码演示
public void testsSendScheduledSMS(){
try {
Client sdkclient=new Client("3SDK-EMS-0130-AAAAA","123456");
int a=sdkclient.sendScheduledSMSEx(new String[] {"138********"}, "测试
内容", "20030101101010",”GBK”);
System.out.println("短信发送结果:"+a);