流量统付EC与自服务平台接口规范.docx

资源描述

流量统付EC与自服务平台接口规范.docx

《流量统付EC与自服务平台接口规范.docx》由会员分享，可在线阅读，更多相关《流量统付EC与自服务平台接口规范.docx（107页珍藏版）》请在冰豆网上搜索。

流量统付EC与自服务平台接口规范.docx

流量统付EC与自服务平台接口规范

流量统付EC与自服务平台

接口规范

（V1.3）

2015/06/05

文档变更记

序号

变更内容说明

版本号

版本日期

执笔人

征求意见稿

1.0

2015-01-22

明确路由类型、路由关键值、应用域代码的内容

1.1

2015-02-10

修正成员订购查询流水号的长度要求和生成规则,

补充业务逻辑要求说明；

流量使用情况和成员清单文件接口只针对限量统付模式用户提供。

1.2

2015-04-15

针对自服务平台与BOSS间接口规范修订进行修改.基础业务和叠加包关系分开,允许直接调用叠加包接口.

由于BBOSS对接口元素顺序有要求，故将成员变更接口中，帐期生效规则EffRule元素改为写在UserData元素之后，保持与BBOSS间规范一致。

1.2

2015-04-21

根据与平台与BBOSS规范修订同步更新,包括:

3.1和3.3的OperSeqList节点从?

改为1，即使全部失败也生成订单，并通过这个失败订单反馈具体成员失败原因

新增EC流量统付订单查询接口3.6小节

为了应对一个平台接入多个EC，在文件接口中体现出接入机构名称,此处的机构取值均为STKP

根据业务要求，向EC反馈开通结果的返回码从F2改为V4，省公司开通失败的情况下，将省公司返回码一并反馈给EC；

所有的错误原因描述长度，统一调整为V500

增加闲时流量包编码（101-104，151），对应套餐包字段的长度从F2改为V3

增加自服务平台鉴权处理,针对3.1/3.3接口的不合规数据,自服务平台进行拦截。

对应的应答代码RspCode见附录4

文档变更记i

1.概述6

1.1.文档概述6

1.2.引用标准6

2.总体规范6

2.1.总体说明6

2.2.接口流程7

2.2.1.EC发起流量统付成员变更/成员流量叠加包订购接口流程7

2.2.2.BBOSS发起流量统付成员变更接口流程7

2.3.成员校验逻辑7

3.实时接口部分9

3.1.EC流量统付成员变更9

3.1.1.业务功能9

3.1.2.业务约定9

3.1.3.业务属性9

3.1.4.交易单元10

3.1.4.1.自服务平台与EC双向同步成员变更信息10

3.1.4.1.1.交易属性10

3.1.4.1.2.交易报文10

3.2.EC流量统付成员变更开通确认12

3.2.1.业务功能12

3.2.2.业务约定12

3.2.3.业务属性13

3.2.4.交易单元13

3.2.4.1.自服务平台向EC反馈成员变更结果信息13

3.2.4.1.1.交易属性13

3.2.4.1.2.交易报文13

3.3.成员流量叠加包订购15

3.3.1.业务功能15

3.3.2.业务约定15

3.3.3.业务属性15

3.3.4.交易单元16

3.3.4.1.EC向自服务平台发起成员流量叠加包订购16

3.3.4.1.1.交易属性16

3.3.4.1.2.交易报文16

3.4.成员流量叠加包订购确认18

3.4.1.业务功能18

3.4.2.业务约定18

3.4.3.业务属性19

3.4.4.交易单元19

3.4.4.1.自服务平台向EC发起成员流量叠加包开通确认19

3.4.4.1.1.交易属性19

3.4.4.1.2.交易报文19

3.5.成员订购查询接口20

3.5.1.业务功能20

3.5.2.业务约束20

3.5.3.业务流程21

3.5.4.业务属性21

3.5.5.交易单元22

3.5.5.1.交易属性22

3.5.5.2.交易报文22

3.5.5.2.1.成员订购查询1

3.5.5.2.2.成员订购查询反馈2

3.6.EC流量统付订单查询3

3.6.1.业务功能3

3.6.2.业务约定3

3.6.3.业务属性3

3.6.4.交易单元4

3.6.4.1.交易属性4

3.6.4.2.交易报文4

3.7.接口安全性7

3.7.1.1.HTTP鉴权头参数定义7

3.7.1.2.X-WSSEHTTP头参数定义7

3.7.1.3.示例8

3.8.报文填写说明8

3.8.1.InerBOSS部分9

3.8.2.SvcCont部分9

3.8.2.1.成员变更信息接口9

3.8.3.业务开通规则9

4.文件接口11

4.1.文件接口的功能11

4.2.文件格式11

4.3.文件的获取11

4.4.文件校验12

4.5.EC流量统付成员变更文件12

4.5.1.业务流程12

4.5.1.1.EC业务流程12

4.5.1.2.自服务平台业务流程13

4.5.2.文件格式13

4.5.2.1.文件命名规则13

4.5.2.2.文件格式说13

4.6.流量统付成员变更确认文件15

4.6.1.业务流程15

4.6.2.文件格式15

4.6.2.1.文件命名规则15

4.6.2.2.文件格式说明15

流量叠加包订购文件18

4.6.3.业务流程18

4.6.4.文件格式18

4.6.4.1.文件命名规则18

4.6.4.2.文件格式说明18

4.7.流量叠加包订购确认文件20

4.7.1.业务流程20

4.7.2.文件格式20

4.7.2.1.文件命名规则20

4.7.2.2.文件格式说明20

4.8.EC流量使用情况通知文件22

4.8.1.业务流程22

4.8.2.文件格式22

4.8.2.1.文件命名规则22

4.8.2.2.文件格式说明22

4.9.成员清单同步23

4.9.1.业务流程23

4.9.2.文件格式23

4.9.2.1.文件命名规则23

4.9.2.2.文件格式说明24

4.10.对帐24

4.10.1.文件的传输24

4.10.2.文件格式25

4.10.2.1.文件命名规范25

4.10.2.2.文件格式说明25

4.10.3.对帐文件的比对25

5.附录26

5.1.附录一26

5.2.附录二26

消息头26

消息体30

5.3.附录三30

5.4.附录四34

1.概述

1.1.文档概述

本文描述了EC与自服务平台（以下简称DOMS）间关于指定用户流量统付的接口，包括业务功能、流程和接口报文格式。

为便于对数据处理过程进行说明，也涉及自服务平台与BBOSS间的接口调用过程。

1.2.引用标准

2.总体规范

2.1.总体说明

关于消息头等说明，沿用《中国移动网状网系统接口规范–总册V1.0.8》中的约定，详见附录二，本文仅描述业务相关消息体。

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

元素的约束条件使用以下符号表示：

符号

含义

0..1，可选项

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

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

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

XML的编码方式为UTF-8。

在开发实时接口过程中请注意，根据此规范实现的实时接口是通过业务编码BIPCODE和交易编码ActivityCode区分业务操作，而不是通过URL区分。

完成的接口对外应是一个URL，而不是多个。

实时接口报文元素顺序应与文档一致，BBOSS在验证报文是会对元素顺序进行校验。

2.2.接口流程

本文用于描述如下EC与DOMS间（灰色背景部分）的接口。

2.2.1.EC发起流量统付成员变更/成员流量叠加包订购接口流程

2.2.2.BBOSS发起流量统付成员变更接口流程

2.3.成员校验逻辑

EC向DOMS平台同步新增成员的时候，需要保证该成员不在同一订购的成员中，也不在当前订购的在途添加成员中，在同一接口请求（包括3.1实时接口和4.5文件接口中）不能重复，即：

成员不能重复添加。

EC向自服务平台同步删除成员的时候，需要保证该成员在当前订购的成员中，不在当前订购的在途删除成员中，在同一接口请求（包括3.1实时接口和4.5文件接口中）不能重复，即：

成员不能重复删除。

3.实时接口部分

3.1.EC流量统付成员变更

3.1.1.业务功能

EC在以下情况时使用本接口：

1）业务开通后，EC根据业务发展需要，通过自服务平台提交成员变更请求至BBOSS。

DOMS在以下情况时使用本接口：

个人用户通过归属省BOSS渠道退订流量统付业务；用户状态发生变化，影响业务使用时（包括：

预销户、销户、过户等），通过归属省BOSS退订流量统付业务。

1）DOMS平台接收到BBOSS发来的成员退订报文后，将退订转发至流量统付EC

3.1.2.业务约定

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

接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。

因为BBOSS收到成员开通工单后，需要下成员归属省开通，并在全部成员开通完成后进行归档和反馈，为了保证效率，请EC在一个报文中包含尽可能少的归属省的多个成员，减少单个成员分别开通和一个报文中包含多个归属省成员的情况。

为了保证处理效率，需要EC对一个成员开通报文包含的成员进行限制，一个报文中包含成员数量不超过50个。

3.1.3.业务属性

自服务平台与EC双向同步成员变更信息

交易组成

自服务平台与EC双向同步成员变更信息

业务编码：

分业务进行编码，如下表所列：

业务名称

业务编码BIPCODE

DOMS与EC双向同步成员变更信息

BIP4B874

3.1.4.交易单元

3.1.4.1.自服务平台与EC双向同步成员变更信息

3.1.4.1.1.交易属性

自服务平台与EC双向同步成员变更信息

交易编码ActivityCode：

T4011135

3.1.4.1.2.交易报文

交易请求报文的消息头和消息体是独立分隔的两个XMLPart，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。

（1）请求SvcCont：

序号

父元素名称

元素名称

约束

类型

长度

描述

取值说明

InterBOSS

SvcCont

——

请求报文

1.1

SvcCont

UserInfo

——

成员变更请求

1.1.1

UserInfo

ProductID

String

V20

订购关系编码

具体值由BBOSS分配

1.1.2

UserInfo

UserData

－

成员信息

1.1.2.1

UserData

MobNum

String

F11

用户手机号码

1.1.2.2

UserData

OprCode

String

操作代码

01－加入名单02－退出名单03－成员变更

BBOSS只能发起退出名单，必须是02

1.1.2.3

UserData

UserPackage

String

用户套餐

10-3元包10MB

11-5元包30MB

12-10元包70MB

13-20元包150MB

18-30元包500MB

19-50元包1024MB

20-70元包2048MB

21-100元包3072MB

22-130元包4096MB

23-180元包6144MB

24-280元包11264MB

101-8元500MB闲时定向套餐

102-10元1GB闲时定向套餐

103-15元2GB闲时定向套餐

104-20元3GB闲时定向套餐

151-10元1GB闲时通用套餐

仅用户流量包模式的流量统付业务必填，企业流量池模式的业务该字段无效

1.1.2.4

UserData

UsageLimit

？

Number

用户流量封顶值

正整数，MB为单位，仅指定用户限量统付的企业流量池模式流量统付业务填写

1.1.2.5

UserData

ValidMonths

String

用户使用周期

正整数，月为单位，填00表示长期有效，直到进行成员删除

1.1.3

UserInfo

EffRule

？

Number

成员账期生效规则

1-新增成员立即生效，为了兼容以前规范，该节点定义为可选，无此节点新增成员默认为立即生效

2-新增成员下账期生效

此节点仅适用于新增成员，删除成员必须下账期生效。

*注意，EffRule元素应写在UserData元素之后。

（2）应答SvcCont：

序号

父元素名称

元素名称

约束

类型

长度

描述

取值说明

InterBOSS

SvcCont

——

请求报文

1.1

SvcCont

UserResponse

——

成员变更反馈

1.1.1

UserResponse

Status

Number

请求状态

01-接收成功

02-ProductID未找到、已注销或者与发送/接受方机构不匹配

03-ProductID指定的流量统付订购关系为不限用户模式，不支持成员变更

04-成员账期生效规则错误，只能填写0或者1

05-用户使用周期不合法，必须是正整数或者00

06-成员数量超过50个限制

99-其他错误，错误原因在ErrDesc中注明

1.1.2

UserResponse

OperSeqList

——

订单流水号列表

如果自服务平台完成格式校验，将报文转发BBOSS。

BBOSS成功接收后返回一个订单流水号。

1.1.2.1

OperSeqList

OperSeq

String

V30

订单流水号

EC向自服务平台同步成员变更的时候，如果自服务平台和BBOSS都成功接收，BBOSS反馈全局唯一的订单流水，自服务平台和EC进行保存。

BBOSS开通完成以后，通过这个全局唯一的订单流水反馈开通结果给自服务平台，并由自服务平台将结果转发给EC。

BBOSS向自服务平台及EC同步的时候，接收方不需要反馈流水号，EC完成删除以后也不需要反馈删除结果给自服务平台。

1.1.3

UserResponse

ErrDesc

String

V200

错误说明

当Status=99时必填

3.2.EC流量统付成员变更开通确认

3.2.1.业务功能

BBOSS完成成员开通，当自服务平台接收到BBOSS提供的开通结果后，通过本接口反馈开通结果给EC。

EC发起一次统付成员变更请求，各方进行一次开通确认。

3.2.2.业务约定

接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。

3.2.3.业务属性

自服务平台向EC同步成员变更开通结果

交易组成

自服务平台向EC同步成员变更开通结果

业务编码：

分业务进行编码，如下表所列：

业务名称

业务编码BIPCode

自服务平台向EC同步成员变更开通结果

BIP4B875

3.2.4.交易单元

3.2.4.1.自服务平台向EC反馈成员变更结果信息

3.2.4.1.1.交易属性

自服务平台向EC反馈成员变更结果信息

交易编码ActivityCode：

T4011136

3.2.4.1.2.交易报文

交易请求报文的消息头和消息体是独立分隔的两个XMLPart，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。

（1）请求SvcCont：

序号

父元素名称

元素名称

约束

类型

长度

描述

取值说明

InterBOSS

SvcCont

——

请求报文

1.1

SvcCont

UserResult

——

成员变更结果

1.1.1

UserResult

OperSeq

String

V30

订单流水号

EC发起成员变更时，BBOSS反馈的流水号

1.1.2

UserResult

SuccNum

String

处理成功的记录总数

如果记录处理全部失败则此处填0

1.1.3

UserResult

SuccInfo

——

处理成功记录明细

如果全部失败则不填

如果有处理成功则填写成功明细

1.1.3.1

SuccInfo

SuccTel

String

F11

成功用户手机号码

1.1.3.2

SuccInfo

EffDate

Srting

生效日期

该成员统付生效日期

如果EC请求是立即生效或者未指明生效账期，该时间为开通完成日期；如果EC请求是下账期生效，该时间为开通完成日期的下月一日

1.1.4

UserResult

FailNum

String

处理失败的记录总数

文件级错误填0，记录处理全部成功则此处填0

1.1.5

UserResult

FailInfo

—

－

处理失败记录明细

如果全部成功则不填

如果有处理失败记录则此处必须填写失败明细

1.1.5.1

FailInfo

MobNum

String

F11

失败用户手机号码

1.1.5.2

FailInfo

Rsp

String

失败信息

01操作代码错误。

02用户手机号码不是中国移动合法手机号码

03重复添加

04重复删除

05用户套餐枚举值错误或者该订购不是个人套餐包模式

06用户封顶流量值错误或者该订购不支持个人流量封顶

07XX省公司开通失败，具体失败原因见下表

08用户使用周期不合法

51BBOSS正在开通过程中（可选）自服务平台拦截操作错误

99其他错误，详见RspDesc

1.1.5.3

FailInfo

RspDesc

？

String

V500

错误详细描述

当Rsp=07/99时必填

省公司开通失败原因明细

编码

描述

0701

产品订单编码错误

0702

订单来源错误

0703

成员号码错误

0704

操作类型错误

0705

成员类型错误

0706

成员群组号错误

0707

期望生效时间错误

0708

成员属性编码错误

0709

成员属性名错误

0710

成员属性值错误

0711

产品订购关系编码错误

0712

业务互斥

0713

用户状态不正常

0797

省公司开通超时，各方按照失败处理

0799

其它错误，具体原因见RepDesc节点

（2）应答SvcCont：

空

3.3.成员流量叠加包订购

3.3.1.业务功能

该接口仅适用于订购个人流量包模式的流量统付业务，在个人流量包包含流量不能满足需要的时候，EC可以向自服务平台发起一次性流量叠加包订购请求，由自服务平台将请求转发BBOSS，BBOSS完成成员叠加包的开通，该叠加包仅当月一次性生效。

在每月最后两天前（以BBOSS处理时间为准）可以对个人流量包模式的流量统付业务进行一次性叠加包订购，叠加包立即生效，限当月使用。

同一个成员可以在同一账期内多次订购叠加包，费用和流量均叠加。

因为BBOSS到配合省开通需要一定周期，距离月底不足48小时的情况下，BBOSS会拒绝进行流量叠加包订购，以避免出现跨月生效的情况。

3.3.2.业务约定

接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。

为了保证省公司的开通效率，需要EC对一个叠加包开通报文包含的成员进行限制，一个报文中包含成员数量不超过50个。

3.3.3.业务属性

成员流量叠加包订购

交易组成

EC向自服务平台发起成员流量叠加包订购

业务编码：

分业务进行编码，如下表所列：

业务名称

业务编码BIPCode

成员流量叠加包订购

BIP4B876

3.3.4.交易单元

3.3.4.1.EC向自服务平台发起成员流量叠加包订购

3.3.4.1.1.交易属性

EC向自服务平台发起成员流量叠加包订购

交易编码ActivityCode：

T4011137

3.3.4.1.2.交易报文

交易请求报文的消息头和消息体是独立分隔的两个XMLPart，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。

（1）请求SvcCont：

序号

父元素名称

元素名称

约束

类型

长度

描述

取值说明

InterBOSS

SvcCont

——

请求报文

1.1

SvcCont

AdditionInfo

——

叠加包订购

1.2

AdditionInfo

ProductID

String

V20

订购关系编码

通用业务必填

1.3

AdditionInfo

UserData

－

签约关系、黑白名单信息

1.3.1

UserData

MobNum

String

F11

用户手机号码

1.3.2

UserData

UserPackage

String

叠加套餐

10-3元包10MB

11-5元包30MB

12-10元包70MB

13-20元包150MB

18-30元包500M流量

19-50元包1024M流量

20-70元包2048M流量

21-100元包3072M流量

22-130元包4096M流量

23-180元包6144M流量

24-280元包11264M流量

101-8元500MB闲时定向套餐

102-10元1GB闲时定向套餐

103-15元2GB闲时定向套餐

104-20元3GB闲

展开阅读全文