中国电信企信通短信socket API编程接口.doc

企信通API接口说明（JAVA） esmsapi.jar包封装了企信通API的客户端协议，提供连接服务器(connect)、断开连接(disconnect)、登录(login)、退出登录(logout)、连接测试(active test)、短信发送(submit)、短信接收(deliver)等功能，并有相应的接口用于服务端应答消息的异步回调。 类EsmsClient API协议客户端 void addListener(EsmsListener listener) 增加一个Listener listener：实现EsmsListener接口，用于处理客户端的各种回调事件 void connect(String host, int port) 连接API协议服务端 host：服务端主机地址 port：服务端端口号 void disconnect() 断开连接 void update() 轮询网络事件 void login(int seq, String user, String password) 登录服务器 seq：序列号 user：用户名 password：密码 void logout(int seq) 退出登录 seq：序列号 void activeTest(int seq) 发送测试消息 void submit(int seq, String srcNum, String[] dstNums, String scheduleTime, boolean needRpt, String msgStr) 提交待发送短信 seq：序列号 srcNum：主叫号码 dstNums：接收号码，必须少于100个 scheduleTime：定时发送时间(yyyymmddhhmmss)，置为空表示为即时发送 needRpt：是否返回状态报告 0-否，1-是 msgStr：短信内容 接口EsmsListener 用于处理客户端的各种回调事件。该接口各方法的第一个参数client为产生该事件的客户端对象。 void onConnect(EsmsClient client, boolean result) 连接服务器结果 result：true表示连接成功，false表示连接失败 void onDisconnect(EsmsClient client) 连接断开 void onLoginResp(EsmsClient client, int seq, int status) 登录结果，调用Esms.login方法后产生的事件。 seq：序列号，与login方法的seq相对应 status：状态码，参见状态码列表 void onLogoutResp(EsmsClient client, int seq) 已退出登录，调用EsmsClient.logout方法后产生的事件。 seq：序列号，与logout方法的seq相对应 void onActiveTest(EsmsClient client, int seq) 收到服务器的连接测试消息。 seq：序列号 void onActiveTestResp(EsmsClient client, int seq) 发送连接测试消息后的应答，即调用EsmsClient.activeTest方法后产生的事件。 seq：序列号，与activeTest方法的seq相对应 void onSubmitResp(EsmsClient client, int seq, int status, String msgId) 提交短信的结果，即调用EsmsClient.submit方法后产生的事件。 seq：序列号，与submit方法的seq相对应 status：状态码，参见状态码列表 msgId：消息标识 void onDeliver(EsmsClient client, int seq, String svcNum, String userNum, String linkId, int moType, String msgStr) 收到上行短信或状态报告。 seq：序列号 svcNum：MO服务码 userNum：发送用户号码 linkId：业务鉴权码或发送消息标识 moType：MO类型 1-业务上行短信 93|99-短信状态报告 msgStr：上行短信或状态报告内容 交易状态码表 状态码 描述 0x00 成功 0x01 包格式错 0x02 非法UID 0x03 登录密码错 0x04 主显号码设置错误 0x05 BusiID不存在 0x06 尚未登录 0x07 时间格式错 0x08 Submit超出流量控制（待处理条数超出发送窗口容量或每秒发送量超出限制）此种情况应该稍后重发该Submit信息 0x09