中国联通综合增值业务平台（VASP）接口技术要求.doc

中国联通公司发布××××-××-××实施××××-××-××发布中国联通综合增值业务平台（VASP）接口技术要求：VASP和第三方的接口Parlay X分册v1.0QB/CU ×××××××中国联通公司企业标准目 次目 次I前 言V中国联通综合增值业务平台（VASP）接口技术要求：VASP和第三方的接口Parlay X分册v1.011 范围12 规范性引用文件13 缩略语24 术语定义25 Parlay X API在网络中的位置36 公共数据定义36.1 Web Service技术使用36.2 详细服务描述46.3 SOAP HEADER 定义46.4 XML Schema数据类型定义56.5 公共异常定义67 第三方呼叫107.1 概述107.2 应用场景107.3 序列图117.4 数据类型117.5 接口定义127.6 差错定义147.7 服务策略148 呼叫通知148.1 概述158.2 应用场景158.3 序列图158.4 数据类型158.5 接口定义168.6 差错定义208.7 服务策略209 增强型呼叫219.1 概述219.2 应用场景219.3 数据类型219.4 接口定义259.5 差错定义309.6 服务策略3010 短消息3010.1 概述3110.2 应用场景3110.3 序列图3210.4 数据类型3310.5 接口定义3410.6 差错定义3910.7 服务策略4011 多媒体消息4011.1 概述4011.2 应用场景4111.3 序列图4111.4 数据类型4211.5 接口定义4411.6 差错定义4811.7 服务策略4812 支付（可选）4912.1 概述4912.2 应用场景4912.3 序列图4912.4 数据类型5012.5 接口定义5012.6 差错定义5712.7 服务策略5713 帐户管理（可选）5813.1 概述5813.2 序列图5813.3 数据类型6013.4 接口定义6113.5 差错定义6313.6 服务策略6414 终端状态（可选）6414.1 概述6414.2 应用场景6414.3 序列图6414.4 数据类型6714.5 接口定义6814.6 差错定义7214.7 服务策略7215 终端定位7215.1 概述7215.2 应用场景7215.3 序列图7215.4 数据类型7615.5 接口定义7815.6 差错定义8315.7 服务策略8416 GIS8516.1 概述8516.2 应用场景8516.3 数据类型8616.4 接口定义8617 呼叫处理（可选）9017.1 概述9017.2 应用场景9017.3 序列图9117.4 数据类型9217.5 接口定义9417.6 差错定义9617.7 服务策略9618 音频呼叫9618.1 概述9618.2 序列图9718.3 数据类型9918.4 接口定义10018.5 差错定义10318.6 服务策略10319 多媒体会议（可选）10319.1 概述10319.2 应用场景10319.3 序列图10319.4 数据类型10819.5 接口定义11019.6 差错定义11520 地址列表管理11620.1 概述11620.2 应用场景11620.3 序列图11620.4 数据类型11820.5 接口定义11920.6 差错定义12720.7 服务策略12821 呈现12821.1 概述12821.2 应用场景12821.3 序列图12921.4 数据类型13121.5 接口定义13521.6 差错定义14321.7 服务策略14422 非结构化补充业务数据（可选）14422.1 概述14422.2 应用场景14422.3 数据类型14422.4 接口定义14522.5 差错定义14822.6 服务策略14823 即时消息14823.1 概述14823.2 应用场景14823.3 序列图14923.4 数据类型14923.5 接口定义14923.6 差错定义15223.7 服务策略15224 WapPush15224.1 概述15224.2 应用场景15324.3 序列图15324.4 数据类型15424.5 接口定义15524.6 差错定义15724.7 服务策略15725 彩E消息15725.1 概述15725.2 应用场景15725.3 数据类型15825.4 接口定义15925.5 差错定义16325.6 服务策略163前 言本标准主要内容基于我国行业标准基于互联网服务（Web Service）的开放业务接入应用程序接口（Parlay X）技术要求,并增加了WAP Push能力集。行业标准基于互联网服务（Web Service）的开放业务接入应用程序接口（Parlay X）技术要求对应于欧洲电信标准协会（ETSI）标准 ETSI ES 202 391 Open Service Access（OSA）Parlay X Web Services Part 114 部分，某些接口做了部分的修改和补充，并且不限于欧洲电信标准协会（ETSI）标准的内容，增加了增强的呼叫处理、非结构化补充业务数据（USSD）、即时消息等内容。本标准适用于中国联通综合增值业务平台与SP/CP接口的Parlay X部分。本标准主要用于中国联合通信有限公司综合增值业务平台的网络规划与建设、设备采购、工程设计、通信组织、网络运行维护和管理，同时为中国联通各种增值业务系统的建设提供技术依据，是中国联通综合增值业务平台规划和建设的基本依据。中国联通综合增值业务平台标准体系的主要内容包括下列企业标准：1.中国联通综合增值业务平台（VASP）技术体制 v1.02.中国联通综合增值业务平台（VASP）接口技术要求（总册）v1.03.中国联通综合增值业务平台（VASP）接口测试规范（总册）v1.04.中国联通综合增值业务平台（VASP）接口技术要求：VASP和第三方的接口 Parlay 分册 v1.05.中国联通综合增值业务平台（VASP）接口测试规范：VASP和第三方的接口 Parlay分册 v1.06.中国联通综合增值业务平台（VASP）接口技术要求：VASP和第三方的接口 Parlay X分册 v1.07.中国联通综合增值业务平台（VASP）接口测试规范：VASP和第三方的接口Parlay X分册 v1.08.中国联通综合增值业务平台（VASP）业务流程及性能测试规范 v1.09.中国联通综合增值业务平台（VASP）设备技术要求：业务管理系统部分 v1.010.中国联通综合增值业务平台（VASP）设备技术要求：业务系统部分 v1.0本标准主要起草单位： 本标准主要起草人： 本标准的修改和解释权属中国联通公司。中国联通综合增值业务平台（VASP）接口技术要求：VASP和第三方的接口Parlay X分册v1.01 范围本标准规定了Parlay X Web Service 应用程序接口（API）的体系结构、网络中的位置、应用场景、数据类型、接口定义、差错定义、服务策略等方面的要求。本标准适用于中国联通综合增值业务平台与SP/CP接口的Parlay X部分。2 规范性引用文件下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。YDN 088-1998 自动交换电话（数字）网技术体制ETSI ES 202 391-01 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第1部分：公共数据定义ETSI ES 202 391-02 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第2部分：第三方呼叫ETSI ES 202 391-03 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第3部分：呼叫通知ETSI ES 202 391-04 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第4部分：短消息ETSI ES 202 391-05 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第5部分：多媒体短消息ETSI ES 202 391-06 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第6部分：支付ETSI ES 202 391-07 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第7部分：帐户管理ETSI ES 202 391-08 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第8部分：终端状态ETSI ES 202 391-09 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第9部分：终端定位ETSI ES 202 391-10 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第10部分：呼叫处理ETSI ES 202 391-11 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第11部分：语音呼叫ETSI ES 202 391-12 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第11部分：多媒体会议ETSI ES 202 391-13 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第12部分：地址列表管理ETSI ES 202 391-14 V1.1.1 (2005-03) 开放业务接入（OSA）;Parlay X 网络服务;第14部分：呈现3GPP TS 23.003 编号、寻址和认证WS-I Basic Profile Version 1.0 最终材料W3C Note (15 March 2001): "Web Services Description Language (WSDL) 1.1"W3C Note (15 March 2001) 网络服务描述语言(WSDL)1.1W3C Recommendation （28 October 2004）：XML Schema 第二部分:数据类型第二版WS- Security（OASIS Standard 200401 (March 2004) 网络服务安全SOAP消息安全 1.0 (WS-Security 2004)XML Schema（W3C 建议 (2 May 2001): "XML Schema 第二部分: 数据类型"3 缩略语下列缩略语适用于本标准。APIApplication Programming Interface应用程序接口3GPPThird Generation Partnership Project3G合作伙伴计划ETSIEuropean Telecommunications Standards Institute欧洲电信标准协会HTTPHyperText Transfer Protocol超文本传输协议IMInstantMessage即时消息IPInternet ProtocolInternet 协议ITInformation Technology信息技术OASISOrganization for the Advancement of Structured Information Standards结构化信息标准促进组织OSAOpen Service Access业务开放接入PSTNPublic Switched Telephone Network公共电话交换网RFCRequest For Comment请求注解SIPSession Initiation Protocol会话初始协议SLAService Level Agreement服务等级协定SOAPSimple Object Access Protocol简单对象访问协议URIUniform Resource Identifier统一资源标识符USSDUnstructured Supplementary Service Data非结构化补充业务数据W3CWorld Wide Web Consortium万维网联盟WSDLWeb Service Definition LanguageWeb Service 定义语言WS-IWeb Services-Interoperability OrganizationWeb Service 服务互操作性组织XMLExtensible Markup Language可扩展标记语言XSDXML Schema DefinitionXML Schema 定义4 术语定义北向接口：在本系列标准中是业务系统与CP/SP的接口的简称。东西接口：在本系列标准中是业务系统与业务管理系统的接口的简称。南向接口：在本系列标准中是业务接入层与业务能力层的接口的简称。5 Parlay X API在网络中的位置图1Parlay X API在网络中的位置由图1可见，Parlay X Web Services APIs位于现有网络之上，现有网络的网络单元通过Parlay X Web Services 网关与应用服务器进行交互，从而提供第三方业务或综合的业务。Parlay X Web Services网关可以直接与网元连接，也可以通过Parlay/OSA网关与网元连接。Parlay X Web Services网关与应用服务器之间的接口为Parlay X Web Services APIs，与Parlay/OSA网关之间的接口为Parlay APIs，与现有网络的网络单元之间的协议采用各个网络的现有协议。6 公共数据定义6.1 Web Service技术使用6.1.1 Web Service消息内容6.1.1.1 SOAP所有的Web Service消息应使用符合WS-I基本纲要（WS-I Basic Profile Version 1.0: "Final Material"）的SOAP使用定义来发送和接收消息，编号方式使用document/literal。发起业务请求时，在SOAP HEADER里设置Token、ServiceKey、VaspID、VasID参数，然后在服务器端进行提取该参数，进行相应处理。6.1.1.2 XML所有的Web Service消息应使用符合WS-I基本纲要（WS-I Basic Profile Version 1.0: "Final Material"）的XML使用定义来发送和接收消息。6.1.1.3 HTTP所有的Web Service消息应使用符合WS-I基本纲要（WS-I Basic Profile Version 1.0: "Final Material"）的HTTP使用定义来发送和接收消息。6.1.2 Web Service接口定义6.1.2.1 WSDL所有的ParlayX Web Service应使用WSDL1.1规范（W3C Note (15 March 2001): "Web Services Description Language (WSDL) 1.1"）来定义，且应遵从WS-I基本纲要（WS-I Basic Profile Version 1.0: "Final Material"）的WSDL使用定义。6.1.3 ParlayX Web Service安全性如果一个消息包含一个标识符及/或代表消息发送者的信用度，那么这些应使用在WS- Security（OASIS Standard 200401 (March 2004): "Web Services Security: SOAP Message Security 1.0 (WS-Security 2004)"）中描述的方式提供。Web Service提供者可能要求消息内容的加密。如果要求，则应用以下方式之一完成：Ø 使用一个虚拟专用网，独立于Web Service的实现进行管理；Ø 使用在WS-I基本纲要（WS-I Basic Profile Version 1.0: "Final Material"）中描述的基于TLS的HTTP来作为传输层安全。消息内容的完整性应使用XML数字签名来完成（W3C Recommendation (12 February 2002): "XML-Signature Syntax and Processing"）。6.1.4 XML数据类型标准的XML数据类型参见XML Schema（W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes"）的第三章。6.2 详细服务描述6.2.1 地址数据固定用户终端标识的编号计划遵循YDN 088-1998自动交换电话（数字）网技术体制中对编号计划的规定。移动用户终端标识的编号规则遵循3GPP TS 23.003Numbering, addressing and identification中对MSISDN号的规定。SIP地址的编号规则遵循RFC 3261的相关规定。6.3 SOAP HEADER 定义6.3.1 数据类型6.3.1.1 EndReason枚举值描述0表示业务成功-1表示无效1业务失败，用户原因2业务失败，CP/SP6.3.2 SOAP HEADER 定义6.3.2.1 下行SOAP HEADER 参数参数名类型描述SpIdxsd:stringSPSpPasswordxsd:stringSPTimeStampxsd:string时间戳格式为：MMDDHHMMSS（月日时分秒）ServiceIdxsd:string业务IDSPNumberxsd:string业务接入码。可选SessionIDxsd:string业务流水号，用于组合业务。可选SessionEndEndReason交易结束标识，用于组合业务。可选LinkIDxsd:string事务关联ID，用于点播业务的事务关联，由平台产生。格式如下：MMDDHHMMSS+10位随机序列号；为空(二进制0)表示无效。可选OAxsd:string业务订购地址。群发时不填FAxsd:string付费地址。可选Group Messagingxsd:boolean True：群发 False：非群发缺省为False6.3.2.2 上行SOAP HEADER 参数参数名类型描述SPrevIDxsd:stringSP反向调用名，可选SPrevpasswordxsd:stringSP反向调用密码，可选SpIdxsd:stringSPSPNumberxsd:string业务接入码ServiceIdxsd:string业务ID。可选SessionIDxsd:string业务流水号，用于组合业务。可选LinkIDxsd:string事务关联ID，用于点播业务的事务关联，由平台产生。格式为：MMDDHHMMSS+106.4 XML Schema数据类型定义6.4.1 TimeMetricsValues数据类型为枚举型。值描述Millisecond毫秒Second秒Minute分Hour小时Day日Week星期Month月Year年6.4.2 TimeMetric数据类型为结构。名称类型描述MetricTimeMetricValues计量单位Unitsxsd:int数值6.4.3 ChargingInformation数据类型为结构。名称类型描述Descriptionxsd:string计费信息文字描述Currencyxsd:stringISO 4217 12 中定义的流通检验标志(可选)Amountxsd:decimal计费总计(可选)Codexsd:string计费代码，指明一个计费合约6.4.4 ServiceError数据类型为结构。名称类型描述MessageIdxsd:string消息标识Textxsd:string消息说明Variablesxsd:string 0.unbounded变量6.4.5 SimpleReference数据类型为结构。名称类型描述Endpointxsd:anyURI端口InterfaceNamexsd:string接口名称Correlatorxsd:string关联标识6.4.6 ContentID含义：内容编码数据类型：为结构，定义如下：参数类型描述ContentIDxsd:anyURI内容ID，最大长度40位，右对齐6.5 公共异常定义6.5.1 业务异常业务异常消息使用保留的消息标识符SVC，并使用从0001到0999的号码来定义。其中0001至0199被保留作公共差错定义，0200至0999作为其它Parlay X Web Service指定用途。从10000至9999可被第三方使用。名称类型描述MessageIdxsd:string消息标识符，前缀为SVCTextxsd:string消息文本，可变可替代部分用%来标识。Variablesxsd:string 0.unbounded替代文本字串中的可变部分。6.5.1.1 SVC0001: 业务错误名称描述Message IdSVC0001Text发生了一个业务错误。错误代码是%1。Variables来自业务的%1错误码，支持它是有意义的，且可列入产品文档。6.5.1.2 SVC0002: 不合法的输入值名称描述Message IdSVC0002Text消息部分%1有不合法的输入值。Variables%1消息部分。6.5.1.3 SVC0003: 不合法的输入值包含部分合法值名称描述Message IdSVC0003Text消息部分%1有不合法的输入值，%2是合法值。Variables%1消息部分；%2合法值列表。6.5.1.4 SVC0004: 不合法地址名称描述Message IdSVC0004Text消息部分%1未提供合法地址。Variables%1消息部分。6.5.1.5 SVC0005: 重复关联符名称描述Message IdSVC0005Text消息部分%2中描述的关联符%1是重复的。Variables%1关联符。%2消息部分。6.5.1.6 SVC0006: 不合法的组名称描述Message IdSVC0006Text消息部分%2中的组%1不是一个合法的组。Variables%1不合法的组的标识符。%2消息部分。6.5.1.7 SVC0007：请求计费策略指示名称描述Message IdSVC0007Text不合法的计费信息。Variables无。6.5.1.8 SVC0900: 鉴权失败，用户原因名称描述MessageIdText鉴权失败，用户原因Variables无6.5.1.9 SVC0901: 鉴权失败，SP 原因名称描述MessageIdText鉴权失败，SP原因VariablesNone.6.5.1.10 SVC0902: 因内容过滤，被拒绝名称描述MessageIdText因内容过滤被拒绝VariablesNone.6.5.2 策略异常策略异常消息使用保留的消息标识符POL，并使用从0001到0999的号码来定义。其中0001至0199被保留作公共差错定义，0200至0999作为其它Parlay X Web Service指定用途。从10000至9999可被第三方使用。名称类型描述MessageIdxsd:string消息标识符，前缀为POLTextxsd:string消息文本，可变可替代部分用%来标识。Variablesxsd:string 0.unbounded替代文本字串中的可变部分。6.5.2.1 POL0001: 策略错误名称描述Message IdPOL0001Text发生了一个策略错误。错误代码是%1。Variables来自业务的%1错误码，支持它是有意义的，且可列入产品文档。6.5.2.2 POL0002: 隐私证实失败名称描述Message IdPOL0002Text对地址%1的隐私证实失败了，请求被拒绝。6.5.2.3 POL0003: 过多的地址名称描述Message IdPOL0003Text在消息部分%1中描述了过多的地址。Variables%1消息部分。6.5.2.4 POL0004: 不支持无限制的通知请求名称描述Message IdPOL0004Text不支持无限制的通知请求。Variables无。6.5.2.5 POL0005: 请求了过多的通知名称描述Message IdPOL0005Text请求了过多的通知。Variables无。6.5.2.6 POL0006: 组不被允许名称描述Message IdPOL0006Text在消息部分%1中描述的组不被允许。Variables%1消息部分。6.5.2.7 POL0007: 嵌套的组不被允许名称描述Message IdPOL0007Text在消息部分%1中描述的嵌套的组不被允许。Variables%1消息部分。6.5.2.8 POL0008: 计费不被支持名称描述Message IdPOL0008Text计费不被支持。Variables无。6.5.2.9 POL0009: 请求的频率不合法名称描述Message IdPOL0009Text请求的频率不合法。Variables无。6.5.2.10 POL0900:不支持群发名称描述Message IdPOL0900Text不支持群发请求。Variables无。6.5.2.11 POL0903:超过状态保留时长名称描述Message IdPOL0903Text超过状态保留时长。Variables无。6.5.2.12 POL0904: 超过流量门限名称描述Message IdPOL0904Text超过流量门限Variables无6.5.2.13 POL0905: 不被支持操作或请求名称描述Message IdPOL0905Text系统不支持该API调用。Variables无6.5.2.14 POL0906: 不被允许操作或请求名称描述Message IdPOL0906Text不被允许操作或请求Variables无6.5.2.15 POL0907: 不允许群发请求名称描述Message IdPOL0907Text不允许群发请求Variables无7 第三方呼叫7.1 概述当前，为了在电信网络中执行一个第三方的呼叫，在写应用时必须使用专门的协议来接入网元提供的呼叫控制功能（特别是从应用初始发起呼叫的操作）。这种方式要求对网络有高度的专业知识。另一种方式是，调用标准接口通过Parlay/OSA网关来接入到呼叫控制能力，但是这些接口通常对IT应用开发商来说过于复杂。开发商必须掌握高级电信技能才能使用呼叫控制OSA接口。本文描述第三方呼叫Parlay X Web Service，用于创建并管理应用发起的呼叫。此Web Service的范围就是以简单的方式为应用开发商提供创建呼叫的功能。事实上，通过使用这个第三方呼叫Web Service，应用开发商不需要掌握详细的电信知识，就能调用呼叫处理功能。7.2 应用场景图2展示了使用第三方呼叫Web Service来处理第三方呼叫功能的场景。应用调用一个web service来获取股票价格，然后通过Parlay X接口在经纪人及其客户之间发起一个第三方的呼叫。在这个场景中，无论何时，当一只特定股票的价格达到某个门限时（步骤1和2），应用将在一个或多个经纪人及其相应客户之间调用第三方呼叫，以使他们及时联系，协商下一步采取的行动。在应用发起调用之后（步骤3），第三方呼叫Web Service调用一个Parlay API方法（步骤4），使用Parlay/OSA SCS-CC（呼叫控制）接口。这个SCS处理调用，并发送消息（步骤5）给MSC，以在用户A和B之间建立呼叫。步骤4和5的Parlay API交互可用第三方呼叫Web Service和移动网络之间的直接交互来替代。图2第三方呼叫场景7.3 序列图7.3.1 “点击拨号”呼叫建立点击拨号是一个通用集中应用，在一个统一服务入口，提供一个网页，在两个电话间发起呼叫。这个序列图展示了在入口处一个基本呼叫的建立和结束。 : End User : Self Serve Portal : Third Party Call Web ServiceAccess portalUse Click to Dial pageMake callCall identifierReport call in progressSome discussionClick on end call图3“点击拨号”呼叫建立7.4 数据类型7.4.1 CallInformation含义：呼叫信息类型数据类型：为结构，定义如下：参数类型描述callStatusCallStatus呼叫当前的状态startTimeDateTime呼叫开始的时间 当 (callStatus <> CallInitial)时durationInteger呼叫时长（秒）terminationCauseCallTerminationCause呼叫结束的原因7.4.2 CallStatus含义：呼叫状态数据类型：枚举类型，定义如下：参数描述CallInitial呼叫正在发起CallConnected呼叫已建立CallTerminated呼叫已结束7.4.3 CallTerminationCause含义：呼叫结束的原因数据类型：枚举类型，定义如下：参数描述CallingPartyNoAnswer主叫无应答CalledPartyNoAnswer被叫无应答CallingPartyBusy主叫忙CalledPartyBusy被叫忙CallingPartyNotReachable主叫不可达CalledPartyNotReachable被叫不可达CallHangUp任意一方挂机导致呼叫结束CallAborted呼叫终止（其他的任何原因）7.5 接口定义7.5.1 接口: ThirdPartyCall该接口适用于APP侧触发，发起呼叫请求。包括四个API：Ø MakeCall：发起呼叫。Ø GetCallInformation：获取呼叫进展信息。Ø EndCall：结束呼叫。Ø CancelCall：取消呼叫请求。7.5.1.1 操作: MakeCall第三方触发一语音增值业务，通过MakeACall指示网关发起业务呼叫。网关呼通主叫，再连接被叫。作为可选，应用（APP）还可以提供计费（charging）指示，例如，一个运营商特定的计费方案的名字，这个计费方案规定了对谁计费，以及费率如何。返回的参数（callIdentifier）用于标识此呼叫，APP可以用它来监视这个呼叫的状态，为获取呼叫状态信息，应用必须调用getCallInformation。7.5.1.1.1 输入: MakeCallRequest参数类型描述callingPartyxsd:anyU