电信企信通企业短信接口API用户手册.doc

企业短信接口客户端API用户手册 版本：V1.1 中国电信  修改记录 文件编号 版本号 拟制人/ 修改人 拟制/修改日期 更改理由 主要更改内容 （写要点即可） V1.0 元伟红 2005-10-21 拟制 V1.1 元伟红 2005-12-1 修改 将下行操作改为非阻塞式 1、概述 该文档说明了企业如何使用中国电信的企业短信客户端API程序与服务端进行对接，实现企业接口的通讯，开发增值业务应用。 该客户端 API是使用纯Java开发的，使用的JDK的版本为JDK1.4.2。所以使用该API进行开发时，要求使用的JDK版本必须是JDK1.4.2以上版本。 名词解释： Submit Message: 下行短信，指企业发送给用户的短信 Deliver Message：上行短信，指用户发送给企业的短信 Report Message：状态报告，指企业下行短信时由网关返回的路由追踪信息 Cpid：企业代码，由平台统一分配的6位数字，用于区分企业，这也是登录服务端的用户名 SpCode：服务代码，又称短信接入号，特服务，服务别名，由平台分配给您的4－6位号码，所有发送到此号码（或以此号码开头的不超过20位的号码）的消息将由服务端路由到建立连接的客户端 ServiceId：业务代码，又称计费代码，用于区分业务的代码，4-10字节，数字，字母，符号组成的字符串，为下行短信的计费依据 2、安装 该API为一jar文件，直接置于“jre/lib/ext”目录下就可以在企业自己的java程序里调用；使用JBuilder IDE开发的企业可以在Project Properties里的Paths选项里将此文件加入Requied Libraries里，可以将此文件打包进自己的应用程序里。 3、配置 客户端API需要配置一些参数才能正常使用。在平台维护人员在配置了企业相关信息后，企业可登录到电信企信通平台后台管理系统或致电平台维护人员查询配置信息。 参数配置文件格式为xml，文件名定为config.xml，使用时放置在和应用程序同级目录下的config目录里（由于程序启动时需要从此文件中初始化配置，故文件名和路径不能填错，否则程序将无法启动）。比如在linux环境下，你的程序放在/usr/local/japp/client里，那配置文件就应该在/usr/local/japp/client/config目录里。 配置文件（config.xml）如下所示： ?xml version=1.0 encoding=UTF-8? Config Server ip/ip // 服务端的IP地址，平台提供 port9598/port // 服务端口号，平台提供 /Server CpInfo user1001/user // 企业用户名，登录鉴权使用，平台提供 passwdtest/passwd // 与企业用户名对应的密码，登录鉴权使用，平台提供 conNumber2/conNumber // 连接数目，平台提供 logPathlog/logPath // api日志路径，企业自行配置 isDebugYES/isDebug // 是否开启debug功能，YES－开启，NO—关闭，企业自行配置 /CpInfo /Config 4、使用 API包提供了com.xgll.app.Application类供企业收发信息，此类以单例模式实现，以确保通信模块在进程中仅有一个实例，使用时使用其public方法getInstance()获取该模块的实例。此类同时提供了四个public方法供企业收发短信。 4．1、收取上行信息（Deliver） 方法名：getDeliver() 方法原型：public synchronized DeliverInfo getDeliver() 参数：无 返回值：DeliverInfo DeliverInfo为一信息对象，提供五条信息：终端号码、短信内容、特服号、获取时 间，Link ID此五条信息均为String类型，分别由五个公共方法获取。 * getTerminalId()方法获取终端号码，返回值类型为String * getMessageContent()方法获取信息内容，返回值类型为String * getSpCode()方法获取特服号，返回值类型为String * getGetTime()方法获取上行时间，返回值类型为String（YYYYMMDDHHMMSS） * get