BBOSS与EC文件接口V12.docx
《BBOSS与EC文件接口V12.docx》由会员分享，可在线阅读，更多相关《BBOSS与EC文件接口V12.docx（16页珍藏版）》请在冰豆网上搜索。
BBOSS与EC文件接口V12
BBOSS与EC行业应用签约信息
文件接口规范
（V1.2）
中国移动通信集团公司
二○○七年三月
1.文档介绍3
1.1.文档概述3
1.2.参考文档3
1.3.术语与定义3
2.文件接口4
2.1.文件接口的功能4
2.2.文件格式5
2.3.文件的获取6
2.4.文件校验6
2.5.行业应用签约信息文件6
2.5.1.业务流程7
2.5.2.文件格式8
2.5.3.文件的传输9
2.6.对帐9
2.6.1.文件格式10
2.6.2.文件的传输13
2.6.3.对帐文件的比对13
3.附录14
3.1.文档变更记录14
文档介绍
文档概述
本文描述了EC与BBOSS之间的行业应用签约信息文件接口。
参考文档
术语与定义
名词
描述
EC
EnterpriseCustomer/ServiceIntegrator，集团客户及业务集成商，此时集团客户一般指参与提供集团行业产品的合作伙伴。
文件接口
文件接口的功能
文件接口，使用FTP协议发送和接受文件。
具体如下：
文件名
发送方
接受方
行业应用签约信息文件
EC
BBOSS
行业应用签约信息文件
BBOSS
EC
日对帐文件
BBOSS
EC
文件格式
文件命名规则
文件命名遵循以下规则：
✧凡是BBOSS传给EC的文件名，均为BBOSS_业务描述_文件生成时间_ECID；
●文件名中的ECID表示EC编码
✧凡是EC传给BBOSS的文件名，均为ECID_业务描述_文件生成时间_BBOSS.NNN,其中NNN是文件序列号；
文件格式说明
文件是以XML格式表达的。
在本文档中以表格的形式表示XML格式；以下为表格中对元素约束（出现次数）的表示方法的描述：
元素的约束条件使用以下符号表示：
符号
含义
?
0..1，可选项
*
0..n，可以没有，也可以有多项
+
1..n，至少有1项，也可以有多项
1
数字1，代表必须且只能填1项
XML的编码方式为UTF-8。
文件的获取
EC、BBOSS应按固定频率（15分钟/次）到文件服务器的相应目录下，检查是否有新文件到达。
EC应在每日凌晨3点后，到文件服务器的相应目录下，检查是否有BBOSS的日对帐文件到达。
文件校验
文件接受方应对文件进行校验。
行业应用签约信息文件
BBOSS与EC双向发送签约信息文件，满足双方计费结算的需要。
业务流程
EC业务流程
EC在以下情况时使用本接口：
1）业务开通后，EC向BBOSS批量上传黑白名单和签约关系；
2）基于非增值服务类的个人用户通过短信（MO）主动加入白名单/退出黑名单时，由省行业网关A模块将短信直接转发给EC系统，EC审核后向BBOSS提交黑白名单
3）EC主动修改黑白名单和签约关系时，通过本接口向BBOSS提交
BBOSS业务流程
BBOSS在以下情况时使用本接口：
1）个人用户通过BOSS侧渠道（MO）退出白名单/加入黑名单或变更签约关系时，BBOSS先为用户办理，再通过本接口向EC同步相关信息；
2）用户状态发生变化，影响行业应用签约关系和黑白名单时，BBOSS通过本接口向EC同步相关信息
文件格式
文件名
●BBOSS发送给EC的文件名BBOSS_OrdSub_YYYYMMDDHHMISS_ECID
✧文件名中的YYYYMMDDHHMISS为文件生成时间，YYYY为四位年份，MMDD表示月日，HH为小时，24小时制，MI为分，SS为秒
●EC发送给BBOSS的文件名ECID_OrdSub_YYYYMMDDHHMISS_BBOSS.NNN
◆文件大小不能大于5M
◆其中NNN是文件序列号，从000至999。
每天EC发送的文件以000开始，如果当天EC发送给BBOSS的文件数大于999，则从000重新开始。
文件格式说明
根据XML的定义，每个XML文件需要有特定的RootTag（根标记），在本文件中的RootTag为“InterBOSS”.各个字段解释如下表
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
UserInfo
1
—
－
用户信息
1.1
UserInfo
BizCode
1
String
V10
业务代码
1.2
UserInfo
ProdName
?
String
V256
业务名称
1.3
UserInfo
ServCode
1
String
V21
服务代码
1.3
UserInfo
UserData
+
—
－
签约关系、黑白名单信息
1.3.1
UserData
MobNum
1
String
F11
用户手机号码
1.3.2
UserData
OprCode
1
String
F2
操作代码
01－加入名单02－退出名单
03－定购04－取消定购。
定购关系暂停，BOSS发04，定购关系恢复，BOSS发03
1.3.3
UserData
EfftT
?
String
F8
用户希望的生效时间
YYYYMMDD，如EfftT与操作编号中的日期相同，表示立即生效；否则表示在指定日期（EfftT）生效。
EfftT必须>=操作编号中的日期。
文件的传输
BBOSS和EC生成文件后，通过FTPput到文件服务器的下面目录中：
目录、FTP用户名、密码由BBOSS制定并通知EC
对帐
BBOSS每日凌晨3点向EC分别发送一次日对帐文件，日对帐文件主要核对BBOSS接收EC传送的文件的处理情况，包括正在处理的文件总数、处理成功的文件总数、处理失败的文件总数（只要有记录处理失败，即使其它记录已经正确处理，但仍然认为此文件处理失败）、处理文件的明细；同时核对由BBOSS发送给EC的文件数，文件名和每个文件的记录数。
文件格式
文件名
●发送给EC的文件名BBOSS_DRecon_YYYYMMDD_ECID
文件格式说明
根据XML的定义，每个XML文件需要有特定的RootTag（根标记），在本文件中的RootTag为“InterBOSS”.各个字段解释如下表
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
ReconDate
1
String
F8
对帐日期
YYYYMMDD
2
InterBOSS
RecInfo
＋
—
—
BBOSS接收文件明细
2.1
RecInfo
RecFileAmount
1
String
V6
接收到的文件总数
BBOSS日接收的EC传送的文件总数
如没有接收到文件填写0
2.2
RecInfo
ProcFileAmount
1
String
V6
正在处理的文件总数
如果没有正在处理的文件，填写0
2.3
RecInfo
SuccFileAmount
1
String
V6
处理成功的文件总数
如果没有处理成功的文件，填写0
2.4
RecInfo
FailFileAmount
1
String
V6
有处理失败记录的文件总数
如果没有处理失败的文件，填写0
2.5
RecInfo
FileInfo
*
—
－
处理文件明细
如果没有接收到EC传送的文件，则没有处理文件明细
2.5.1
FileInfo
FileName
1
String
V32
接收到的文件名
2.5.2
FileInfo
RecNum
1
String
V6
接收到文件的记录总数
2.5.3
FileInfo
FileState
1
String
F1
文件处理状态
1正在处理
2处理成功
3处理失败（有处理失败记录的文件）
2.5.4
FileInfo
SuccNum
1
String
V6
处理成功的记录总数
如果记录处理全部失败则此处填0
如果文件处理状态是正在处理则此处填0
2.5.5
FileInfo
FailNum
1
String
V6
处理失败的记录总数
如果记录处理全部成功则此处填0
如果文件处理状态是正在处理则此处填0
2.5.6
FileInfo
FailInfo
*
—
－
处理失败记录明细
如果处理全部成功或是正在处理则不填
如果有处理失败记录则此处必须填写失败明细
2.5.6.1
FailInfo
MobNum
1
String
F11
用户手机号码
2.5.6.2
FailInfo
Rsp
1
String
F2
失败信息
00受理成功
01操作代码错误。
02业务代码错误。
03用户无签约关系。
04生效时间错误
05用户已在白名单内
06用户不在白名单内
07用户已在黑名单内
08用户不在黑名单内
09增值业务用户，不能进行黑白名单操作
10该业务已终止
11该业务已暂停
12服务代码错误
13手机号码错误
14黑白名单用户，不能进行增值业务操作
99其它错误
2.6
RecInfo
ErrFileAmount
?
String
V6
处理失败的文件总数
文件格式错误的文件
2.7
RecInfo
ErrFileInfo
*
－
－
处理失败的文件明细
2.7.1
ErrFileInfo
ErrFileName
1
String
V32
文件名
2.7.2
ErrFileInfo
ErrFileStatus
1
String
F1
文件状态
1文件格式不正确，不是合法的XML文件
2节点缺失
3节点类型或取值错误
2.7.3
ErrFileInfo
FirstLostNode
?
String
V128
第一个缺失的节点全路径
当文件状态为2时有此节点
2.7.4
ErrFileInfo
FirstErrNode
?
String
V128
第一个节点类型或者取值错误的节点全路径
当文件状态为3时有此节点
3
InterBOSS
SendInfo
＋
—
—
BBOSS发送文件明细
3.1
SendInfo
SendFileAmount
1
String
V6
BBOSS发送到EC的文件总数
BBOSS日发送的文件总数
如没有发送文件填写0
3.2
SendInfo
SendFileInfo
*
—
－
BBOSS发送的文件列表
3.2.1
SendFileInfo
SendFileName
1
String
V32
BBOSS发送的文件名
3.2.2
SendFileInfo
SendAmount
1
String
V6
BBOSS发送文件中的记录数
文件的传输
BBOSS在每日凌晨3点，生成昨日的日对帐文件后，通过FTPput到文件服务器的下面目录中：
目录待定
对帐文件的比对
系统建设初期，使用人工方式比对，如发现差错，人工干预。
附录
文档变更记录
序号
变更内容说明
版本号
版本日期
执笔人
1
初稿
1.0
2007-3-27
王进
2
次稿
1.1
2007-7-27
王进
3
修订：
2.1中日对帐文件由BBOSS发送给EC
1.2
2007-8-20
4
修订：
2.2.1.1文件命名规则EC传送给BBOSS的文件名中增加了NNN为序列号
1.2
2007-8-20
5
修订：
2.3文件的获取，日对帐文件由EC取BBOSS发送的日对帐文件
1.2
2007-8-20
6
修订：
2.5.2.1文件名：
添加NNN文件序列号，限制文件大小不能大于5M
1.2
2007-8-20
7
修订：
2.5.2.2文件格式中节点1约束由“+”修改为“1”，即EC上传的每一个文件只能上传一个业务的数据
1.2
2007-8-20
8
修订：
2.6对帐描述进行了修改
1.2
2007-8-20
9
2.6.1.2文件格式说明进行了修改，按EC传送的黑白名单对帐到记录级的方式进行
1.2
2007-8-20
10
2.6.1.2中，2.5.6.2中失败代码更新
1.2
2007-12-27
11
2.6.1.2文件格式说明中，添加了2.5.6.2中的错误代码12和13
1.2
2008-1-10
12
2.6.1.2文件格式说明中，添加了2.6、2.7（包括2.7、2.7.1、2.7.2、2.7.3、2.7.4）节点（增加了对错误文件的处理）
1.2
2008-1-10
升级会员 