《数据业务管理平台接口规范SP分册.docx》由会员分享,可在线阅读,更多相关《数据业务管理平台接口规范SP分册.docx(28页珍藏版)》请在课桌文档上搜索。
1、数据业务管理平台接口规范SP分册移动数据业务管理平台(DSMP)接口规范MobiIeDataServiceManagementPlatformInterfaceSpecification版本号:1.5.02003-1-31 实施2003-1-31公布前言in1适用范围12引用标准23有关术语与缩略语解释34接口命名规范45接口在网络中的位置56系统接口描述66.1 DSMP对外接口描述66.2 接口消息实现77字段类型说明78DSMP接口定义78.1 DSMP与业务网关之间的接口(Sg接口)78.2 DSMP与BOSS系统接口(Mb接口)78.3 DSMP与SCP接口(SSCP接口)78.4
2、DSMP与客服/I860之间的接口(Sk接口)78.5 DSMP之间的接口(Sim接口)88.6 DSMP与SP之间的接口(Ma接口)88.6.1 DSMP与SP之间接口消息定义88.6.2 DSMP与SP之间接口消息体定义89返回值的统一定义1010编制历史14附录A模式(schema)描述15Schema字段描述15附录BDSMP与SCP之间通信协议中共用的通用元素的定义16附录CDSMP平台WebServices数据类型定义16附录DDSMP平台WebSerViCeS接口定义与SoAP绑定181DSMP平台WebSerViCe接口设计与开发准则182举例说明193DSMP接口的WSDL定
3、义22前言本接口规范规定了中国移动通信集团公司移动数据业务管理平台(DSMP)涉及到的接口与协议规范,包含DSMP与SMS、MMSKJAVA、WAP等业务网关之间的接口/协议,DSMP与MAlL等应用平台之间的接口/协议,DSMP与BOSS之间的接口/协议,DSMP与SCP之间的接口/协议。本接口规范是集团公司开展移动数据业务的根据。本标准由中国移动通信集团公司技术部提出并归口。本标准由标准提出并归口部门负责解释。本标准起草单位:中国移动研发中心、中国移动香港卓望数码有限公司。本标准要紧起草人:魏冰、周彬、陈瑞卿、段晓东、王崇萍。本标准解释单位:同提出单位。1适用范围本规范规定了中国移动数据业
4、务管理平台与各个业务网关与应用平台之间的接口,以保证系统的互连互通及业务的实现。本规范要紧适用于中国移动数据业务管理平台,提供管理平台与业务平台之间的连接的规范与技术实现规范。本规范描述的是数据业务在运营过程中涉及到的业务接口,有关网管、系统管理的接口不在本规范的描述范围之内,具体请参见设备规范。与BoSS系统的接口规范也不包含在本接口规范中,具体请参见中国移动通信集团公司BOSS与业务平台接口规范。2引用标准下列标准所包含的条文,通过在本标准中引用而成为本标准的条文。本标准出版时,所示版本均为有效。所有标准都会被修订,使用本标准的各方应探讨使用下列标准最新版本的可能性。|中国移动数据业务总体
5、技术要求2ISMG与SCP之间通信协议(事务层)规范(3J中国移动通信信息资源站实体与互联网短消息网关接口协议4移动梦网短信业务技术方案5中国移动多媒体消息业务规范6中国移动通信互联网短信网关接口协议7中国移动WLAN业务总体技术要求8中国移动WLAN业务规范9中国移动互联网技术体制10中国移动GPRS网络技术体制11 ITLLT建议Q.1228(09/97)智能网能力集2接口建议12 ITUjr建议X.500(11/93)VV信息技术一开放系统互连一目录13 ISMG与SCP通信协议(事务层)规范(VLO)14 ShortMessagePeertoPeerProtocolSpecificat
6、ionv3.4DSMPMISCBOSSSCPOTAKjavaJ2MEJAMCSDGPRSWAPAPNICPCDRFTPMISCLDAPMOMTAOATMMSMMSCISMGSMPPSMSCSMTPWAPSPSSO3有关术语与缩略语解释数据业务管理平台MobileInformationServiceCenter,移动信息服务中心BusinessOperationSupportSystem,业务运营支撑系统ServiceControlpoint,服务操纵点OverTheAir,即空中、无线方式。AkeycomponentofJava2Platform,MicroEditionJAVA2MicroE
7、dition,即小型手持系统使用的JAVA。JAVAApplicationManager,JAVA应用管理器CircuitSwitchData,电路交换数据GeneralPacketRadioService,通用无线分组业务WirelessApplicationProtocol,无线应用协议AccessPointNetwork,接入点网络InternetContentPrOVider,因特网内容提供商CallDetailRecord,呼叫全面记录FileTransferProtocol,文件传输协议MobileInformationServiceCentral移动信息业务中心1.ightwei
8、ghtDirectoryAccessProtocol,轻量级目录访问协议MobileOriginate,手机用户发起MobiIeTerminate,手机用户终止ApplicationOriented,应用发起ApplicationTerminated,应用终止MultimediaMessagingService,多媒体短消息服务MultimediaMessagingServiceCenter,多媒体断消息服务中心InternetShortMessageGateway,互联网短消息网关ShortMessagePeertoPeer,短消息点对点协议ShortMessageServiceCenter
9、,短消息中心SimpleMailTransferProtocol,简单邮件传输协议WirelessApplicationProtocol,无线应用协议ServiceProvider,服务提供商SingleSignOn,单点登录MPSMicroPaymentSystem,小额支付系统MPPMicroPaymentPlatform,小额支付平台MPAMicroPaymentAgent,小额支付代理LCSLocationService位置服务CMPPChinaMobilePeertoPeerprotocol,中国移动点对点协议IMAP4POP3RADIUSWWWInternetMessageAcce
10、ssProtocolversion4PostOfficeProtocolversion3RemoteAuthenticationDialInUserServiceWorldWideWebGSMGlobalSystemforMobileCommunications全球移动通信系统XMLextensibleMarkupLanguage,可扩展标记语言4接口命名规范接口名称使用单词首字母大写,其他字母小写的方式。缩略语中的字母都大写。消息内容定义中,基本数据类型的字段命名规范使用单词首字母大写,单词间没有连接符的方式。对用Schema定义的字段在单词间加T连接符。5接口在网络中的位置DSMP在整个数
11、据业务框架中处于核心地位,它是数据业务的基础设施。考虑到数据业务需求特点:数据业务需求变化快,应用的多样化、个性化需求高,应用的实效性要求很高,同时中国移动不可能提供所有的应用,需要与第三方配合。就要求DSMP具有高可靠性、灵活的扩展能力。承载网络GPRS/CSD/WAPGW/SMSC服务提供商SPI终端用户应用APP终端应用APP6系统接口描述6.1DSMP对外接口描述DSMP与外部实体之间的接口如下图所示:信令流管理流我们下面描述一下本规范需要定义的接口:Sg接口:DSMP与业务网关、SP代理、应用平台、PoRTAL之间的接口,DSMP通过该接口为业务网关、SP代理、应用平台、PORTAL
12、提供数据业务管理平台的用户与SP的有关资源。Sb接口:DSMP与BoSS系统的接口,该接口实现DSMP与BoSS系统之间的用户及业务信息同步、话单传递、鉴权、客户管理、统一账户功能。SSCP接口:DSMP与SCP的接口,DSMP通过该接口实现移动预付费用户的实时扣费。Sk接口:DSMP与客服/I860的接口。Sim接口:DSMP之间的接口,DSMP之间通过该接口用户的基本数据与订购关系及全网SP及服务的有关信息的同步。Ma接口:DSMP与SP之间的接口,DSMP通过该接口进行订购关系同步与在用户自助服务时设置于订购服务有关的属性。6.2接口消息实现7字段类型说明integer:十进制的整数型。
13、unsignedinteger:十进制的无符号整数型。string:由Char构成的字符串binary:由byte构成的字符串,由于XML不能直接承载二进制数据,因此对该类型的数据使用BASE64编码。8DSMP接口定义8.1 DSMP与业务网关之间的接口(Sg接口)8.2 DSMP与BOSS系统接口(Mb接口)8.3 DSMP与SCP接口(SSCP接口)8.4 DSMP与客服/1860之间的接口(Sk接口)8.5 DSMP之间的接口(Sim接口)8.6 DSMP与SP之间的接口(Ma接口)DSMP通过该接口将订购关系同步给SP,具体接口消息参见下表。在用户自助服务时,假如在用户订购服务时需要
14、设置与该服务有关的属性,则通过该接口修改于服务有关的属性。该接口是通过连接实现的。8.6.1 DSMP与SP之间接口消息定义消息名称消息描述SyncOrderRelationReq订购关系同步消息SyncOrderRelationResp订购关系同步应答消息8.6.2 DSMP与SP之间接口消息体定义8.6.2.1 订购关系同步消息接口消息定义(SynCOrderReIatiOnReq)8.6.2.1.1 功能描述此接口在DSMP由于某种情况更新了用户订购关系(包含订购、取消、暂停、激活)的时候,通过此接口发起与SP的更新订购关系的交互。消息名消息类型消息方向SyncOrderReIation
15、ReqRequestDSMPSPSyncOrderReIationRespResponseSPDSMP8.6.2.1.2接口内容描述SyncOrderRelationReq消息字段描述:返回定义重要性类型说明MsgType务必string消息类型TransactionID务必string该消息编号Version务必string该接口消息的版本号,本次所有的接口消息的版本都为“150”Send.Address务必addressinfoSChema发送方的地址Dest_Address务必addressinfoSChema接收方的地址FeeUser_ID务必USejid计费用户标识DestUser_
16、ID务必USer_id_schema使用用户标识LinkID可选string临时订购关系的事务IDActionID务必integer服务状态管理动作代码,具体值如下:1:开通服务;2:停止服务;3:激活服务;4:暂停服务;ActionReasonID务必integer产生服务状态管理动作原因的代码,具体值如下:1:用户发起行为2:Admin&1860发起行为3:Boss停机4:Boss开机5:BoSS过户6:BoSS销户7:BoSS改号8:扣费失败导致的服务取消9:其他SPID可选stringSP的企业代码SPServiceID务必stringSP中该服务的服务代码AccessMode可选In
17、teger服务的访问方式1:WEB2:WAP3:SMSFeatureStr可选binary服务订购参数字段名重要性类型说明MsgType务必string消息类型TransactionID务必string该消息编号Version务必string该接口消息的版本号,本次所有的接口消息的版本都为“150”hRet务必integer返回值,全面定义见第9章9返回值的统一定义具体描述如下:O:成功1:未知错误2-99:保留100-999为业务网关与DSMP之间的接口消息中的错误代码,如下:100:手机号码不存在101:手机号码错误102:用户停机103:用户欠费104:用户没有使用该业务的权限105:业
18、务代码错误106:服务代码错误107:业务不存在108:该业务暂停服务109:该服务种类不存在IiO:该服务种类尚未开通Ill:该业务尚未开通112:SP代码错误113:SP不存在114:SP暂停服务115:用户没有定购该业务116:用户暂停定购该业务117:该业务不能对该用户开放118:用户已经订购了该业务119:用户不能取消该业务120:话单格式错误121:没有该类业务122:接收特殊123:业务价格为负124:业务价格格式错误125:业务价格超出范围126:该用户不是神州行用户127:该用户没有足够的余额128:补款,冲正失败129:用户已经是梦网用户130:用户在BOSS中没有有关用户
19、数据131:BOSS系统数据同步出错132:有关信息不存在133:用户数据同步出错134:SP数据同步出错135:业务数据同步出错136:用户密码错误137:伪码信息错误138:用户有关信息不存在DSMP与SCP之间的接口消息中的错误代码定义如下:200:205:206:207:208:209:正常应答注册成功注册不成功注销成功注销失败无临时话单400:401:413:服务器端无法懂得请求CMPP包用户未被认证,应答包中包含AUthemiCate,要用户认证请求实体太长414:梦网内部实体间的XML消息体错误415:SP发给GW的XML消息体错误500:服务器的内部处理出错501:服务器忙,拒
20、绝请求502:GW与SCP的连接中断,拒绝请求505:版本号不支持506:服务器方超时4000-4999为DSMP与SP之间的接口消息中的错误代码:4000:无效的msgtype4001:无效的action_id;4002:无效的action_reasonid;4003:无效的SPlD4004:无效的ServiceID4005:无效的pseudocode4006:无效的accessmode4007:MISC同步开通服务,但SP端已存在订购关系,且状态为开通4008:MISC同步开通服务,且SP端不存在订购关系,但开通服务失败4009:MISC同步开通服务,但SP端已存在订购关系,且状态为暂停4
21、010:MISC同步停止服务,且SP端存在订购关系,但取消服务失败4011:MISC同步停止服务,但SP端不存在订购关系4012:MISC同步暂停服务,且SP端存在订购关系,但暂停服务失败4013:MISC同步暂停服务,但SP端不存在订购关系4014:MISC同步暂停服务,但SP端已存在订购关系,且状态为暂停4015:MISC同步激活服务,但SP端已存在订购关系,且状态为开通4016:MISC同步激活服务,但SP端不存在订购关系4017:MISC同步激活服务,且SP端存在订购关系,但激活服务失败9000-9999为系统级错误:9000:系统磁盘读写错误9001:网络特殊9002:网络错误900
22、3:业务网关忙,业务网关缓存9004:业务网关忙,同时业务网关缓冲区满,DSMP缓存,并暂时不要发送消息,等待一段时间重试。9005:DSMP忙,DSMP缓存9006:DSMP忙,同时DSMP缓冲区满,业务网关缓存,并暂时不要发送消息,等待一段时间重试。9007:业务网关超过限制的流量9008:DSMP特殊,并不可用9009:9010:9011:9012:9013:9014:9015:业务网关特殊,并不可用该业务网关没有权限调用该接口消息DSMP没有权限发送该接口消息给业务网关版本不支持消息类型不对,系统不支持验证错误,无法解析SOAP与XML结构、缺少务必存在的字段,或者者消息格式不正确拒绝
23、消息,服务器无法完成请求的服务10编制历史版本号更新时间要紧内容或者重大修改1.0.02003年1月1.0.0版本1.5.02003年4月1.5.0版本附录A模式(SChema)描述Schema字段描述addressjnfo_schema(地址信息)字段名称字段类型字段描述Deviceiypeinteger设备类型0:DSMP100:ISMG101:WAPSPPROXY1XX:其他业务网关200:WAPPORTAL201:WWWPORTAL202:VOICEPORTAL203:PDAPORTAL2XX:其他门户300:MMSC301:KJAVASERVER302:LSP3XX:其它应用平台40
24、0:SPDeviceIDstring设备编号,设备编号使用各设备的入网编号,比如短信网关使用网关ID、对SP使用其企业代码,该设备编号由DSMP分配,同时在同一设备类型中该编号唯一USerJCLSehema(用户标识)字段名称字段类型字段描述UserIDTypeinteger用户标识类型1:用手机号标识2:用伪码标识3:两者同时标识MSISDNstring用户手机号PseudoCodebinary用户伪码附录BDSMP与SCP之间通信协议中共用的通用元素的定义附录CDSMP平台WebServices数据类型定义#(sequence附录DDSMP平台WebServices接口定义与SOAP绑定1
25、DSMP平台WebSerViCe接口设计与开发准则DSMP规范中的所有WebService接口根据W3C组织颁布的WebServicesDescriptionLanguage(WSDL)Ll(20010315)规范而设计与定义,并与WSDL标准后续版本中的有关规定的保持一致性。所有使用DSMP规范的产品的接口设计与开发应遵守下列原则:附录为DSMP规范定义了所有被引用到的类型与元素的命名空间及XML模式,此命名空间作用范围涵盖所有WSDL接口消息。SoAP消息中命名空间的使用方法见第2节的举例说明。接口的WSDL定义均应使用本规范提供的WSDL定义,内容详见本附录的第3节。部署WebServi
26、ceW,所有WSDL定义内容被包含在dsmp.wsdl文件中,并以公开的URL被引用。按照WSDL标准的规定,本规范接口的WSDL定义要紧包含如下部分: 类型(Types):本规范使用的是文件引用的方法,所有DSMP规范定义的消息类型被包含在dsmp.xsd文件中; 消息(MeSSage):即在调用过程中产生的请求或者响应的SOAP封装里的消息结构; 操作(Operation):被本规范定义的WebSerViCe所支持的动作的理论描述; 端口类型(PortType):被终端所支持的一套操作的集合的定义; 绑定(Binding):即SOAP绑定的定义部分,按照WSDLLI标准,端口类型被绑定到S
27、OAPLl协议,因而,任何使用DSMP规范的产品,不管使用何种支持WebSerViCe的中间件平台或者SOAP专用程序来实现WebServiceD,或者是调用WebSerViCe接口,均应支持对SoAPl.1的绑定。比如对调用者而言,只有向服务器端发送标准的SoAP封装消息包,才能得到正确的返回,否则均被视作调用格式错误; 端口(Port):即实现接口的程序的网络地址的定义; 服务(Sevice):即实现接口的一系列端口集。 SoAP绑定原则本规范定义的WebService接口与SOAPl.1协议格式相绑定,所有请求与响应消息均应使用SOAP格式的消息封装,包含SOAP封套(EnVeloPe)
28、,SOAP包头(Header)与SOAP包体(Body)三部分。对任何技术实现的调用者而言,发出的调用请求消息均须带有以上三部分内容,包头与包体消息结构中引用的类型均来自dsmp.xsd中的定义。但在SOAP包体中,假如按照规范定义某一参数为可选,则SOAP消息中可不包含标识该参数的元素。返回的SOAP消息结构同请求消息; 在本规范中,为支持事物处理而定义的TranSaetionlD参数被包含在SoAP包头中传送,因而,本规范要求所有SOAP消息均务必带有SOAP包头,接口程序应根据需要对SOAP包头中的TransactionID做相应的处理(用来标识事物或者忽略)。TransactionID
29、的产生规则是DeviceID+10位的数字,该10位数字从1开始,同时不足10位的前补0.每次增长的步长为1,依次循环使用。本规范中的WSDL与XSD里所定义的URI并非普遍适用,在实际部署的WebService平台产品中应被修改为真实可用的URL比如本规范中大量定义的用来定位WebService服务的URI为他业务网关上部署的WebService就应使用与其相适用的URL2举例说明本节以AuthPrice接口为例,来具体说明接口的SOAP绑定与调用规则。本接口范例是基于WebLogiC平台,用JaVa语言编程实现。务必注意,此例中的参数值无实际意义。SOAP请求与响应消息如下:SOAP请求消
30、息:Content-Type:text/xml;charset=utf-8Content-Length:lengthSoapAction:,sg.AuthPriceI100oooooooi1.5.0StringOlK/DeviceIDOlK/DeviceIDStringOStringbase64BinaryOStringbase64BinaryOStringString/SPServiceIOStringStringStringOSOAP响应消息:Content-Type:text/xml;charset=tf-8Content-Length:lengthI100oooooooiSOAP-EN
31、V:Header1.5.0StringOintegerstringbase64Binarystringbase64Binaryintegerintegerstringintegerstringstring12说明:2) XML命名空间的作用域声明方法包含缺省与限定两种。在上例的SoAP消息中混合使用了这两种规范有关定义的命名空间,而所有无前缀的标记均处于此作用域内。同时,SoAP封装标记均处于SOAP标准的命名空间作用域内;3)接口实现时也可使用限定的方法声明DSMP规范有关定义的命名空间作用域。如下所示的SoAP消息内容也是合法的,1100000000011.5.0String4)SoAP请求与响应消息务必带有SOAP包头,其中包含标识事物的TQnSaCtiOnID,交互双方根据需要对其做必要的处理;5)假设按照定义,参数FeeUSeHD,Service_ID,LinklD为可选参数,则如下的SOAP请求消息也是合法的,StringStringOllOllStringOStringbase64BinaryO上面的SoAP请求消息中省略了以上三个可选参数内容。但接口的实现程序应对可选参数做必要的缺省逻辑处理。3DSMP接口的WSDL定义outputmessage=,wsdlns:ma.SyncOrderRelat