亿美短信平台SDK4.2.0(JAVA版)用户手册 下载本文

1.3.1

接口调用流程

接口调用流程如下:

执行方式 永久执行一次 运行时执行 企业注册 接口方法 需要时执行 发送短信(可以循环调用发送短信接口方法) 接收短信 修改密码 短信转发 短信转发扩展 获得版本信息 接收状态报告 查询单条费用 查询余额 短信充值 短信注销 只在当硬件信息改变时或换机器时执行

? 序列号注册

? 序列号首次使用时执行一次,类似于信用卡激活操作一样只需激活一次即可。 ? 序列号注销后再次使用时执行一次

? 序列号注销

? 序列号更换服务器前执行一次 ? 序列号停用时执行一次

? 发送短信和接受短信

? 使用前提:序列号注册完成 ? 可以多次循环使用短信接口

? 其他功能接口

? 使用前提:序列号注册完成 ? 需要时执行

5/30 页

2

2.1

数据结构说明

上行数据结构

? 所属类:MO

? 用途 保存上行短信接口函数返回的短信内容。 字段名 数据类型 String String Sting Sting Sting 说明 mobileNumber smsContent sentTime addSerial addSerialRev 手机号码 内容 发送时间(格式为yyyy-mm-dd hi24:mi:ss) 发送者附加号码(只有当发送者为满意通网络版时存在此项) 接收者附加号码(只有当接收者为满意通网络版时可能存在此项,单机版获得此项为空) 该字段用来接收上行短信的被叫号码 channelNumber String

2.2

状态报告数据结构

? 所属类:StatusReport

? 用途 保存状态报告接口函数返回的短信内容。 字段名 reportStatus Mobile submitDate receiveDate errorCode Memo serviceCodeAdd seqID 数据类型 String String Sting Sting Sting Sting Sting Long 说明 状态报告的值(0发送成功) 手机号码 发送时间(格式为yyyy-mm-dd hi24:mi:ss) 接收时间(格式为yyyy-mm-dd hi24:mi:ss) 未发送成功错误编码 备注 短信下行时服务号码 自定义唯一的消息ID,长度为不大于19位的正整数,消息流水号

6/30 页

3

3.1

功能介绍及使用

实例化客户端

? 功能简介

SDK客户端的构造方式,实例化客户端Client类后即可通过该实例调用短信发送等函数.

? 构造函数

public Client(String serialNumber, String key) throws Exception

? 参数详解 参数名称 说明 客户端序列号,必须输入 要注册的关键字,必须输入 1. 用户自定义key值, 长度不超过15个字符的字符串(可包含数字和字母) 2. 将key做好备份,不要遗忘 3. 请做好保密工作,因客户自身原因泄露该关键字造成的经济损失北京亿美软通科技有限公司不承担任何责任 serialNumber key

? 代码演示

import cn.emay.sdk.client.api.Client;

Client c = new Client(\

3.2

注册序列号

? 功能介绍

完成对序列号的注册。

? 序列号说明

(1) 软件序列号首次使用必须注册,就像信用卡首次使用必须激活一样。

(2) 软件序列号只需注册成功一次即可,注册成功后,即使重启电脑,都不需再次注册序列号。 (3) 序列号注册成功后,需记住密码并妥善保管。

(4) 试用SDK接口时,亿美提供测试序列号,并提供适当测试余额。

(5) 正式应用SDK接口时,亿美提供正式序列号,在应用时,只需重新注册一次序列号即可,其它

接口不变。

? 函数声明

public int registEx(String serialpass)

? 参数详解

7/30 页

参数名称 说明 软件序列号密码,密码(6位),必须输入 serialpass

? 代码演示

import cn.emay.sdk.client.api.Client;

? 演示结果

/**

* 测试函数 */

public void testTegistEx(){ try {

Client sdkclient=new Client(\

int i=sdkclient.registEx(\ System.out.println(\函数结果:\ } catch (Exception e) { e.printStackTrace(); } }

SDKServer:/192.168.1.67 connected ! method:THREADGROUP:收发服务线程启动 method:THREADGROUP:未发送超时监控启动 函数结果:0

? 返回值

返回值 0 10 101 305 999 描述 注册成功 客户端注册失败 客户端网络故障 服务器端返回错误,错误的返回值(返回值不是数字字符串) 操作频繁 3.3 注册企业信息

? 功能介绍

用户序列号激活以后便可以通过该接口注册自己企业的详细信息,如果要修企业的某个信息,那么可重新调用该接口

? 函数声明

public int registDetailInfo(String name, String linkMan, String phoneNum, String mobile,String email, String fax, String address, String postcode)

? 参数详解

8/30 页