中国移动BBOSS与云MAS平台接口规范.docx
- 文档编号:24260239
- 上传时间:2023-05-25
- 格式:DOCX
- 页数:31
- 大小:79.50KB
中国移动BBOSS与云MAS平台接口规范.docx
《中国移动BBOSS与云MAS平台接口规范.docx》由会员分享,可在线阅读,更多相关《中国移动BBOSS与云MAS平台接口规范.docx(31页珍藏版)》请在冰豆网上搜索。
中国移动BBOSS与云MAS平台接口规范
中国移动通信有限公司
网状网接口规范
BBOSS与云MAS平台接口规范
(V0.5)
中国移动通信有限公司
二○一四年四月
文档变更记录
序号
变更内容说明
版本号
版本日期
执笔人
1
初稿
0.5
2014-4-21
刘继军
1.概述
1.1.文档概述
本文描述BBOSS与云MAS平台间的接口。
1.2.引用标准
略
2.总体规范
关于网状网的说明、消息头等说明,参见《中国移动网状网系统接口规范–总册V1.0.8》,本文仅描述业务相关消息体。
3.实时接口部分
3.1.集团客户和局数据信息从BBOSS同步到云MAS平台
3.1.1.业务功能
BBOSS统一管理EC信息,完成长流程云MAS业务订购并完成局数据信息的申请。
通过本接口,BBOSS向云MAS平台同步开通了长流程云MAS业务的EC信息和局数据信息。
3.1.2.业务流程
发起方发送请求消息后,如果超时没有收到落地方的应答,应自动重发,在重发指定的次数后落地方还没有返回确认应答,则写错误日志,并结束本次发送,对没有成功同步的信息,在下一次同步的时候再次同步。
BBOSS(报文发送方)与MAS统一管理平台(报文接受方)约定报文大小单个报文不超过128K,发送频率不超过1秒1个,以免云MAS平台被过量交易报文堵塞。
3.1.3.业务属性
BBOSS向云MAS平台同步EC企业/局数据信息
冲正处理
没有
安全性要求
无
交易组成
BBOSS向云MAS平台同步EC企业/局数据信息
业务编码:
分业务进行编码,如下表所列:
业务名称
业务编码
BBOSS向云MAS平台同步EC企业/局数据信息
BIP4B881
3.1.4.交易单元
3.1.4.1.交易属性
BBOSS向云MAS平台同步EC企业/局数据信息
交易编码:
T4011141
名称
取值
交易类型
00:
大圈类流程
对帐标记
1:
参与对帐
安全性:
密码加密
0:
不需要
安全性:
防篡改
0:
不需要
存储模式
0:
报文头、报文体存文件
交易发起方代码
BBSS
交易落地方代码
CMAS
路由类型
3.1.4.2.交易报文
系统大圈类交易请求报文的消息头和消息体是独立分隔的两个XMLPart,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头小节,在此只描述消息体部分。
(1)请求SvcCont:
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
SvcCont
1
—
-
同步信息
1.1
SvcCont
BaseInfo
1
—
-
基本信息
1.1.1
BaseInfo
ECID
1
String
V32
集团客户ID
统一制定的集团客户ID
1.1.2
BaseInfo
ECName
1
String
V256
集团客户名称
1.1.3
BaseInfo
OprType
1
String
V2
操作类型
1-开户
9-变更
2-销户
1.1.4
BaseInfo
CustMan
1
String
V50
客户经理
1.1.5
BaseInfo
CustManPhone
1
String
V50
客户经理联系电话
1.1.6
BaseInfo
SPID
1
String
F6
企业代码
1.1.7
BaseInfo
SMSProtocol
1
String
V10
短信使用接口协议
CMPP2.0/CMPP3.0
1.1.8
BaseInfo
SMSBandWidth
1
String
V4
短信端口速率(条/秒)
1.1.9
BaseInfo
ShortMatch
1
String
F1
支持纯短号码鉴权(模糊匹配)
1-否
2-是
1.1.10
BaseInfo
SMSBaseAccess
1
String
V15
短信基本接入号
1.1.11
BaseInfo
SMSIP
1
String
V15
短信主IP地址
1.1.12
BaseInfo
SMSBackIP
1
String
V100
短信备用IP地址
可填写多个
1.1.13
BaseInfo
SMSGateway
1
String
F6
接入短信网关ID
1.1.14
BaseInfo
MaxConn
1
String
V3
最大连接数
1.1.15
BaseInfo
Region
1
String
V100
局数据地域制作范围
全国或部分省列表
1.1.16
BaseInfo
MMSBaseAccess
?
String
V15
MMS基本接入号
不开通彩信不填
1.1.17
BaseInfo
MMSBandWidth
?
String
V4
彩信端口速率(条/秒)
不开通彩信不填
1.1.18
BaseInfo
MMSUrl
?
String
V100
EC/SI上行URL
不开通彩信不填
1.1.19
BaseInfo
MMSProtocal
?
String
V10
彩信通信协议
SOAP/HTTP,不开通彩信不填
1.1.20
BaseInfo
MMSGateway
?
String
V6
EC/SI接入彩信网关ID
不开通彩信不填
1.1.21
BaseInfo
MMSIP
?
String
V15
彩信主IP地址
不开通彩信不填
1.1.22
BaseInfo
MMSBackIP
?
String
V50
彩信备用IP地址
不开通彩信不填
1.1.23
BaseInfo
Remark
?
String
V100
备注
1.1.24
BaseInfo
BusiContact
1
String
V50
调测期间业务联系人
1.1.25
BaseInfo
BusiContactPhone
1
String
V50
调测期间联系电话
1.1.26
BaseInfo
OrderNumber
1
String
V32
订单编码
全局唯一的订单流水号,平台需要记录这个流水号,用于将来的数据一致性比对。
对于发生业务变更的,每次会产生新的订单流水号,平台必须保存全部的流水号对应关系。
1.1.27
BaseInfo
POID
1
String
V32
产品包订购关系ID
1.1.28
BaseInfo
ProdID
1
String
V32
产品订购关系ID
BBOSS保证订购关系的惟一性
系统大圈类应答报文的消息头和消息体存于同一XML消息中,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头说明,现只描述报文体节点SvcCont。
(2)应答SvcCont:
序号
父元素名称
元素名称
约束
类型
宽度
描述
取值说明
1
InterBOSS
SvcCont
1
String
—
请求内容
XML格式的字符串,以CDATA区表达
1.1
SvcCont
ECInfoRsp
1
—
—
集团客户信息请求反馈
1.1.1
ECInfoRsp
OprTime
1
String
F14
操作时间
1.1.2
ECInfoRsp
ECID
1
String
V30
EC集团客户编码
1.1.3
ECInfoRsp
RspCode
1
String
F4
返回码
见返回码
1.1.4
ECInfoRsp
RspDesc
1
String
V500
错误描述
在RspDesc字段中填写相应的错误描述
3.1.4.3.返回码
编码
描述
0000
成功
4501
集团客户编码重复
4502
集团客户名称为空
4503
操作类型编码错误
4504
企业代码重复
4505
短信基本接入号重复
4506
彩信基本接入号重复
4507
订单编码重复
4508
产品订购关系编码重复
5599
其他错误,在错误描述中注明
3.2.短流程集团客户和基本接入号信息从BBOSS同步到云MAS平台
3.2.1.业务功能
BBOSS统一管理EC信息,完成短流程云MAS业务订购。
通过本接口,BBOSS向云MAS平台同步开通了短流程云MAS业务的EC信息和基本接入号信息。
3.2.2.业务流程
发起方发送请求消息后,如果超时没有收到落地方的应答,应自动重发,在重发指定的次数后落地方还没有返回确认应答,则写错误日志,并结束本次发送,对没有成功同步的信息,在下一次同步的时候再次同步。
BBOSS(报文发送方)与MAS统一管理平台(报文接受方)约定报文大小单个报文不超过128K,发送频率不超过1秒1个,以免云MAS平台被过量交易报文堵塞。
3.2.3.业务属性
BBOSS向云MAS平台同步EC企业/局数据信息
冲正处理
没有
安全性要求
无
交易组成
BBOSS向云MAS平台同步EC企业/基本接入号信息
业务编码:
分业务进行编码,如下表所列:
业务名称
业务编码
BBOSS向云MAS平台同步EC企业/基本接入号信息
BIP4B882
3.2.4.交易单元
3.2.4.1.交易属性
BBOSS向云MAS平台同步EC企业/基本接入号信息
交易编码:
T4011142
名称
取值
交易类型
00:
大圈类流程
对帐标记
1:
参与对帐
安全性:
密码加密
0:
不需要
安全性:
防篡改
0:
不需要
存储模式
0:
报文头、报文体存文件
交易发起方代码
BBSS
交易落地方代码
CMAS
路由类型
3.2.4.2.交易报文
系统大圈类交易请求报文的消息头和消息体是独立分隔的两个XMLPart,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头小节,在此只描述消息体部分。
(2)请求SvcCont:
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
SvcCont
1
—
-
1.1
SvcCont
BaseInfo
1
—
-
基本信息
1.1.1
BaseInfo
ECID
1
String
V32
集团客户ID
统一制定的集团客户ID
1.1.2
BaseInfo
ECName
1
String
V256
集团客户名称
1.1.3
BaseInfo
OprType
1
String
V2
操作类型
1-开户
9-变更
2-销户
1.1.4
BaseInfo
CustMan
1
String
V50
客户经理
1.1.5
BaseInfo
CustManPhone
1
String
V50
客户经理联系电话
1.1.6
BaseInfo
SPID
1
String
V12
企业代码
1.1.7
BaseInfo
SMSBaseAccess
1
String
V15
短信基本接入号
1.1.8
BaseInfo
MMSBaseAccess
?
String
V15
MMS基本接入号
不开通彩信不填
1.1.9
BaseInfo
SMSBandWidth
1
String
V4
短信端口速录(条/秒)
1.1.10
BaseInfo
MMSBandWidth
1
String
V4
彩信端口速录(条/秒)
不开通彩信不填
1.1.11
BaseInfo
Remark
?
String
V100
备注
1.1.12
BaseInfo
BusiContact
1
String
V50
调测期间业务联系人
1.1.14
BaseInfo
BusiContactPhone
1
String
V50
调测期间联系电话
1.1.15
BaseInfo
OrderNumber
1
String
V32
订单编码
全局唯一的订单流水号,平台需要记录这个流水号,用于将来的数据一致性比对。
对于发生业务变更的,每次会产生新的订单流水号,平台必须保存全部的流水号对应关系。
1.1.16
BaseInfo
POID
1
String
V32
产品包订购关系ID
1.1.17
BaseInfo
ProdID
1
String
V32
产品订购关系ID
BBOSS保证产品订购关系ID的惟一性
系统大圈类应答报文的消息头和消息体存于同一XML消息中,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头说明,现只描述报文体节点SvcCont。
(2)应答SvcCont:
序号
父元素名称
元素名称
约束
类型
宽度
描述
取值说明
1
InterBOSS
SvcCont
1
String
—
请求内容
XML格式的字符串,以CDATA区表达
1.1
SvcCont
ECInfoRsp
1
—
—
集团客户信息请求反馈
1.1.1
ECInfoRsp
OprTime
1
String
F14
操作时间
1.1.2
ECInfoRsp
ECID
1
String
V30
EC集团客户编码
1.1.3
ECInfoRsp
RspCode
1
String
F4
返回码
见返回码
1.1.4
ECInfoRsp
RspDesc
1
String
V500
错误描述
在RspDesc字段中填写相应的错误描述
3.2.4.3.返回码
编码
描述
0000
成功
4501
集团客户编码重复
4502
集团客户名称为空
4503
操作类型编码错误
4504
企业代码重复
4505
短信基本接入号重复
4506
彩信基本接入号重复
4507
订单编码重复
4508
产品订购关系ID重复
5599
其他错误,在错误描述中注明
3.3.业务信息从BBOSS同步到云MAS平台
3.3.1.业务功能
BBOSS统一管理MAS业务的订购。
通过本接口实现:
BBOSS向云MAS平台同步短信/网信/彩信业务订购。
3.3.2.业务流程
发起方发送请求消息后,如果超时没有收到落地方的应答,应自动重发,在重发指定的次数后落地方还没有返回确认应答,则写错误日志,并结束本次发送,对没有成功同步的信息,在下一次同步的时候再次同步。
BBOSS(报文发送方)与MAS统一管理平台(报文接受方)约定报文大小单个报文不超过128K,发送频率不超过1秒1个,以免云MAS平台被过量交易报文堵塞。
3.3.3.业务属性
BBOSS向MAS统一管理平台同步MAS业务信息
冲正处理
没有
安全性要求
无
交易组成
BBOSS向云MAS平台同步业务信息
业务编码:
分业务进行编码,如下表所列:
业务名称
业务编码
BBOSS向云MAS平台同步业务信息
BIP4B883
3.3.4.交易单元
3.3.4.1.交易属性
BBOSS向云MAS平台同步业务信息
交易编码:
T4011143
名称
取值
交易类型
00:
大圈类流程
对帐标记
1:
参与对帐
安全性:
密码加密
0:
不需要
安全性:
防篡改
0:
不需要
存储模式
0:
报文头、报文体存文件
交易发起方代码
BBSS
交易落地方代码
CMAS
路由类型
3.3.4.2.交易报文
系统大圈类交易请求报文的消息头和消息体是独立分隔的两个XMLPart,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头小节,在此只描述消息体部分。
(1)请求SvcCont:
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
SvcCont
1
—
——
云MAS业务订购信息
1.1
SvcCont
BizInfo
1
——
——
云MAS业务订购信息
1.1.1
BizInfo
ProdType
1
String
F1
业务类别
1-长流程短信
2-长流程网信
3-长流程彩信
4-短流程短信
5-短流程网信
6-短流程彩信
1.1.2
BizInfo
OperCode
1
String
V2
操作代码
1-开户
9-变更
2-销户
1.1.3
BizInfo
SPID
1
String
V12
企业代码
用于关联企业/局数据/基本接入号信息信息
1.1.4
BizInfo
EngSign
?
String
V30
英文短/彩信正文签名
1.1.5
BizInfo
DefaultSign
1
String
F1
缺省签名语言
1-英文
2-中文
1.1.6
BizInfo
NeedSign
1
String
F1
是否支持短信/彩信正文签名
1-否(应用签名)
2-是(网关签名)
1.1.7
BizInfo
ChnSigh
1
String
V30
中文短信正文签名
1.1.8
BizInfo
ServCode
1
String
V21
服务代码
1.1.9
BizInfo
BusiCode
1
String
V20
业务代码
1.1.10
BizInfo
RBList
1
String
F1
名单类型
1-白名单
2-黑名单
1.1.11
BizInfo
DailyMaxCount
?
Number
V10
每日下发的最大条数(0代表不限制)
1.1.12
BizInfo
MonthlyMaxCount
?
Number
V10
每月下发的最大条数(0代表不限制)
1.1.13
BizInfo
ForbidStart
?
String
F6
不允许下发开始时间
HHMISS
1.1.14
BizInfo
ForbidTerm
?
String
F6
不允许下发结束时间
HHMISS
1.1.15
BizInfo
ECAdminTel
1
String
V20
EC管理员手机号
1.1.16
BizInfo
OtherCarrier
1
String
F1
是否支持异网
0-否
1-是
1.1.17
BizInfo
BusiAlias
1
String
V50
业务别名
1.1.18
BizInfo
MOServCode
?
String
V21
短信上行点播码
彩信业务必填
1.1.19
BizInfo
ProductID
1
String
V32
订购关系编码
用于关联成员变更文件
1.1.20
BizInfo
OrderNumber
1
String
V32
订单编号
全局唯一的订单流水号,平台需要记录这个流水号,用于将来的数据一致性比对。
对于发生业务变更的,每次会产生新的订单流水号,平台必须保存全部的流水号对应关系。
1.1.21
BaseInfo
POID
1
String
V32
产品包订购关系ID
同一产品包订购关系ID的产品共享套餐
1.1.22
BaseInfo
ProdID
1
String
V32
产品订购关系ID
BBOSS保证产品订购关系的惟一性
系统大圈类应答报文的消息头和消息体存于同一XML消息中,消息头格式参见参考文档《网状网总册1.0.8》中SN-T模块消息头说明,现只描述报文体节点SvcCont。
(2)应答SvcCont:
序号
父元素名称
元素名称
约束
类型
长度
描述
取值说明
1
InterBOSS
SvcCont
1
——
——
应答报文体
1.1
SvcCont
BizInfoRsp
1.1.1
BizInfoRsp
RspCode
1
String
F4
返回码
见返回码
1.1.2
BizInfoRsp
RspDesc
?
String
V200
错误描述
当RspCode为5599时此节点必须填写
1.1.3
BizInfoRsp
RspDateTime
1
String
F14
应答时间
YYYYMMDDHHMISS日期时间格式
3.3.4.3.返回码
编码
描述
0000
成功
4501
SPID未找到
4502
操作代码错误
4503
业务类别错误
4504
名单类别错误
4505
订单号重复
4506
产品订购关系重复
5599
云MAS平台内部错误,必须在错误描述中注明
3.4.开通状态通知
3.4.1.业务功能
所有的业务订购、变更、注销订单完成后,BBOSS会向云MAS平台同步开通状态通知,如果开通状态通知是成功归档,业务平台需要记录这个归档时间,用于数据一致性核对,如果开通失败通知是开通失败,则平台需要检查平台的开通状态,如果平台侧已经开通成功,则需要进行回退,回退到开通/变更/注销之前的状态。
但是如果平台在收到开通报文与归档报文之间,又收到了关于该业务订购的其它开通请求,则以后来这个开通请求为准。
3.4.2.业务流程
开通状态通知是BBOSS将开通状态同步给云MAS平台的过程。
3.4.3.业务属性
BBOSS向云MAS平台同步开通状态通知:
BIP
冲正处理
没有
安全性要求
无
交易组成
开通状态通知
业务编码:
分业务进行编码,如下表所列:
业务名称
业务编码
开通状态通知
BIP4B884
3.4.4.交易单元
3.4.4.1.交易属性
开通状态通知:
T4101739
名称
取值
交易类型
10:
通知类流程
对帐标记
参与对帐
安全性:
密码加密
0:
不需要
安全性:
防篡改
0:
不需要
存储模式
0:
报文头、报文体存文件
交易发起方代码
交易落地方代码
3.4.4.2.交易报文
系
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 中国移动 BBOSS MAS 平台 接口 规范