省BOSSADC应用接口规范ADC平台部分V25.docx

资源描述

省BOSSADC应用接口规范ADC平台部分V25.docx

《省BOSSADC应用接口规范ADC平台部分V25.docx》由会员分享，可在线阅读，更多相关《省BOSSADC应用接口规范ADC平台部分V25.docx（44页珍藏版）》请在冰点文库上搜索。

省BOSSADC应用接口规范ADC平台部分V25.docx

省BOSSADC应用接口规范ADC平台部分V25

中国移动通信有限公司

省BOSS与ADC平台

接口规范（单行本）

ADC平台部分

（V2.5）

中国移动通信集团公司

二○○六年十二月

文档变更记录

序号

变更内容说明

版本号

版本日期

执笔人

讨论稿

1.0

2006-9-20

焦求智

修订稿

1.1

2006-12-5

王进

修订稿：

在1.1的基础上重写

2.0

2006-12-11

王进

修订：

将4.3.4.2报文中14.1.1.2.5笔误的企业名称BizName改成CorpName

2.1

2007-1-24

王进

修订：

将4.1.5.2中的交易包流水号长度从32位改为30位

2.2

2007-3-26

王进

修订：

将5.4.2.2节中的文件格式与省BOSS与省行业网关的行业签约信息同步文件格式统一

2.2

2007-3-26

王进

修订：

更改5.5.2.2对帐文件格式中的描述，使之更加贴近ADC业务

2.2

2007-3-26

王进

修订：

将所有的ECID（EC企业代码）、SIID（SI企业代码）统一改为V12

2.3

2007-4-13

王进

修订：

4.3.4.2SI业务信息同步请求报文增加一个新的字段，MOAccessNum，短信上行访问码

2.4

2007-6-6

王进

修订：

4.5.4.2EC业务信息同步请求报文增加一个新的字段，MOAccessNum，短信上行访问码

2.4

2007-6-6

王进

修订：

改写4.1签约关系同步章节，增加ADC平台向BOSS同步签约关系和黑白名单部分

2.5

2007-9-18

王进

1.概述1

1.1.文档概述1

1.2.引用标准1

2.ADC业务简介1

2.1.ADC业务定义1

2.2.ADC业务特征1

2.3.ADC业务网络结构2

2.4.网元功能描述2

3.总体规范3

3.1.消息结构3

3.1.1.MessageHeader4

3.1.2.ServiceContent5

3.2.接口方式6

4.实时接口部分7

4.1.省BOSS签约关系同步7

4.1.1.业务功能7

4.1.2.业务流程7

4.1.3.业务属性8

4.1.4.业务属性9

4.1.5.交易单元9

4.1.5.1.交易属性9

4.1.5.2.交易报文10

4.2.SI信息同步12

4.2.1.业务功能12

4.2.2.业务流程12

4.2.3.业务属性13

4.2.4.交易单元13

4.2.4.1.交易属性13

4.2.4.2.交易报文14

4.3.SI业务信息同步16

4.3.1.业务功能16

4.3.2.业务流程16

4.3.3.业务属性16

4.3.4.交易单元17

4.3.4.1.交易属性17

4.3.4.2.交易报文17

4.4.EC企业信息同步18

4.4.1.业务功能18

4.4.2.业务流程19

4.4.3.业务属性19

4.4.4.交易单元19

4.4.4.1.交易属性19

4.4.4.2.交易报文20

4.5.EC业务信息同步21

4.5.1.业务功能21

4.5.2.业务流程21

4.5.3.业务属性22

4.5.4.交易单元22

4.5.4.1.交易属性22

4.5.4.2.交易报文22

5.文件接口1

5.1.文件的发送和获取1

5.2.文件校验1

5.3.文件命名规范1

5.4.EC业务受理文件接口2

5.4.1.业务流程2

5.4.2.文件格式3

5.4.2.1.文件命名规范3

5.4.2.2.文件格式说明3

5.5.对帐5

5.5.1.文件的传输5

5.5.2.文件格式5

5.5.2.1.文件命名规范5

5.5.2.2.文件格式说明5

5.5.3.文件的传输6

5.5.4.对帐文件的比对6

1.概述

1.1.文档概述

本文从ADC平台的立场描述了ADC平台与省BOSS间的接口，包括业务功能、流程和接口报文格式。

1.2.引用标准

[1]中国移动通信集团公司《省BOSS与业务管理平台（业务平台）接口规范（暂行）》（V1.1.0）

[2]中国移动通信集团公司《全网行业应用业务规范》

[3]中国移动通信集团公司《中国移动一级BOSS系统接口规范-全网行业应用-SMS业务单行本-IAGW-M部分2.0.0》

[4]中国移动通信集团公司《中国移动一级BOSS系统接口规范V1.4.5》

[5]中国移动通信集团公司《省行业网关开发全网行业应用总体技术要求－报批稿》

[6]中国移动通信集团公司《省BOSS与省行业网关接口规范1.1.2》

2.ADC业务简介

2.1.ADC业务定义

ADC（ApplicationDataCenter）：

指中国移动为集团客户（主要为中小企业客户）按需提供基于移动终端的托管式的信息化应用服务。

ADC按照内容、应用与服务的不同面向集团客户收取不同的功能费。

2.2.ADC业务特征

1、基于移动终端的应用托管。

用户可以通过短信、彩信、WAP、语音等移动通信方式使用ADC中托管的各种应用。

2、采用“变卖为租”的服务模式，集团客户可以通过租用的方式使用ADC中的各种应用。

3、针对中小企业资金少，人才缺，变化快的现状及特点，为中小企业客户提供综合的“一站式”解决方案和全面的信息化技术支持。

4、中小企业“即开即用”无需进行平台设备投资，仅需按照应用与服务的不同交纳功能费。

5、提供灵活的自服务门户，集团客户及集团个人用户均可通过门户进行信息管理。

6、各省ADC中托管的应用能够服务全网集团个人用户；

7、使用ADC业务的集团客户必须在ADC所在省BOSS开通集团客户帐号。

2.3.ADC业务网络结构

2.4.网元功能描述

◆行业网关：

提供通信、鉴权和计费能力。

●行业网关提供通信能力，包括短信，彩信、IVR等，ADC中的SI应用系统通过行业网关接入到移动通信网络中，获得通信能力。

现阶段，对于行业网关不具备的通信能力，暂由相关网元实现。

●行业网关的M模块负责通信接续过程中的业务鉴权。

●行业网关产生原始使用话单，送给BOSS。

◆ADC平台：

●提供ADC业务使用门户：

即为集团客户门户中的ADC业务专区，客户登录集团客户统一门户，通过SSO方式可以访问到ADC平台，供SI、集团客户和运营商管理员通过WWW方式进行自服务以及使用业务。

●提供业务配置功能：

对SI及其应用、集团客户、集团个人用户等进行统一配置管理；

●提供移动支持能力：

提供终端管理、WAP页面终端适配功能；

●提供业务鉴权：

对于行业网关不具备鉴权能力的应用进行统一的鉴权，如：

基于客户端应用的业务鉴权等。

◆SI应用系统：

提供各种集团业务。

◆支撑系统：

包括BOSS和网管。

●BOSS系统与ADC配合，完成客户管理、业务受理、计费结算、帐务功能、客服管理、SI准入和SI业务准入管理。

●实现集团客户统一门户；

●客户数据由BOSS负责维护、业务受理从BOSS入口，由BOSS产生定购关系并同步给行业网关和ADC平台；

●计费信息由行业网关、BOSS、ADC平台以及相关网关产生；

●帐务处理在BOSS进行；

●客服系统与ADC配合，完成客服功能；

●实现SI准入和SI业务准入管理功能。

●网管系统通过网管接口完成网管功能。

3.总体规范

总体规范定义传输协议、报文头消息结构，具体如下

3.1.消息结构

交易消息（包括请求和应答）是以XML格式表达的，包括两个部分：

MessageHeader（消息头）与ServiceContent（交易业务内容）。

其中，MessageHeader用于存储交易请求以及应答的公共部分和消息的控制数据，而ServiceContent作为MessageHeader的最后一个Element（元素），包含交易请求和应答的业务数据。

在本文档中以表格的形式表示XML格式，以下为表格中对元素约束（出现次数）的表示方法的描述：

符号

含义

0..1，可选项

0..n，可以没有，也可以有多项

1..n，至少有1项，也可以有多项

数字1，代表必须且只能填1项

另外，报文格式中“F”指固定长度，“V”表示变长。

3.1.1.MessageHeader

根据XML的定义，每个XML文件需要有特定的RootTag（根标记），在MessageHeader的RootTag为“ProvBOSS”。

各个字段解释如下表。

序号

父元素名称

元素名称

约束

类型

长度

描述

取值说明

ProvBOSS

BIPCode

String

业务功能代码

ProvBOSS

BIPVer

String

业务流程版本号

0100;对于同一交易应答与请求版本号始终一致

ProvBOSS

ActivityCode

String

交易代码

ProvBOSS

ActionCode

String

交易动作代码

0：

请求，1：

应答

ProvBOSS

ProcID

String

V30

业务流水号

发起方填写的包含此交易业务的流水号

ProvBOSS

TransIDO

String

V30

发起方交易流水号

在发起方唯一标识一个交易的流水号，系统内唯一

ProvBOSS

TransIDH

String

V30

落地方交易流水号

请求中不填，由落地方在应答中填，系统内唯一

ProvBOSS

ProcessTime

String

处理时间

发起方发起请求的时间/应答方处理请求的时间

YYYYMMDDHHMMSS

ProvBOSS

Response

—

－

应答/错误信息

请求中不填，应答中填

9.1

Response

RspType

String

应答/错误类型

应答或错误类型

9.2

Response

RspCode

String

应答/错误代码

应答或错误代码

9.3

Response

RspDesc

String

V128

应答/错误描述

应答或错误描述

ProvBOSS

TestFlag

String

测试标记

发起方填写，0：

非测试交易，1：

测试交易；测试必须是业务级别，即在同一个业务流水中所有交易必须具有相同的测试标记

ProvBOSS

MsgSender

String

消息发送方代码

发起消息的应用系统代码。

ProvBOSS

MsgReceiver

String

消息直接接收方代码

消息直接接收方应用系统代码。

ProvBOSS

SvcConVer

String

业务内容报文的版本号

0100，对于同一交易应答与请求版本号始终一致

ProvBOSS

SvcCont

String

—

请求/应答内容

XML格式的字符串，以CDATA区表达

3.1.2.ServiceContent

ServiceContent为交易请求以及应答的内容，以XML格式存储，在交易报文传输时作为MessageHeader的一个元素“SvcCont”和Header一起传输。

为了方便各个交易实体处理和校验SeriviceContent，在此元素中以常量（包含XMLTAG）即CDATA形式存在。

另外由于Header中包含ServiceContent中的公共部分内容如应答码等，在有些交易的请求或者应答报文中的ServiceContent可能为空，对于存储转发类交易，其应答的ServiceContent为空。

3.2.接口方式

接口协议使用HTTP协议，落地方为发起方提供访问的URL，发起方使用HTTPPOST方法发送请求报文并得到应答报文，发起方作为落地方的HTTP客户端，落地方作为发起方的HTTP服务器。

因此，各个参与方需要同时实现HTTP客户端以及服务器的功能。

需要说明的是，在HTTP传输过程中，HTTPHeader部分需要遵循下面的约定

content-type=application/x-www-form-urlencoded；

HTTPBody部分需要遵循下面的约定，即BOSS发送给平台时Body为$xml=报文内容，平台发送给BOSS时，Body为xml=报文内容。

在应答报文中，Body为报文内容，即直接回XML报文，不加前缀。

4.实时接口部分

4.1.签约关系同步

4.1.1.业务功能

所谓签约关系同步就是指：

当客户个人请求变化签约关系，或者客户在BOSS系统用户状态的变化导致其行业应用签约关系发生变化时，省BOSS与省行业网关、ADC业务平台之间同步签约关系的过程。

对于由EC上传的批量用户签约关系，引发的签约关系同步，使用文件接口，见第5章相关部分。

导致个人客户签约关系变化的原因，有以下几种：

A）个人用户通过10086、营业厅、大客户经理申请或变更签约关系、黑白名单；

B）BOSS系统用户状态发生变化，影响行业应用签约关系和黑白名单

C）基于非增值服务类的个人用户通过短信主动加入/退出黑白名单。

白名单是指EC/SI可以下发短信/彩信的手机号码组，黑名单是指EC/SI不能够下发短信/彩信的手机号码组。

非增值服务采用黑白名单控制方式。

黑白名单的设置具体到业务，与业务代码相对应；

D）通过ADC平台变更黑白名单和签约关系

对于A）和B），由省BOSS向各相关平台发起签约关系同步。

对于C），如果是加入黑名单/退出白名单，则由省行业网关同步给BOSS系统，BOSS再同步给ADC平台；如果是加入白名单/退出黑名单，则由省行业网关A模块转发给SI系统，SI系统直接向省BOSS提交签约关系，省BOSS确认后再同步给省行业网关-M模块和ADC平台。

对于D），由ADC平台向省BOSS发起签约关系同步。

综上所述，签约关系和黑白名单是省BOSS与ADC平台之间的双向同步。

4.1.2.业务流程

签约关系同步流程由一对同步、确认交易组成。

每个同步、确认交易的落地方都要返回一个应答消息（SvcCont为空）。

在同步交易请求报文中，发起方为每个变更操作赋予一个操作序号，落地方在确认交易中回答每个操作的处理结果。

发起方发送签约关系同步请求消息后，如果超时没有收到落地方的应答，应自动重发，在重发指定的次数后落地方还没有返回确认应答，则写错误日志，并结束本次发送，对没有成功同步的信息，在下一次同步的时候再次同步。

报文发送方与报文接受方应约定报文大小（例如单个报文不超过128K）和发送频率（例如1秒1个），以免ADC平台被过量交易报文堵塞。

4.1.2.1.省BOSS向ADC平台同步签约关系流程

流程触发条件：

当省公司受理集团业务请求或者是省公司客服系统收到个人用户请求时，省BOSS受理后向ADC平台发出操作指令。

当业务签约用户的用户状态发生改变时，省BOSS向各相关平台发出操作指令：

A）当用户状态从正常变为停机、销户、过户、改号、欠费停机或停机保号、预销户时，省BOSS向ADC平台发送将该用户退出白名单的指令；

B）用户状态从停机、预销户变为正常时，省BOSS向ADC平台发送将该用户加入白名单的信息，如果用户定购了增值业务，则省BOSS向除省行业网关的其他平台发送定购指令。

4.1.2.2.ADC平台向省BOSS同步签约关系流程

4.1.3.业务属性

从业务流程可以看出，省BOSS与ADC业务平台之间的签约关系同步，与省BOSS和省行业网关之间的签约关系同步是相同的，所以接口报文以及业务代码、应答码沿用《省BOSS与省行业网关接口规范》。

以下定义（4.1.3节–4.1.5节）来自《省BOSS与省行业网关接口规范1.1.2》

4.1.4.业务属性

省BOSS向ADC平台同步签约关系：

BIP2B732

手续费

不收手续费

服务费

不收服务费

安全性要求

无

对帐

参与对帐

ADC平台向省BOSS同步签约关系：

BIP2B733

手续费

不收手续费

服务费

不收服务费

安全性要求

无

对帐

参与对帐

4.1.5.交易单元

签约关系同步业务所使用的交易单元如下表所示。

序号

交易名称

步骤

功能说明

备注

签约关系同步

省BOSS向ADC平台同步黑白名单、签约关系

ADC平台向省BOSS同步黑白名单、签约关系

签约关系同步确认

ADC平台将处理结果告知省BOSS

省BOSS将处理结果告知ADC平台

4.1.5.1.交易属性

签约关系同步：

T2101708

名称

取值

交易类型

10：

通知类流程

对帐标记

1：

参与对帐

安全性：

密码加密

0：

不需要

安全性：

防篡改

0：

不需要

交易发起方代码

BOSS/PADC

交易落地方代码

PADC/BOSS

签约关系同步确认：

T2101709

名称

取值

交易类型

10：

通知类流程

对帐标记

1：

参与对帐

安全性：

密码加密

0：

不需要

安全性：

防篡改

0：

不需要

交易发起方代码

PADC/BOSS

交易落地方代码

BOSS/PADC

4.1.5.2.交易报文

报文分为报文头（MessageHeader）和报文体（ServiceContent）两部分，关于报文头的内容及格式参见3.1.1节中公共报文头的描述。

在此只描述报文体部分。

签约关系同步交易

（1）请求SvcCont：

序号

父元素名称

元素名称

约束

类型

宽度

描述

取值说明

ProvBOSS

SvcCont

String

—

请求内容

XML格式的字符串，以CDATA区表达

14.1

SvcCont

BizRegReq

—

业务受理请求

14.1.1

BizRegReq

PkgSeq

String

V30

发起方交易包流水号

发起方保证唯一，以便落地方应答

14.1.2

BizRegReq

UReg

用户数据

每个用户一组数据

14.1.2.1

Ureg

MobNum

String

F11

用户手机号码

14.1.2.2

Ureg

OprNumb

String

V17

本次操作的流水

操作编号规则见注1

14.1.2.3

Ureg

OprCode

String

操作代码

01－加入名单02－退出名单

03－定购04－取消定购。

14.1.2.4

Ureg

EfftT

String

用户希望的生效时间

YYYYMMDD，如EfftT与操作编号中的日期相同，表示立即生效；否则表示在指定日期（EfftT）生效。

EfftT必须>=操作编号中的日期。

14.1.2.5

Ureg

BizCode

String

V32

业务代码

注1：

发起方操作时间YYYYMMDDHH24MMSS（14位）+流水号（变长3位），序号从1开始，增量步长为1，如例：

省BOSS2006年10月1日10点10分15秒第一笔发往省ADC平台的请求，操作编号200610011010151。

这是一个对操作动作的编号，将此编号与手机号码结合，可以唯一确定一个用户的某次操作。

（2）应答SvcCont：

无

签约关系同步确认交易

（1）请求SvcCont：

序号

父元素名称

元素名称

约束

类型

宽度

描述

取值说明

ProvBOSS

SvcCont

String

—

请求内容

XML格式的字符串，以CDATA区表达

14.1

SvcCont

BizRegRsp

—

业务受理请求

14.1.1

BizRegRsp

PkgSeq1

String

V30

落地方的交易包流水号

保证唯一，以便将来对帐

14.1.2

BizRegRsp

Rslt

操作应答

每个操作编号一个应答

14.1.2.1

Rslt

MobNum

String

F11

用户手机号码

14.1.2.2

Rslt

OprNumb

String

V17

发起方操作的流水

来自于签约关系同步交易包中的操作流水

14.1.2.3

Rslt

RspCode

String

处理结果

见下面的错误编码表

错误编码表

错误编码

描述

受理成功

操作代码错误。

业务代码错误。

用户无签约关系。

生效时间错误

用户已在白名单内

用户不在白名单内

用户已在黑名单内

用户不在黑名单内

增值业务用户，不能进行黑白名单操作

落地方内部错误

其它错误，由落地方自行解释。

（2）应答SvcCont：

无

4.2.SI信息同步

4.2.1.业务功能

省BOSS向ADC平台准实时同步本省SI信息。

4.2.2.业务流程

本接口的流程为图中的4、5。

发起方发送请求消息后，如果超时没有收到落地方的应答，应自动重发，在重发指定的次数后落地方还没有返回确认应答，则写错误日志，并结束本次发送，对没有成功同步的信息，在下一次同步的时候再次同步。

省BOSS（报文发送方）与ADC平台（报文接受方）应约定报文大小（例如单个报文不超过128K）和发送频率（例如1秒1个），以免ADC平台被过量交易报文堵塞。

4.2.3.业务属性

省BOSS向ADC平台同步SI信息：

BIP4B726

手续费

不收手续费

服务费

不收服务费

安全性要求

无

对帐

参与对帐

关键交易

无

4.2.4.交易单元

4.2.4.1.交易属性

1、省BOSS向ADC平台同步SI信息

交易编码：

T4101702

名称

取值

交易类型

10：

通知类流程

对帐标记

1：

参与对帐

安全性：

密码加密

0：

不需要

安全性：

防篡改

0：

不需要

交易发起方代码

BOSS

交易落地方代码

PADC

4.2.4.2.交易报文

报文分为报文头（MessageHeader）和报文体（ServiceContent）两部分，关于报文头的内容及格式参见3.1.1节中公共报文头的描述。

在此只描述报文体部

展开阅读全文