DIY09客户端安装使用说明书文档格式.docx

DIY09客户端安装使用说明书文档格式.docx

《DIY09客户端安装使用说明书文档格式.docx》由会员分享，可在线阅读，更多相关《DIY09客户端安装使用说明书文档格式.docx（10页珍藏版）》请在冰豆网上搜索。

更改人

批准人

生效日期

备注

1

建立版本

1.0

2

解决短信性能问题

1.1

2010-2-5

1.DIY09系统体系

如上图所示，DIY09版是企业应用移动信息化接入的平台，DIY09版主要包括两大部分构成：

移动侧的企信通DIY09版统一运营服务平台、DIY09客户端。

其中客户端包括API开发包集（含短信、彩信、wappush和白名单API）、客户侧配置Portal、客户侧通讯管理模块。

本文档主要介绍如何在企业侧使用客户端，通讯过程如图：

API

如图2.1DIY09通讯全景图

2.DIY09客户端功能简介

⏹API开发包集：

包括短信API、彩信API、WappushAPI和白名单API；

⏹配置Portal：

对短信网关参数、彩信网关参数、DIY09平台参数和上行路由配置信息进行配置；

⏹通讯管理模块：

作为API与短彩信网关之间的通讯管理模块存在，对上行信息进行路由、下行流量控制以及与短信网关、彩信网关进行通讯；

3.DIY09客户端使用环境

硬件环境：

2G内存、120G硬盘、双核CPU

编译环境：

JDK1.5.0及以上

支持操作系统：

Windows2003Server、WindowsXP、Linux

4.DIY09客户端安装包

用户可以在DIY09管理平台进行下载。

下载包名称

相关功能

DIY09-Core.zip

通讯管理模块，解压缩后即可使用

JavaAPI-sms.rar

Java环境短信API包

JavaAPI-mms.rar

Java环境彩信API包

JavaAPI-wap.rar

Java环境wappushAPI包

JavaAPI-whiteList.rar

Java环境白名单API包

CAPI-sms.rar

Windows平台C环境短信API包

CAPI-mms.rar

Windows平台C环境彩信API包

CAPI-wap.rar

Windows平台C环境wappushAPI包

CAPI-whiteList.rar

Windows平台C环境白名单API包

VCAPI-sms.rar

Linux平台C环境短信API包

VCAPI-mms.rar

Linux平台C环境彩信API包

VCAPI-wap.rar

Linux平台C环境wappushAPI包

VCAPI-whiteList.rar

Linux平台C环境白名单API包

5.DIY09客户端安装步骤

（1）解压缩：

首先将DIY09-Core.tar解压缩，进入bin文件夹，相关文件描述

monitor.vbs

Windows下进程监控程序

startProxy.bat

Windows下通讯模块启动程序

stopProxy.bat

Windows下通讯模块停止程序

startPortal.bat

Windows下配置Portal启动程序

stopPortal.bat

Windows下配置Portal停止程序

monitor.sh

Linux下进程监控程序

startProxy.sh

Linux下通讯模块启动程序

stopProxy.sh

Linux下通讯模块停止程序

startPortal.sh

Linux下配置Portal启动程序

stopPortal.sh

Linux下配置Portal停止程序

（2）启动portal：

启动配置Portal后，在浏览器输入Portal地址进行登录和配置：

配置Portal登录地址：

http:

//127.0.0.1:

9080/

首次登录用户名、密码：

admin/

（3）配置Portal：

登陆后请根据配置Portal帮助和向导首先完成DIY09平台参数配置，确定与DIY09平台连接正常且登录账号配置无误后，再对短信、彩信、上行参数页面进行配置。

（4）启动Proxy：

Portal配置成功后，启动通讯模块；

（5）加载API：

将相关API引入工程，根据开发手册进行简单开发和配置文件修改即可进行通讯。

说明：

为了保证数据的正确性和系统稳定性，请保持Portal和Proxy两个进程同时存在，数据交互过程中请不要关闭两个进程。

6.A&

Q

1、使用DIY09客户端前，还需要了解哪些知识？

DIY09客户端是针对有开发能力的企业建立的一套具备通讯能力、自我监控能力、多平台应用的中间件产品，在使用该产品之前即认为企业使用者已经了解基础通讯知识。

在此不对基础知识进行描述。

2、短信、彩信账号如何获取？

请联系移动客户经理，获取短信网关、彩信网关相关配置信息，并在配置portal进行配置；

3、在使用DIY09客户端之前还应获取哪些信息？

首先必须获取DIY09平台地址及本企业接入平台的参数信息；

然后获取短信网关、彩信网关的企业接入信息；

在配置Portal进行DIY09平台参数、短信参数、彩信参数、上行参数配置后，才可以使用DIY09的所有功能；

以上信息请与北京移动联系并获取。

4、通讯过程出现问题应如何排查？

通过DIY09平台下载页面的自检测工具，进行配置。

自检测工具为：

短信模拟网关。

登录配置Portal，将“短信参数配置”页面的“企业短信网关IP地址”修改成自检测工具所在服务器地址，其它参数不需要修改。

修改完成后，重启Proxy。

如果自检测工具显示连接成功、短信下发成功等，即表示API、Porxy一切正常。

可以认为企业内部系统、DIY09客户端均运行正常。

再通过Portal将“企业短信网关IP地址”修改成网关地址，重启Proxy。

如果“运行日志”中日志显示正常，则整个链路均正常，可以进行短彩信上下行测试和正常的业务数据交互。

否则，请将日志中的错误提示信息反馈给DIY09客户侧维护人员。

相关错误提示信息说明见下表：

日志名称

日志信息

详细描述

主服务运行

日志

SP认证错误

短信网关对企业接入账号鉴权失败。

请与网关人员联系。

登陆不成功：

其它错误

短信网关对企业发送短信的服务器地址进行了绑定。

请将Proxy程序部署在与网关绑定的服务器上，并确保服务器可以telnet到网关服务器的7890端口。

短信服务日志

有AppSmsSubmitResp，但无CmppSubmitResp

企业下发的手机号码不在网关白名单里，需要将该手机号在网关进行同步。

短信连接异常

没有配置短信账号或者短信账号非法，请与移动客户经理沟通获取企业接入网关的账号信息

彩信连接异常

没有配置彩信账号

5、DIY09客户端的性能如何？

目前所有性能数据均在移动要求范围内，如果有特殊需求，请与移动客户经理进行沟通。

6、DIY09上行参数如何配置？

DIY09上行参数页面必须进行配置，DIY09客户端的通讯模块会根据该页面的配置信息对API进行接入鉴权。

相关参数请按照如下进行配置：

名称

相关描述

API登录用户名

API接入通讯管理模块（即Proxy）的登录用户名，要求六位数字，且唯一

API登录密码

API接入通讯管理模块（即Proxy）的登录密码，要求六位数字，且唯一

服务子号码

API接入通讯管理模块的业务子号码，如果移动允许在企业服务号码后面进行扩展，则该企业可以接收企业服务号码+服务子号码组成的目的号码的上行短彩信，且子号码作为路由到相关API的标识，如果移动不允许对企业服务号码进行扩展，可以使用上行指令对上行短信进行路由，详细请参见上行指令的相关描述。

要求子号码由四位数字组成，且唯一

举例：

某企业特服号码为1，移动允许其自身扩展，则用户发送12222的短信，该企业可以收到，且根据2222这四位数字进行路由判断，将短彩信上行到子号码为2222的API，即完成短彩信上行。

短彩信都可以通过该方式进行路由判断。

建议企业在移动处申请开通子号码扩展，使用子号码匹配方式进行上行短彩信路由。

上行指令

API接入通讯管理模块的上行指令，该指令作为手机用户上行短信到企业的路由标识，在用户上行的短信内容中增加该指令，通讯管理模块在收到此类短信时会匹配该上行指令，如果上行指令与某API配置的上行指令相同，则将上行信息路由到API，即完成短信上行。

彩信无法使用上行指令匹配的方式进行路由。

要求上行指令为四位字母，不区分大小写，且唯一

某企业没有申请开通子号码扩展，对于用户上行业务同样可以使用。

用户发送短信内容TQYB+相关内容，发送到企业特服号，通讯管理模块即根据TQYB对API进行判断并将该短信内容去掉匹配字符后，上行到API，即配置TQYB的API可以收到短信内容为“相关内容”的短信。

API客户端地址

要求格式：

ip:

port

业务类型

请根据不同的API进行业务类型选择。

可供选择：

短信、彩信、wappush、白名单

上行匹配规则

目前可以选择：

子号码匹配、上行指令匹配、子号码+上行指令匹配、不匹配。

选择子号码匹配后，需要根据子号码输入值进行匹配；

选择上行指令匹配，需要根据上行指令的输入值进行上行匹配；

选择子号码+上行指令，需要根据子号码和上行指令同时匹配的方式进行路由转发；

不匹配方式可以在白名单、wappush该类不需要上行的业务中进行配置

流量控制 

短彩信、wappush流量控制单位：

条/秒；

白名单流量控制单位：

秒，即每隔多少秒才允许上传一次白名单，目前移动要求两次白名单同步最少间隔20秒。

7、关于网关流量控制、Portal-短信参数设置-流量控制、Portal-上行参数配置-流量控制三者的关系和区别？

网关流量控制：

请联系移动客户经理获取网关给企业分配的流量值，该值为上行+下行的总流量控制值；

该值用于控制向网关侧提交数据的速率。

Portal-短信参数设置-流量控制：

该参数请参考“网关流量控制”，该值为下行流量控制值；

Portal-上行参数配置-流量控制：

各API的短信&

Wappush的流量值总和不允许超过“短信参数设置-流量控制”，同理，各API的彩信的流量值总和不允许超过“彩信参数设置-流量控制”；

短信网关给A企业分配流量50，“Portal-短信参数设置-流量控制”的流量请设置成20，“Portal-上行参数配置-流量控制”的多个API流量值可以设置20以内的数字，但是所有短信类型和wappush类型的流量值总和不能超过20。

【参考公式】

（1）“网关流量控制”=“Portal-短信参数设置-流量控制”*2；

（2）“Portal-短信参数设置-流量控制”=“Portal-上行参数配置-短信API1流量控制”+“Portal-上行参数配置-短信API2流量控制”+……+“Portal-上行参数配置-短信APIN流量控制”

8、技术支持热线

如果DIY09客户端出现任何问题，请先使用“自检测工具”进行排查，将排查结果通过电话反馈给技术支持人员，技术支持热线电话：

010-。

9、如何不通过指令接收上行信息

不通过指令接收上行信息有两种方案：

A、通过子号码进行标识。

当前移动对子号码的管理非常严格，一般不给与开放。

B、通过默认路由获得上行标识。

即在上行参数配置中配置一个账户，上行指令为MRLU即可。

手机终端上行信息到基本接入号将被指令为MRLU的用户接收。

配置如下图。

通过帐号即可获得不带指令的上行信息。

7．行业网关局数据申请表与portal对应关系

行业网关局数据申请表

DIY09PORTAL

企业名称

企业代码

登陆企业短信网关帐号

服务代码

短信服务号码

业务代码

短信业务代码

网关侧端口号

企业短信网关端口

网关侧IP

企业短信网关IP地址

登录网关的用户名/密码

登陆企业短信网关密码

企业IP地址（公网IP地址）

集团客户联系人

电话

E-mail

8.网关侧反馈状态报告的对应信息