广东移动企信通云服务平台二次接口使用手册

广东移动企信通云服务平台二次接口使用手册当前版本:Version1.
0修改日期:2012/07广东移动企信通云服务平台二次接口使用手册文档更新记录版本号更新日期更新内容更新人V1.
02012/07创建初始版本广东移动企信通云服务平台二次接口使用手册目录广东移动企信通云服务平台1二次接口使用手册11.
二次接口简介.
52.
系统配置.
53.
JAVA环境.
54.
客户端安装.
65.
启动运行.
76.
短信接口配置.
86.
1数据库接入方式.
81)发送接口.
82)接收接口.
106.
2文本文件接入方式.
111)发送接口.
112)接收接口.
127.
接收发送失败短信.
138.
数据源设置.
158.
1配置参数.
158.
2ODBC配置.
158.
3各数据库数据源设置.
171)ACCESS数据库18广东移动企信通云服务平台二次接口使用手册2)SQLSERVER数据库.
183)ORACLE数据库.
184)DB2数据库.
195)MYSQL数据库.
196)INFORMIX数据库.
199.
代理设置.
20广东移动企信通云服务平台二次接口使用手册1.
二次接口简介"企信通二次接口"是一种高效便携的短信发送工具.
企业可以通过二次接口客户端自动、快速、稳定地发送短信,并且可以把发送和接收短信的功能接入到企业内部应用系统中,扩展企业内办公及其他应用系统的移动信息化功能.
2.
系统配置操作系统:Windows7/XP/NT/2000/2003基本配置:内存128M以上,硬盘空间50M以上3.
JAVA环境本程序需要JDK1.
4版本以上运行环境.
JDK版本查看方法:在电脑桌面点击"开始",在"运行"文本框中输入"cmd"按回车键,在DOS命令行下输入"java-version"按回车键,查看是否已经安装java及其版本.
窗口内容类似如下:若无java运行环境,可以从Oracle公司站点下载并安装JDK,下载地址:广东移动企信通云服务平台二次接口使用手册http://www.
oracle.
com/technetwork/java/javase/downloads/index.
html;下载后按照安装向导安装,然后在系统配置好环境变量,如下图:(变量值为JAVA安装路径下的bin目录)4.
客户端安装使用企信通账号登录企信通网站,进入"下载"-"客户端下载"页面,下载二次接口的安装程序"meip_gw.
zip"到待安装的机器.
使用解压工具解压"meip_gw.
zip",在解压后的文件夹中双击"Meip2_Client_3.
4.
1.
exe"进行安装,按向导提示默认安装,之后会提示广东移动企信通云服务平台二次接口使用手册输入用户注册信息,窗口显示如下:在以上窗口中输入企业ID、用户ID及口令信息,企业ID是企业注册企信通后的账号ID,可以在登录后的企信通网站右上角查到(见下图),用户ID分别是企信通账号"@"分隔符前面的部分(如admin@mp的admin),口令则是登录企信通网站的密码.
填写以上信息后,继续点击下一步,按向导提示操作,直到安装完成.
本文档后面部分将用表示二次接口程序的安装目录.
5.
启动运行默认安装时会自动启动二次接口程序.
通过双击桌面上企信通二次接口广东移动企信通云服务平台二次接口使用手册的快捷方式"",也能手工启动该程序.
正常启动后弹出窗口如下:6.
短信接口配置二次接口当前提供两种短信收发接口:文本接口和数据库接口,建议使用数据库方式.
6.
1数据库接入方式1)发送接口二次接口默认把所有待发送的短信息写到二次接入服务指定的核心数据库(数据源为meipapp)的dfsdl表中,该表的结构如下表所示.
用户可以直接将要发送的短信写到dfsdl表中即可进行短信发送,二次接口每隔一定时间自动将已发送的短信息(status字段不为0的信息)从dfsdl表迁移到yfsdl表中.
广东移动企信通云服务平台二次接口使用手册列名类型描述备注Id整数短信标识该字段在dfsdl表中不允许重复,在yfsdl中允许重复Mobile字符串目标手机号码长度至多为15Content字符串短信内容长度至多为255Deadtime日期时间信息有效时间截至到…Status整数信息状态0:未处理,1:已处理,其他表示处理失败Eid字符串发送信息所属企业ID号长度至多50Userid字符串发送信息的用户ID号长度至多50Password字符串发送信息的用户密码长度至多50Userport字符串端口扩展号不能超过4位数字msgid整数发送组ID,白名单校验用,不能为空值,每次发送的内容不相同时不能重复数据库方式发送短信时,注意必须确保以上字段中Eid,Userid,Password不为空,如果这些字段为空,则短信将不会发送.
说明:通过二次接入服务发送的短信的端口号(即用户收到短信后所见到广东移动企信通云服务平台二次接口使用手册的号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义),如106570200002032)接收接口为了启动二次接入的短信接收功能,需要修改配置文件/conf/service.
conf(修改配置后需重启二次接口).
打开该配置文件,找到RECEIVE_SMS_ENABLE=true这样所有接收到的短信息存储在系统数据源meipapp对应的ACCESS数据库中的表jsdl中.
短信接收表(jsdl,jsdl2)格式说明如下:列名类型描述备注Id整数短信标识该字段在jsdl表中不允许重复,在jsdl2中允许重复Mobile字符串上行手机号码长度至少为15Content字符串上行短信内容长度至少为140Recetime日期时间信息发送时间Status整数信息状态0:未处理,1:已处理,其他表示处理失败Eid字符串上行信息所属企业编号长度至少20广东移动企信通云服务平台二次接口使用手册Userid字符串发送信息的用户ID号长度至多50Password字符串发送信息的用户密码长度至多50用户通过查询jsdl和jsdl2可以得到所有的上行的短信息.
二次接入服务每隔一定时间自动将jsdl表中的status不为0信息搬移到jsdl2中.
注意:通过二次接入服务接收的短信的端口号(即用户发送短信到哪个号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义)6.
2文本文件接入方式1)发送接口用户需要把发送的短信组合成一个文本文件,文件名任意,如send.
txt,然后将该文件拷贝到目录\messages\企业id_用户id下.
例如:安装时输入的企业ID为mp,用户ID为admin,则把短信文件拷贝到\messages\mp_admin下.
文件内容格式为13900000000|你好11390000000113911111111|你好213911111112接收者13900000000和13900000001接收的短信内容是:你好1接收者13911111111和13911111112接收的短信内容是:你好2发送完的短信在目录下\messages_bak\有保留,可作为发送广东移动企信通云服务平台二次接口使用手册记录查询.
此功能仅限文件方式发送,数据库方式发送短信并不没有此保留功能.
说明:通过二次接入服务发送的短信的端口号(即用户收到短信后所见到的号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义),如106570200002032)接收接口如果要将所接收到的短信息以文本文件的形式写到一个目录,则修改/conf/service.
conf配置文件如下:(修改配置后需重启二次接口)RECEIVE_SMS_ENABLE=trueQUERY_SMS_ENABLE=trueQUERY_SMS_HANDLER=com.
creawor.
meip2.
sms.
FileSmsReceivedHandler重新启动二次接口后,所接收到的短信息将默认写到[MEIP2]/receives目录下,具体的文本文件的格式用户可以自定义设置,主要涉及/conf/service.
conf中的如下字段:#文本格式接收短信所存放的目录RECEIVE_SMS_DIRECTORY=receives#{0}表示EID#{1}表示MOBILE#{2}表示TIME#{3}表示CONTENT广东移动企信通云服务平台二次接口使用手册#{4}表示CURRENTTIMESTAMPSMS_FILENAME_FORMAT={0}\\{1}//文本文件名的格式SMS_FILECONTENT_FORMAT=\r\n{3}//文本文件内容的格式#当文件已经存在时是否使用追加方式SMS_FILECONTENT_APPEND=true7.
接收发送失败短信为了启动接收发送失败短信功能,需要修改配置文件/conf/service.
conf.
打开该配置文件,找到以下配置并按以下方式设置:(修改配置后需重启二次接口)#是否启用接收发送失败短信功能RECEIVE_SENDFAILDSMS_ENABLE=true#接收发送失败短信线程休眠时间,单位为分钟,默认输入15分钟RECEIVE_SENDFAILDSMS_INTERVAL=15#接收发送失败短信后的存储方式,usedb表存储到数据库,usefile表示保存到文件,useall表示两种方式都存储RECEIVE_SENDFAILDSMS_STORE_TYPE=usefile一般情况下,接收发送失败的短信会保存在文件中,每收取一次则生成一个文件,没有发送失败的短信则不生成文件.
文件生成的目录:/sendfailed发送失败的短信的格式为:13450647954|5555555555|2006-07-3116:50:58|-28广东移动企信通云服务平台二次接口使用手册13450647954|22222222222二次接口客户端测试|2006-07-3116:59:01|-2813450647954|有eid等一些信息|2006-07-3116:59:02|-28其中:以"|"分隔第一项为手机号码,第二项为短信内容,第三项为发送时间,第四项为失败原因发送失败的具体原因请参考文件/短信发送失败代码与说明对照表.
txt如果希望发送失败的短信存储到数据库,则将配置RECEIVE_SENDFAILDSMS_STORE_TYPE设置为usedb或者useall数据库表结构说明为(表名receivefailed):列名类型描述备注fmobile字符串手机号码长度至多20fcontent字符串短信内容长度至多250fsendtime日期时间发送时间fstate字符串失败原因长度至多5remark字符串保留长度至多50广东移动企信通云服务平台二次接口使用手册8.
数据源设置建议:由于无法定位用户的使用环境,二次接口程序默认是使用ACCESS数据库,但ACCESS功能不是很健全,所以不建议使用,在条件许可情况下建议sql_server或更好的数据库.
8.
1配置参数二次接入服务的核心数据库配置信息在文件/conf/service.
conf中的如下几项参数中DBTypeJDBC_DRIVER//数据库的驱动程序类名JDBC_URL//数据库访问的URLJDBC_USERNAME//访问数据库的用户名JDBC_PASSWORD//访问数据库的口令LOCALDB_CHARACTER_ENCODE//是否需要对数据库的中文信息进行编码处理通过更改这些信息可以将核心数据库移动到各种类型的数据库中,下面将列出对几种常用的数据库的配置信息.
接入二次接口的应用系统可以对照/db/meip2.
mdb这个access数据库的表结构相应的在不同的数据库上建立二次接入服务所需的四个表结构.
8.
2ODBC配置以sql_server数据库配置为例,说明配置方法.
打开"控制面板"—"管理工具"—"数据源(ODBC)",如下图广东移动企信通云服务平台二次接口使用手册选择"添加"后,选择其中一项"SQLServer",点击完成填写以下内容,如下图:广东移动企信通云服务平台二次接口使用手册选择你连接的数据库库名,下一步直至完成即可.
8.
3各数据库数据源设置以下数据源配置部分需要JDBC驱动包支持,配置仅供参考,具体配置请以实际情况为准.
广东移动企信通云服务平台二次接口使用手册1)ACCESS数据库DBType=AccessJDBC_DRIVER=sun.
jdbc.
odbc.
JdbcOdbcDriverJDBC_URL=jdbc:odbc:meipappJDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]2)SQLSERVER数据库DBType=MSSQLJDBC_DRIVER=com.
microsoft.
sqlserver.
jdbc.
SQLServerDriverJDBC_URL=jdbc:sqlserver://[HOST]:1433;databasename=[DB]JDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]3)ORACLE数据库DBType=OracleJDBC_DRIVER=oracle.
jdbc.
driver.
OracleDriverJDBC_URL=jdbc:oracle:thin:@[HOST]:1521:[DB]JDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]广东移动企信通云服务平台二次接口使用手册4)DB2数据库DBType=DB2JDBC_DRIVER=COM.
ibm.
db2.
jdbc.
net.
DB2DriverJDBC_URL=jdbc:db2//[HOST]:50000/[DB]JDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]5)MYSQL数据库DBType=MYSQLJDBC_DRIVER=com.
mysql.
jdbc.
DriverJDBC_URL=jdbc:mysql://[HOST]:3306/[DB]JDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]6)INFORMIX数据库DBType=INFORMIXJDBC_DRIVER=com.
informix.
jdbc.
IfxDriverJDBC_URL=jdbc:informix-sqli://[HOST]:1526/[DB]:INFORMIXSERVER=[INF]JDBC_USERNAME=[USER]JDBC_PASSWORD=[PASSWORD]广东移动企信通云服务平台二次接口使用手册9.
代理设置如果您的电脑是使用代理进行上网,则需要配置代理服务器信息;用文本编辑工具打开文件\conf\service.
conf,配置如下参数项:useProxy=true#是否需要使用代理服务器(true/false)authProxy=true#是否需要代理服务器验证(true/false)proxyUrl=#代理服务器地址proxyAddress=#代理服务器ipproxyPort=#代理服务器端口authUser=#用户authPwd=#密码完成以上配置后,重启二次接口即可.