当前位置:文档之家› 广东移动企信通云服务二次接口使用手册V1.0

广东移动企信通云服务二次接口使用手册V1.0

广东移动企信通云服务平台

二次接口使用手册

当前版本:Version 1.0

修改日期:2013/08

文档更新记录

目录

广东移动企信通云服务平台 (1)

二次接口使用手册 (1)

1.二次接口简介 (5)

2.二次接口接入流程 (5)

3.系统配臵 (7)

4.JA V A环境 (8)

5.客户端安装 (9)

6.启动运行 (11)

7.短信收发流程简述 (12)

8.短信接口配臵 (13)

8.1 数据库接入方式 (13)

1)发送接口 (13)

2)接收接口 (14)

8.2 文本文件接入方式 (15)

1)发送接口 (15)

2)接收接口 (16)

9.接收发送失败短信 (17)

10.已发送短信列表 (19)

11.状态报告获取 (20)

12.数据源设臵 (21)

12.1 配臵参数 (21)

12.2 ODBC配臵 (22)

12.3各数据库数据源设臵 (24)

1)ACCESS数据库 (24)

2)SQLSERVER数据库 (24)

3)ORACLE 数据库 (25)

4)DB2 数据库 (25)

5)MYSQL数据库 (25)

6)INFORMIX数据库 (26)

13.代理设臵 (26)

二次接口的常见问题及解答 (27)

1.二次接口简介

“企信通二次接口”是一种高效便携的短信发送工具。企业可以通过二次接口客户端自动、快速、稳定地发送短信,并且可以把发送和接

收短信的功能接入到企业内部应用系统中,扩展企业内办公及其他应用

系统的移动信息化功能。

2.二次接口接入流程

1)登录企信通云平台:在IE浏览器中输入企信通地址,输入企信通帐号,点击登录,成功登录企信通平台;

2)下载二次接口客户端:选择下载菜单,点击客户端下载,选择二次接口,点击下载,成功下载二次接口客户端;

3)检查本机系统环境:检查操作系统(Windows 7/XP/NT/2000/2003)、基本配臵(内存128M以上,硬盘空间430M以上)、java环境(JDK1.5版本以上),如果环境不符合要求,请先设臵好环境;

4)安装二次接口客户端:按照提示安装好二次接口客户端;(参考二次接口客户端安装文档)

5)二次接口客户端测试联调(ACCESS数据库):客户端安装完成后,配臵您的微软自带的ACCESS数据库,先发送短信以测试二次接口客户端是否可用,如果不可用,则属于二次接口自身问题;如果可用,表示二次接口可正常使用;

6)选择更改数据库类型:在二次接口可用的情况下,如果要更改数据库,选择好需要更改的数据库类型;(建议:由于无法定位用户的使用环境,二次接口程序默认是使用ACCESS数据库,但ACCESS功能不是很健全,所以不建议使用,在条件许可情况下建议sql_server或更好的数据库。)7)创建二次接口相关表结构:根据ACCESS数据库的表结构相应的在新的数据库上建立二次接入服务所需的表结构;

8)更改数据库参数配臵信息:需要更改核心数据库配臵信息的几项参数值;

DBType

JDBC_DRIVER //数据库的驱动程序类名

JDBC_URL //数据库访问的URL

JDBC_USERNAME //访问数据库的用户名

JDBC_PASSWORD //访问数据库的口令

LOCALDB_CHARACTER_ENCODE //是否需要对数据库的中文信息进行编码处理

9)更改接口客户端测试联调(新数据库):在您的目标数据库上创建相应的表(创建表的语句在安装目录的help文件夹下:《二次接口客户端SQL 脚本FOR oracle(ver_4.1).sql》文档中),数据库创建完成,先发送短信以测试二次接口客户端是否可用,如果不可用,则表示数据库连接有误,请检查数据库的连接或配臵信息是否有误;如果可用,则表示二次接口已经成功安装,可正常使用。

10)二次接口安装完成

11)现在可以介入您的系统了。

祝您好运!

<具体请查看二次接口使用手册详细内容>

3.系统配臵

操作系统:Windows 7/XP/NT/2000/2003

基本配臵:内存128M以上,硬盘空间430M以上

4.JAVA环境

本程序需要JDK 1.5版本以上运行环境。

JDK版本查看方法:在电脑桌面点击“开始”,在“运行”文本框中输入“cmd”按回车键,在DOS命令行下输入“java -version”按回车键,查看是否已经安装java及其版本。窗口内容类似如下:

如果没有达到要求,需要先安装java运行环境。可以从Oracle公司站点下载并安装JDK,下载地址:

https://www.doczj.com/doc/d61796651.html,/technetwork/java/javase/downloads/ index.html;下载后按照安装向导安装,然后在系统配臵好环境变量,如下图:

(变量值为JAVA安装路径下的bin目录)

5.客户端安装

使用企信通帐号登录企信通网站,进入“下载”-“客户端下载”页面,下载二次接口的安装程序“meip_gw.zip”到待安装的机器。

使用解压工具解压“meip_gw.zip”,在解压后的文件夹中双击“Meip2_Client_4.2.1.exe”进行安装,按向导提示默认安装,安装目录默认为c:/program files/meip/Meip2_Client_4.2.1,您可以更改为其他目录,如C:\tools\Meip2_Client_4.2.1。输入有关登录信息,提示输入用户注册信息,窗口显示如下:

在以上窗口中输入企业ID、用户ID及口令信息,企业ID是企业注册企信通后的帐号ID,可以在登录后的企信通网站右上角查到(见下图),用户ID分别是企信通帐号“@”分隔符前面的部分(如admin@mp的admin),口令则是登录企信通网站的密码。

填写以上信息后,继续点击下一步,按向导提示操作,直到安装完成。

<本文档后面部分将用表示二次接口程序的安装目录>

另外,可用文本编辑工具打开文件\conf\service.conf,在最末端修改用户ID及密码,配臵如下参数项:

client.1.EnterpriseID= #企业ID或集团编码

https://www.doczj.com/doc/d61796651.html,erID= #用户ID

client.1.Password= #用户密码

注意:如果修改后的登录方式为集团编码登录,重启服务时,需要选择登录的企业,界面如下:

6.启动运行

默认安装时会自动启动二次接口程序。通过双击桌面上企信通二次接口的快捷方式“”,也能手工启动该程序。正常启动后弹出窗口如下:

以下是二次接口短信收发流程图:

8.短信接口配臵

二次接口当前提供两种短信收发接口:文本接口和数据库接口,建议使用数据库方式。

8.1 数据库接入方式

1)发送接口

二次接口默认把所有待发送的短信息写到二次接入服务指定的核心数据库(数据源为meipapp)的dfsdl表中,该表的结构如下表所示。用户可以直接将要发送的短信写到dfsdl表中即可进行短信发送,二次接口每隔一定时间自动将已发送的短信息(status字段不为0的信息)从dfsdl表迁移到yfsdl 表中。

数据库方式发送短信时,注意必须确保以上字段中Eid,Userid,Password不为空,如果这些字段为空,则短信将不会发送。

说明:通过二次接入服务发送的短信的端口号(即用户收到短信后所见到的号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义),如10657020000203

2)接收接口

为了启动二次接入的短信接收功能,需要修改配臵文件/conf/service.conf(修改配臵后需重启二次接口)。打开该配臵文件,找到

RECEIVE_SMS_ENABLE=true

这样所有接收到的短信息存储在系统数据源meipapp对应的ACCESS 数据库中的表jsdl中。

短信接收表(jsdl,jsdl2)格式说明如下:

用户通过查询jsdl和jsdl2可以得到所有的上行的短信息。二次接入服务每隔一定时间自动将jsdl表中的status不为0信息搬移到jsdl2中。

注意:通过二次接入服务接收的短信的端口号(即用户发送短信到哪个号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义)

8.2 文本文件接入方式

1)发送接口

用户需要把发送的短信组合成一个文本文件,文件名任意,如send.txt,然后将该文件拷贝到目录\messages\企业id_用户id下。

例如:安装时输入的企业ID为mp,用户ID为admin,则把短信文件拷贝到\messages\mp_admin下。文件内容格式为139********|你好1

139********

139********|你好2

139********

接收者139********和139********接收的短信内容是:你好1

接收者139********和139********接收的短信内容是:你好2

发送完的短信在目录下\messages_bak\有保留,可作为发送记录查询。此功能仅限文件方式发送,数据库方式发送短信并不没有此保留功能。

说明:通过二次接入服务发送的短信的端口号(即用户收到短信后所见到的号码)为:服务代码(106570200002)+二次接口应用号(03)+扩展号(自定义),如10657020000203

2)接收接口

如果要将所接收到的短信息以文本文件的形式写到一个目录,则修改/conf/service.conf配臵文件如下:(修改配臵后需重启二次接口)RECEIVE_SMS_ENABLE=true

QUERY_SMS_ENABLE=true

QUERY_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}表示CURRENT TIMESTAMP

SMS_FILENAME_FORMAT={0}\\{1} //文本文件名的格式

SMS_FILECONTENT_FORMAT=\r\n{3} //文本文件内容的格式

#当文件已经存在时是否使用追加方式

SMS_FILECONTENT_APPEND=true

9.接收发送失败短信

为了启动接收发送失败短信功能,需要修改配臵文件/conf/service.conf。打开该配臵文件,找到以下配臵并按以下方式设臵: (修改配臵后需重启二次接口)

#是否启用接收发送失败短信功能

RECEIVE_SENDFAILDSMS_ENABLE=true

#接收发送失败短信线程休眠时间,单位为分钟,默认输入15分钟

RECEIVE_SENDFAILDSMS_INTERVAL=15

#接收发送失败短信后的存储方式,usedb表存储到数据库,usefile表示保存到文件,useall表示两种方式都存储

RECEIVE_SENDFAILDSMS_STORE_TYPE=usefile

一般情况下,接收发送失败的短信会保存在文件中,每收取一次则生成一个文件,没有发送失败的短信则不生成文件。文件生成的目录: /sendfailed

发送失败的短信的格式为:

134********|5555555555|2006-07-31 16:50:58|-28

134********|22222222222二次接口客户端测试|2006-07-31 16:59:01|-28

134********|有eid等一些信息|2006-07-31 16:59:02|-28

其中:

以”|”分隔

第一项为手机号码,第二项为短信内容,第三项为发送时间,第四项为失败原因

发送失败的具体原因请参考文件/短信发送失败代码与说明对照表.txt

如果希望发送失败的短信存储到数据库,则将配臵RECEIVE_SENDFAILDSMS_STORE_TYPE设臵为usedb或者useall 数据库表结构说明为(表名receivefailed):

10.已发送短信列表

当待发送短信在dfsdl处理后,迁移至yfsdl列表,用户可以在该表中查看短信的处理情况。

数据库表结构说明为(表名yfsdl):

11.状态报告获取

用户可以在statureport(短信发送状态表)中查看到短信真实的发送情况,方便用户及时了解短信发送状态。

数据库表结构说明为(表名statureport):

相关主题
相关文档 最新文档