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

1、流量统付EC与自服务平台接口规范流量统付EC与自服务平台接口规范(V1.3)2015/06/05文档变更记序号变更内容说明版本号版本日期执笔人1征求意见稿1.02015-01-222明确路由类型、路由关键值、应用域代码的内容1.12015-02-103修正成员订购查询流水号的长度要求和生成规则,补充业务逻辑要求说明；流量使用情况和成员清单文件接口只针对限量统付模式用户提供。1.22015-04-154针对自服务平台与BOSS间接口规范修订进行修改.基础业务和叠加包关系分开,允许直接调用叠加包接口.由于BBOSS对接口元素顺序有要求，故将成员变更接口中，帐期生效规则EffRule元素改为写在Us

2、erData元素之后，保持与BBOSS间规范一致。1.22015-04-215根据与平台与BBOSS规范修订同步更新,包括:3.1和3.3的OperSeqList节点从?改为1，即使全部失败也生成订单，并通过这个失败订单反馈具体成员失败原因新增EC流量统付订单查询接口3.6小节为了应对一个平台接入多个EC，在文件接口中体现出接入机构名称,此处的机构取值均为STKP根据业务要求，向EC反馈开通结果的返回码从F2改为V4，省公司开通失败的情况下，将省公司返回码一并反馈给EC；所有的错误原因描述长度，统一调整为V500增加闲时流量包编码（101-104，151），对应套餐包字段的长度从F2改为V3增

3、加自服务平台鉴权处理,针对3.1/3.3 接口的不合规数据,自服务平台进行拦截。对应的应答代码RspCode见附录4目录文档变更记 i1.概述 61.1.文档概述 61.2.引用标准 62.总体规范 62.1. 总体说明 62.2.接口流程 72.2.1. EC发起流量统付成员变更/成员流量叠加包订购接口流程 72.2.2. BBOSS发起流量统付成员变更接口流程 72.3. 成员校验逻辑 73.实时接口部分 93.1. EC流量统付成员变更 93.1.1.业务功能 93.1.2. 业务约定 93.1.3.业务属性 93.1.4.交易单元 103.1.4.1.自服务平台与EC双向同步成员变更信

4、息 103.1.4.1.1.交易属性 103.1.4.1.2.交易报文 103.2. EC流量统付成员变更开通确认 123.2.1.业务功能 123.2.2.业务约定 123.2.3.业务属性 133.2.4.交易单元 133.2.4.1.自服务平台向EC反馈成员变更结果信息 133.2.4.1.1.交易属性 133.2.4.1.2.交易报文 133.3. 成员流量叠加包订购 153.3.1.业务功能 153.3.2.业务约定 153.3.3.业务属性 153.3.4.交易单元 163.3.4.1. EC向自服务平台发起成员流量叠加包订购 163.3.4.1.1.交易属性 163.3.4.1.

5、2.交易报文 163.4. 成员流量叠加包订购确认 183.4.1.业务功能 183.4.2.业务约定 183.4.3.业务属性 193.4.4.交易单元 193.4.4.1.自服务平台向EC发起成员流量叠加包开通确认 193.4.4.1.1.交易属性 193.4.4.1.2.交易报文 193.5.成员订购查询接口 203.5.1.业务功能 203.5.2.业务约束 203.5.3.业务流程 213.5.4.业务属性 213.5.5.交易单元 223.5.5.1.交易属性 223.5.5.2.交易报文 223.5.5.2.1.成员订购查询 13.5.5.2.2.成员订购查询反馈 23.6. E

6、C流量统付订单查询 33.6.1.业务功能 33.6.2.业务约定 33.6.3.业务属性 33.6.4.交易单元 43.6.4.1.交易属性 43.6.4.2.交易报文 43.7. 接口安全性 73.7.1.1. HTTP鉴权头参数定义 73.7.1.2. X-WSSE HTTP 头参数定义 73.7.1.3.示例 83.8. 报文填写说明 83.8.1. InerBOSS部分 93.8.2. SvcCont部分 93.8.2.1.成员变更信息接口 93.8.3.业务开通规则 94.文件接口 114.1.文件接口的功能 114.2.文件格式 114.3.文件的获取 114.4.文件校验 12

7、4.5. EC流量统付成员变更文件 124.5.1.业务流程 124.5.1.1. EC业务流程 124.5.1.2.自服务平台业务流程 134.5.2.文件格式 134.5.2.1.文件命名规则 134.5.2.2.文件格式说 134.6. 流量统付成员变更确认文件 154.6.1.业务流程 154.6.2.文件格式 154.6.2.1.文件命名规则 154.6.2.2.文件格式说明 15流量叠加包订购文件 184.6.3.业务流程 184.6.4.文件格式 184.6.4.1.文件命名规则 184.6.4.2.文件格式说明 184.7. 流量叠加包订购确认文件 204.7.1.业务流程 2

8、04.7.2.文件格式 204.7.2.1.文件命名规则 204.7.2.2.文件格式说明 204.8. EC流量使用情况通知文件 224.8.1.业务流程 224.8.2.文件格式 224.8.2.1.文件命名规则 224.8.2.2.文件格式说明 224.9.成员清单同步 234.9.1.业务流程 234.9.2.文件格式 234.9.2.1.文件命名规则 234.9.2.2.文件格式说明 244.10. 对帐 244.10.1.文件的传输 244.10.2.文件格式 254.10.2.1.文件命名规范 254.10.2.2.文件格式说明 254.10.3.对帐文件的比对 255.附录 2

9、65.1. 附录一 265.2. 附录二 26消息头 26消息体 305.3. 附录三 305.4. 附录四 341. 概述1.1. 文档概述本文描述了EC与自服务平台（以下简称DOMS）间关于指定用户流量统付的接口，包括业务功能、流程和接口报文格式。为便于对数据处理过程进行说明，也涉及自服务平台与BBOSS间的接口调用过程。1.2. 引用标准2. 总体规范2.1. 总体说明关于消息头等说明，沿用中国移动网状网系统接口规范总册V1.0.8中的约定，详见附录二，本文仅描述业务相关消息体。在本文档中以表格的形式表示XML格式；以下为表格中对元素约束（出现次数）的表示方法的描述：元素的约束条件使用以

10、下符号表示：符号含义?0.1，可选项*0.n，可以没有，也可以有多项+1.n，至少有1项，也可以有多项1数字1，代表必须且只能填1项XML的编码方式为UTF-8。在开发实时接口过程中请注意，根据此规范实现的实时接口是通过业务编码BIPCODE和交易编码ActivityCode区分业务操作，而不是通过URL区分。完成的接口对外应是一个URL，而不是多个。实时接口报文元素顺序应与文档一致，BBOSS在验证报文是会对元素顺序进行校验。2.2. 接口流程本文用于描述如下EC与DOMS间（灰色背景部分）的接口。2.2.1. EC发起流量统付成员变更/成员流量叠加包订购接口流程2.2.2. BBOSS发起

11、流量统付成员变更接口流程2.3. 成员校验逻辑EC向DOMS平台同步新增成员的时候，需要保证该成员不在同一订购的成员中，也不在当前订购的在途添加成员中，在同一接口请求（包括3.1实时接口和4.5文件接口中）不能重复，即：成员不能重复添加。EC向自服务平台同步删除成员的时候，需要保证该成员在当前订购的成员中，不在当前订购的在途删除成员中，在同一接口请求（包括3.1实时接口和4.5文件接口中）不能重复，即：成员不能重复删除。3. 实时接口部分3.1. EC流量统付成员变更3.1.1. 业务功能EC在以下情况时使用本接口：1） 业务开通后，EC根据业务发展需要，通过自服务平台提交成员变更请求至BBO

12、SS。DOMS在以下情况时使用本接口：个人用户通过归属省BOSS渠道退订流量统付业务；用户状态发生变化，影响业务使用时（包括：预销户、销户、过户等），通过归属省BOSS退订流量统付业务。1） DOMS平台接收到BBOSS发来的成员退订报文后，将退订转发至流量统付EC3.1.2. 业务约定发起方发送请求消息后，如果超时没有收到落地方的应答，应自动重发，在重发指定的次数后落地方还没有返回确认应答，则写错误日志，并结束本次发送，对没有成功同步的信息，在下一次同步的时候再次同步。接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。因为BBOSS收到成

13、员开通工单后，需要下成员归属省开通，并在全部成员开通完成后进行归档和反馈，为了保证效率，请EC在一个报文中包含尽可能少的归属省的多个成员，减少单个成员分别开通和一个报文中包含多个归属省成员的情况。为了保证处理效率，需要EC对一个成员开通报文包含的成员进行限制，一个报文中包含成员数量不超过50个。3.1.3. 业务属性自服务平台与EC双向同步成员变更信息交易组成自服务平台与EC双向同步成员变更信息业务编码：分业务进行编码，如下表所列：业务名称业务编码BIPCODEDOMS与EC双向同步成员变更信息BIP4B8743.1.4. 交易单元3.1.4.1. 自服务平台与EC双向同步成员变更信息3.1.

14、4.1.1. 交易属性自服务平台与EC双向同步成员变更信息交易编码ActivityCode：T40111353.1.4.1.2. 交易报文交易请求报文的消息头和消息体是独立分隔的两个XML Part，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。(1) 请求SvcCont：序号父元素名称元素名称约束类型长度描述取值说明1InterBOSSSvcCont1请求报文1.1SvcContUserInfo1成员变更请求1.1.1UserInfoProductID1StringV20订购关系编码具体值由BBOSS分配1.1.2UserInfoUserData+成员信息1.1.2.1Us

15、erDataMobNum1StringF11用户手机号码1.1.2.2UserDataOprCode1StringF2操作代码01加入名单 02退出名单03成员变更BBOSS只能发起退出名单，必须是021.1.2.3UserDataUserPackage?StringV3用户套餐10- 3元包10MB11- 5元包30MB12- 10元包70MB13- 20元包150MB18- 30元包500MB19- 50元包1024MB20- 70元包2048MB21- 100元包3072MB22- 130元包4096MB23- 180元包6144MB24- 280元包11264MB101- 8元500M

16、B闲时定向套餐102- 10元1GB闲时定向套餐103- 15元2GB闲时定向套餐104- 20元3GB闲时定向套餐151- 10元1GB闲时通用套餐仅用户流量包模式的流量统付业务必填，企业流量池模式的业务该字段无效1.1.2.4UserDataUsageLimit？NumberV8用户流量封顶值正整数，MB为单位，仅指定用户限量统付的企业流量池模式流量统付业务填写1.1.2.5UserDataValidMonths1StringV2用户使用周期正整数，月为单位，填00表示长期有效，直到进行成员删除1.1.3UserInfoEffRule？NumberF1成员账期生效规则1- 新增成员立即生效

17、，为了兼容以前规范，该节点定义为可选，无此节点新增成员默认为立即生效2- 新增成员下账期生效此节点仅适用于新增成员，删除成员必须下账期生效。*注意，EffRule元素应写在UserData元素之后。(2) 应答SvcCont：序号父元素名称元素名称约束类型长度描述取值说明1InterBOSSSvcCont1请求报文1.1SvcContUserResponse1成员变更反馈1.1.1UserResponseStatus1NumberF2请求状态01- 接收成功02- ProductID未找到、已注销或者与发送/接受方机构不匹配03- ProductID指定的流量统付订购关系为不限用户模式，不支持

18、成员变更04- 成员账期生效规则错误，只能填写0或者105- 用户使用周期不合法，必须是正整数或者0006- 成员数量超过50个限制99-其他错误，错误原因在ErrDesc中注明1.1.2UserResponseOperSeqList?订单流水号列表如果自服务平台完成格式校验，将报文转发BBOSS。BBOSS成功接收后返回一个订单流水号。1.1.2.1OperSeqListOperSeq+StringV30订单流水号EC向自服务平台同步成员变更的时候，如果自服务平台和BBOSS都成功接收，BBOSS反馈全局唯一的订单流水，自服务平台和EC进行保存。BBOSS开通完成以后，通过这个全局唯一的订单

19、流水反馈开通结果给自服务平台，并由自服务平台将结果转发给EC。BBOSS向自服务平台及EC同步的时候，接收方不需要反馈流水号，EC完成删除以后也不需要反馈删除结果给自服务平台。1.1.3UserResponseErrDesc?StringV200错误说明当Status=99时必填3.2. EC流量统付成员变更开通确认3.2.1. 业务功能BBOSS完成成员开通，当自服务平台接收到BBOSS提供的开通结果后，通过本接口反馈开通结果给EC。EC发起一次统付成员变更请求，各方进行一次开通确认。3.2.2. 业务约定发起方发送请求消息后，如果超时没有收到落地方的应答，应自动重发，在重发指定的次数后落地

20、方还没有返回确认应答，则写错误日志，并结束本次发送，对没有成功同步的信息，在下一次同步的时候再次同步。接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。3.2.3. 业务属性自服务平台向EC同步成员变更开通结果交易组成自服务平台向EC同步成员变更开通结果业务编码：分业务进行编码，如下表所列：业务名称业务编码BIPCode自服务平台向EC同步成员变更开通结果BIP4B8753.2.4. 交易单元3.2.4.1. 自服务平台向EC反馈成员变更结果信息3.2.4.1.1. 交易属性自服务平台向EC反馈成员变更结果信息交易编码ActivityCod

21、e：T40111363.2.4.1.2. 交易报文交易请求报文的消息头和消息体是独立分隔的两个XML Part，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。(1) 请求SvcCont：序号父元素名称元素名称约束类型长度描述取值说明1InterBOSSSvcCont1请求报文1.1SvcContUserResult1成员变更结果1.1.1UserResultOperSeq1StringV30订单流水号EC发起成员变更时，BBOSS反馈的流水号1.1.2UserResultSuccNum1StringV6处理成功的记录总数如果记录处理全部失败则此处填01.1.3UserResu

22、ltSuccInfo*处理成功记录明细如果全部失败则不填如果有处理成功则填写成功明细1.1.3.1SuccInfoSuccTel1StringF11成功用户手机号码1.1.3.2SuccInfoEffDate1SrtingF8生效日期该成员统付生效日期如果EC请求是立即生效或者未指明生效账期，该时间为开通完成日期；如果EC请求是下账期生效，该时间为开通完成日期的下月一日1.1.4UserResultFailNum1StringV6处理失败的记录总数文件级错误填0，记录处理全部成功则此处填01.1.5UserResultFailInfo*处理失败记录明细如果全部成功则不填如果有处理失败记录则此处

23、必须填写失败明细1.1.5.1FailInfoMobNum1StringF11失败用户手机号码1.1.5.2FailInfoRsp1StringV4失败信息01 操作代码错误。02 用户手机号码不是中国移动合法手机号码03 重复添加04 重复删除05 用户套餐枚举值错误或者该订购不是个人套餐包模式06 用户封顶流量值错误或者该订购不支持个人流量封顶07XX 省公司开通失败，具体失败原因见下表08 用户使用周期不合法51 BBOSS正在开通过程中（可选）自服务平台拦截操作错误99 其他错误，详见RspDesc1.1.5.3FailInfoRspDesc？StringV500错误详细描述当Rsp=

24、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可以向自服务

25、平台发起一次性流量叠加包订购请求，由自服务平台将请求转发BBOSS，BBOSS完成成员叠加包的开通，该叠加包仅当月一次性生效。在每月最后两天前（以BBOSS处理时间为准）可以对个人流量包模式的流量统付业务进行一次性叠加包订购，叠加包立即生效，限当月使用。同一个成员可以在同一账期内多次订购叠加包，费用和流量均叠加。因为BBOSS收到成员开通工单后，需要下成员归属省开通，并在全部成员开通完成后进行归档和反馈，为了保证效率，请EC在一个报文中包含尽可能少的归属省的多个成员，减少单个成员分别开通和一个报文中包含多个归属省成员的情况。因为BBOSS到配合省开通需要一定周期，距离月底不足48小时的情况下，

26、BBOSS会拒绝进行流量叠加包订购，以避免出现跨月生效的情况。3.3.2. 业务约定发起方发送请求消息后，如果超时没有收到落地方的应答，应自动重发，在重发指定的次数后落地方还没有返回确认应答，则写错误日志，并结束本次发送，对没有成功同步的信息，在下一次同步的时候再次同步。接口发起方保证报文大小单个报文不超过128K，发送频率不超过1秒1个，以免落地方平台被过量交易报文堵塞。为了保证省公司的开通效率，需要EC对一个叠加包开通报文包含的成员进行限制，一个报文中包含成员数量不超过50个。3.3.3. 业务属性成员流量叠加包订购交易组成EC向自服务平台发起成员流量叠加包订购业务编码：分业务进行编码，如

27、下表所列：业务名称业务编码BIPCode成员流量叠加包订购BIP4B8763.3.4. 交易单元3.3.4.1. EC向自服务平台发起成员流量叠加包订购3.3.4.1.1. 交易属性EC向自服务平台发起成员流量叠加包订购交易编码ActivityCode：T40111373.3.4.1.2. 交易报文交易请求报文的消息头和消息体是独立分隔的两个XML Part，消息头格式沿用附录二中消息头约定，见附录，在此只描述消息体部分。(1) 请求SvcCont：序号父元素名称元素名称约束类型长度描述取值说明1InterBOSSSvcCont1请求报文1.1SvcContAdditionInfo1叠加包订购

28、1.2AdditionInfoProductID1StringV20订购关系编码通用业务必填1.3AdditionInfoUserData+签约关系、黑白名单信息1.3.1UserDataMobNum1StringF11用户手机号码1.3.2UserDataUserPackage1StringV4叠加套餐10- 3元包10MB11- 5元包30MB12- 10元包70MB13- 20元包150MB18- 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闲