- 1.71 MB
- 85页
- 1、本文档共5页,可阅读全部内容。
- 2、本文档内容版权归属内容提供方,所产生的收益全部归内容提供方所有。如果您对本文有版权争议,可选择认领,认领后既往收益都归您。
- 3、本文档由用户上传,本站不保证质量和数量令人满意,可能有诸多瑕疵,付费之前,请仔细先通过免费阅读内容等途径辨别内容交易风险。如存在严重挂羊头卖狗肉之情形,可联系本站下载客服投诉处理。
- 文档侵权举报电话:19940600175。
'中国网通(集团)有限公司发布QB/CNC-09-008-2006中国网通IPTV业务管理系统与支撑系统接口技术规范(V1.0)中国网通(集团)有限公司企业标准
目录1范围12规范性引用文件13IPTV业务管理系统概述14IPTV业务管理系统与支撑系统接口概述34.1接口框图和参考点描述34.2接口数据传递相关说明45IPTV业务管理系统与97系统接口55.1接口示意图55.2同步IPTV产品列表消息接口55.2.1接口描述55.2.2接口参数65.3添加IPTV产品接口75.3.1接口描述75.3.2接口参数85.4修改IPTV产品状态接口95.4.1接口描述95.4.2接口参数95.5同步IPTV产品计费策略接口105.5.1接口描述105.5.2接口参数105.6添加IPTV产品计费策略接口135.6.1接口描述135.6.2接口参数145.7修改IPTV产品计费策略状态接口145.7.1接口描述145.7.2接口参数145.8同步IPTV产品优惠策略接口155.8.1接口描述155.8.2接口参数155.9添加IPTV产品优惠策略接口165.9.1接口描述165.9.2接口参数165.10修改IPTV产品优惠策略状态接口165.10.1接口描述165.10.2接口参数165.11发送新开户用户资料接口165.11.1接口描述165.11.2接口参数165.12修改用户电话号码接口185.12.1接口描述185.12.2接口参数185.13修改用户姓名接口195.13.1接口描述195.13.2接口参数195.14修改用户IPTV业务密码接口195.14.1接口描述195.14.2接口参数205.15修改用户接入密码接口205.15.1接口描述20v
5.15.2接口参数205.16修改用户接入类型接口215.16.1接口描述215.16.2接口参数215.17修改用户接入带宽接口215.17.1接口描述215.17.2接口参数215.18修改用户接入区域代码接口225.18.1接口描述225.18.2接口参数225.19修改用户付费类型接口235.19.1接口描述235.19.2接口参数235.20修改用户状态接口235.20.1接口描述235.20.2接口参数245.21修改用户扩展信息接口245.21.1接口描述245.21.2接口参数245.22更新用户订购信息接口255.22.1接口描述255.22.2接口参数255.23用户更换机顶盒数据接口265.23.1接口描述265.23.2接口参数265.24发送用户消户消息接口275.24.1接口描述275.24.2接口参数275.25用户业务欠费停机数据接口275.25.1接口描述275.25.2接口参数285.26用户业务复机开通数据接口285.26.1接口描述285.26.2接口参数295.27发送机顶盒首次开机激活认证服务器域名接口295.27.1接口描述295.27.2接口参数306IPTV业务管理系统与IPTV接入认证系统接口306.1接口示意图306.2添加用户STB接入认证权限数据发送接口306.2.1接口描述306.2.2接口参数316.3删除用户STB接入认证权限数据接口326.3.1接口描述326.3.2接口参数326.4修改用户电话号码接口336.4.1接口描述336.4.2接口参数336.5修改用户姓名接口336.5.1接口描述336.5.2接口参数33v
6.6修改用户接入密码接口346.6.1接口描述346.6.2接口参数346.7修改用户接入类型接口346.7.1接口描述346.7.2接口参数356.8修改用户接入带宽接口356.8.1接口描述356.8.2接口参数356.9修改用户接入区域代码接口366.9.1接口描述366.9.2接口参数366.10修改用户付费类型接口366.10.1接口描述366.10.2接口参数376.11修改用户状态接口376.11.1接口描述376.11.2接口参数376.12修改用户扩展信息接口386.12.1接口描述386.12.2接口参数387IPTV业务管理系统与客服系统接口397.1接口示意图397.2查询用户信息数据接口397.2.1接口描述397.2.2接口参数397.3查询用户业务使用详单数据接口417.3.1接口描述417.3.2接口参数417.4发送用户投诉信息数据接口437.4.1接口描述437.4.2接口参数438IPTV业务管理系统与综合帐务系统接口448.1接口示意图448.2上传用户业务使用帐单消息接口448.2.1接口描述448.2.2接口参数448.3查询用户业务使用详单数据接口458.3.1接口描述458.3.2接口参数458.4实时出帐消息接口478.4.1接口描述478.4.2接口参数479IPTV业务管理系统与DSLAM网管系统接口4810IPTV业务管理系统与BSSP接口4910.1接口示意图4910.2IPTV业务管理系统至BSSP用户数据同步接口4910.2.1接口描述4910.2.2接口参数4910.3IPTV业务用户请求使用互联网业务重定向接口5010.3.1接口描述50v
10.3.2接口参数5010.4BSSP至IPTV业务管理系统用户数据同步接口5010.4.1接口描述5010.4.2接口参数5110.5互联网业务用户请求使用IPTV业务重定向接口5110.5.1接口描述5110.5.2接口参数5111IPTV业务管理系统与预付费管理系统接口5211.1接口示意图5211.2预付费用户扣费请求接口5211.2.1接口描述5211.2.2接口参数5211.3预付费用户余额查询接口5311.3.1接口描述5311.3.2接口参数5311.4预付费用户扣费记录对帐接口5411.4.1接口描述5411.4.2接口参数5412省级与区域中心IPTV业务管理系统接口5612.1接口示意图5612.2用户信息下发接口5712.2.1接口描述5712.2.2接口参数5712.3用户激活消息接口5912.3.1接口描述5912.3.2接口参数5912.4删除IPTV业务用户接口5912.4.1接口描述5912.4.2接口参数5912.5修改用户姓名接口6012.5.1接口描述6012.5.2接口参数6012.6修改用户IPTV业务密码接口6112.6.1接口描述6112.6.2接口参数6112.7修改用户接入类型接口6112.7.1接口描述6112.7.2接口参数6112.8修改用户接入带宽接口6212.8.1接口描述6212.8.2接口参数6212.9修改用户接入区域代码接口6312.9.1接口描述6312.9.2接口参数6312.10修改用户付费类型接口6312.10.1接口描述6312.10.2接口参数6312.11修改用户状态接口6412.11.1接口描述6412.11.2接口参数6412.12修改用户扩展信息接口65v
12.12.1接口描述6512.12.2接口参数6512.13同步IPTV产品列表消息接口6512.13.1接口描述6512.13.2接口参数6612.14添加IPTV产品接口6712.14.1接口描述6712.14.2接口参数6812.15修改IPTV产品状态接口6912.15.1接口描述6912.15.2接口参数6912.16更新用户订购信息接口6912.16.1接口描述6912.16.2接口参数6912.17用户业务欠费停机数据接口7012.17.1接口描述7012.17.2接口参数7112.18用户业务复机开通信息接口7112.18.1接口描述7112.18.2接口参数7212.19统计信息上传接口7212.19.1接口描述7212.19.2接口参数7312.20用户原始话单上传接口7312.20.1接口描述7312.20.2接口参数7312.21预付费扣费请求接口7412.21.1接口描述7412.21.2接口参数7412.22同步计费策略接口7512.22.1接口描述7512.22.2接口参数7512.23添加IPTV产品计费策略接口7612.23.1接口描述7612.23.2接口参数7612.24修改IPTV产品计费策略状态接口7712.24.1接口描述7712.24.2接口参数7712.25同步用户机顶盒ID与用户帐号绑定关系接口7812.25.1接口描述7812.25.2接口参数7812.26发送用户转向互联网业务主页面消息接口7912.26.1接口描述7912.26.2接口参数79v
1范围本规范规定了IPTV业务管理系统平台与运营支撑系统之间的接口模型,接口交互流程以及接口交互内容。本规范作为中国网通的企业应用标准,适用于IP网络环境下IPTV业务管理系统平台与运营支撑系统接口的开发。本规范只适用于中国网通内部。本规范的提出单位:中国网通集团有限公司本规范的归口管理单位:中国网通(集团)有限公司技术部本规范的起草单位:中国网通集团研究院中国网通(集团)有限公司技术部本标准主要起草人:张伦泳、陶蒙华、厉盛义、姜鹏2规范性引用文件《中国网通集团IPTV应用服务系统技术规范》《中国网通集团IPTV业务管理系统技术规范》《机顶盒与IPTV业务平台接口规范》CCSA《组播业务系统控制逻辑接口规范(征求意见稿)》3IPTV业务管理系统概述IPTV业务系统以省为单位进行建设。每个省分为一个或多个区域,每个区域包含一个或多个地市。每个区域由一家系统提供商提供全套IPTV解决方案(包括软件系统和配套设备)。图3-1IPTV业务管理系统建设方案第79页
IPTV业务管理系统包括用户管理,业务管理,机顶盒管理,DRM管理,统计分析,SP/CP管理,系统管理,门户管理以及计费帐务管理等功能。运营支撑系统包括97系统,IPTV接入认证系统,预付费管理系统,综合帐务系统,DSLAM网管系统,客服系统以及BSSP系统等。统计信息话单信息机顶盒激活信息订购信息产品信息用户信息区域中心IPTV业务管理系统功能认证授权系统管理话单生成统计分析省级IPTV业务管理系统功能用户管理业务管理SP/CP管理计费帐务统计分析系统管理门户管理DRM管理机顶盒管理图3-2省级系统与区域中心系统功能框图图中蓝色部分表示省级IPTV业务管理系统功能模块,红色部分表示各区域中心IPTV业务管理系统功能模块。中间绿色和橙色部分表示省级IPTV业务管理系统与各区域中心IPTV业务管理系统之间进行同步的数据信息。第79页
1IPTV业务管理系统与支撑系统接口概述1.1接口框图和参考点描述省级IPTV业务管理系统运营支撑系统97系统IPTV接入认证系统客服系统综合帐务系统DSLAM网管系统BSSP预付费管理系统ABCDEFG图4-1IPTV业务管理系统与支撑系统接口框图省级IPTV业务管理系统区域1IPTV业务管理系统区域2IPTV业务管理系统区域3IPTV业务管理系统HHH图4-2省级IPTV业务管理系统与支撑系统接口框图参考点A:IPTV业务管理系统与97系统之间的接口。IPTV业务管理系统通过该参考点向97系统发送IPTV产品列表。用户开户在97系统内完成。用户开户时,97系统通过该参考点向IPTV业务管理系统发送新开户的用户信息,包括用户基本信息和开户时选择的产品订购信息。用户开户之后:如果用户到营业厅修改用户信息,97系统首先通过该参考点直接修改IPTV业务管理系统中用户相关信息,修改成功后再修改本地对应的用户信息;如果用户通过机顶盒修改用户信息,修改成功后由IPTV业务管理系统通过该参考点修改97系统中对应的用户信息。97系统从综合帐务系统接收第79页
用户欠费停机消息、用户业务复机消息,并通过该参考点转发给IPTV业务管理系统。IPTV业务管理系统通过该参考点发送用户激活消息给97系统。参考点B:IPTV业务管理系统与IPTV接入认证系统之间的接口。IPTV业务管理系统通过该参考点向IPTV接入认证系统发送用户接入设备(ADSLmodem或STB)进行网络层接入认证时使用的相关权限信息。参考点C:IPTV业务管理系统与客服系统(如10060)之间的接口。客服系统通过该参考点向IPTV业务管理系统查询用户信息,包括用户产品订购信息、用户积分、用户IPTV业务详单等信;并通过该参考点向IPTV业务管理系统发送用户投诉信息。参考点D:IPTV业务管理系统与综合帐务系统之间的接口。IPTV业务管理系统通过该参考点向综合帐务系统发送用户业务使用帐单信息。综合帐务系统通过该参考点向IPTV业务管理系统查询用户业务使用详单信息等。参考点E:IPTV业务管理系统与DSLAM网管系统之间的接口。IPTV业务管理系统通过该参考点向DSLAM网管系统发送用户组播业务使用权限信息。参见CCSA《组播业务系统控制逻辑接口规范(征求意见稿)》(可能随时更新为正式行业标准)。参考点F:IPTV业务管理系统与BSSP系统之间的接口。IPTV业务管理系统通过该参考点向BSSP系统发送IPTV用户权限信息,并将IPTV用户使用宽带互联网业务的请求重定向到BSSP系统;BSSP系统通过该参考点向IPTV业务管理系统发送宽带互联网用户权限信息,并将宽带互联网用户使用IPTV业务的请求重定向到IPTV业务管理系统。参考点G:IPTV业务管理系统与预付费管理系统(如各类的卡系统)之间的接口。IPTV业务管理系统通过该参考点向预付费管理系统发起预付费用户扣费请求,查询预付费用户余额等操作;预付费管理系统定时将用户扣费情况以文本方式发送给IPTV业务管理系统完成对帐功能。参考点H:省级IPTV业务管理系统与各区域中心IPTV业务管理系统之间的接口。省级IPTV业务管理系统通过该参考点向各区域中心IPTV业务管理系统发送用户属性、产品属性、用户业务定购关系等数据。各区域中心IPTV业务管理系统通过该参考点向省级IPTV业务管理系统发送用户业务原始话单、用户业务使用情况统计等信息,以及预付费用户扣费请求。1.1接口数据传递相关说明(1)IPTV接入认证系统可以是现有宽带(拨号)接入认证系统,也可以是为IPTV单独设置的接入认证系统。如果IPTV用户的接入权限由97系统发送到接入认证系统中,则本规范中规定的IPTV业务管理系统与IPTV接入认证系统之间的接口不是必须的,仅供参考。(2)省级和区域中心IPTV业务管理系统中,以内容标识(contentID)做为唯一标识与内容管理、媒体交付等系统中的内容元数据建立对应关系。(3)接口参数中的“内容”可以是单个的影片或频道,也可以是多个影片或频道的组合。(4)接口上传递的用户密码、用户帐户余额等数据内容需经过加密后再进行传送,具体的加密/解密算法待定。第79页
(1)省级IPTV业务管理系统向区域IPTV业务管理系统发送数据时,需根据具体数据内容选择对应的区域发送数据,或向所有下辖区域发送数据。(2)本规范中规定的接口调用及接口参数取值是系统实现时必须支持的最小集,可根据需要进行必要扩充。(3)本规范中规定的接口调用中,“实时调用”一般表示由其他系统动作自动触发接口调用过程;“定时调用”一般表示根据预先设定的时间点或周期由系统自动调用;“手工调用”一般表示由系统操作人员根据需要不定时进行调用。1IPTV业务管理系统与97系统接口1.1接口示意图97系统省级IPTV业务管理系统发送IPTV产品列表消息发送新开户的用户资料用户消户消息用户业务欠费停机信息用户业务复机开通信息发送机顶盒首次开机激活认证服务器域名发送IPTV产品优惠策略消息发送IPTV产品计费策略消息用户更换机顶盒数据修改用户信息图5-1IPTV业务管理系统与97系统接口示意1.2同步IPTV产品列表消息接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP第79页
接口方向:省级IPTV业务管理系统→97系统调用接口:synProductListMessage接口功能:省级IPTV业务管理系统将IPTV产品列表发送到97系统中。备注说明:根据需要手工调用。用户开户时从产品列表中选择希望订购的产品,97系统中只保存IPTV产品列表,不保存用户产品订购关系。IPTV产品列表以数据文件形式发送给97系统。97系统成功接收该文件后,将对比本地保存的IPTV产品列表与数据文件中的产品列表。对于数据文件中包含的产品(以产品ID为唯一标识),若在本地不存在则在本地产品列表中添加对应产品,若本地已经存在则更新对应产品;对于本地产品列表中存在而数据文件中不存在的产品,保持本地产品属性不变。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)productListFileNameIPTV产品列表文本文件全路径名。字符串最大1024productListFileSrvAddr存放IPTV产品列表文本文件的FTP服务器IP地址。整型4productListFileSrvAccount存放IPTV产品列表文本文件的FTP服务器帐号,空串表示采用默认帐号。字符串最大20productListFileSrvPass存放IPTV产品列表文本文件的FTP服务器密码,空串表示采用默认密码字符串最大20IPTV产品列表文本文件每两行或多行表示一个产品。每行的每个参数之间用“/”分隔。如果一个产品只包含一个内容项,每两行表示一个产品,其中第一行为产品参数,第二行为内容参数。如果产品包含多个内容项,其中第一行为产品参数,第二行开始的连续若干行(行数与内容项数相等)为内容参数。若参数本身包含字符“/”,则用连续的两个字符“/”表示单个字符“/”。产品参数定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4productName产品名称字符串最大100billingPolicyID计费策略全局唯一标识整型4PreferentialID优惠策略全局唯一标识,无优惠策略时取值为“-1”。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16productStatus产品状态:1:正常2:暂停3:注销4:删除5:测试整型4第79页
autoContinueTag自动续订标志1:支持自动续订2:不支持自动续订整型4orderLimitation订购产品的限制条件1:18岁以下可订购2:18岁以上可订购整型4serviceID保留,暂不做规定,且在接口上传送时取值为“-1”。整型4serviceName保留,暂不做规定,且在接口上传送时取值为“-”。字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4extInfo扩展信息。无扩展信息时取值为“-”。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4billingPolicyID计费策略全局唯一标识,若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)synPLMsgResponse接口调用返回状态:下载IPTV产品列表数据文件操作是否成功1:文件下载成功2:文件下载失败3:FTP服务器不可达4:FTP用户名或密码无效5:目标文件不存在整型41.1添加IPTV产品接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→97系统调用接口:addProduct第79页
接口功能:向97系统中添加单个新定义的IPTV产品。备注说明:根据需要手工调用。每个产品ID只能(productID)同时和唯一一个计费策略ID绑定(billingPolicyID)。如果对于需要同一产品如果同时定义多个资费策略,例如用户在订购某个产品时,可以选择包月或包月有限次两种订购方式,则在于IPTV业务管理系统中,需要针对该产品的两种不同的自费策略分配不同的产品ID,即在系统中按照两个不同的产品对待。这两个产品除字符策略不同外,其余内容全部相同。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)productID产品全局唯一标识整型4productName产品名称字符串最大100billingPolicyID计费策略全局唯一标识整型4PreferentialID优惠策略全局唯一标识,无优惠策略时取值为“-1”。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16productStatus产品状态:1:正常4:测试整型4autoContinueTag自动续订标志1:支持自动续订2:不支持自动续订整型4orderLimitation订购产品的限制条件1:18岁以下可订购2:18岁以上可订购整型4serviceID保留,取值暂不做规定。整型4serviceName保留,取值暂不做规定。字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4billingPolicyID计费策略全局唯一标识。若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024第79页
l接口响应参数名称说明数据类型长度(字节)addProductResponse接口调用返回状态:添加IPTV产品操作是否成功1:添加成功2:添加失败3:目标产品已存在整型41.1修改IPTV产品状态接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→97系统调用接口:synProductStatus接口功能:修改97系统中IPTV产品状态。备注说明:根据需要手工调用。对被删除的产品的处理方法,IPTV业务管理系统和97系统可分别定义,不做统一规定。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)productIDList待删除的IPTV产品列表结构数组变长listNum数组元素个数,取值必须大于0整型4待删除的IPTV产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4productStatus产品状态:1:正常2:暂停3:注销4:删除5:测试整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数第79页
名称说明数据类型长度(字节)synProductStatusResponse接口调用返回状态:修改IPTV产品状态操作是否成功1:修改成功2:修改失败整型4execFailedProductList修改失败的目标产品列表若修改成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若修改成功,则取值必须为0整型4修改失败的目标产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4failReason失败原因:1:目标产品ID不存在2:原状态与目标状态相同整型41.1同步IPTV产品计费策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:synProdBillingPolicy接口功能:省级IPTV业务管理系统将IPTV产品计费策略同步到97系统中。备注说明:根据需要手工调用。对于接口传递参数中包含的计费策略(以计费策略ID为唯一标识),若97系统中已经存在则进行更新,若97系统中不存在则添加相应的计费策略;对于97系统中已经存在但接口传递参数中不存在的计费策略,在97系统中保持不变。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)productBPListIPTV产品计费策略列表。结构数组变长listNum数组元素个数,取值必须大于0整型4计费策略参数定义:名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4billingPolicyName计费策略名称字符串最大100status计费策略状态:整型4第79页
1:正常2:暂停3:注销4:删除5:测试Rate基本单价,单位“分”。整型4rateUnit基本单价单位:1:包月,表示在一个自然月中无限制使用。2:包月有限次,表示在一个自然月中只能按基本单价累计使用限定的次数。3:包月限时长,表示在一个自然月中只能按基本单价累计使用限定的时长。4:包月限流量,表示在一个自然月中只能按基本单价累计使用限定的下载流量。5:包时段,表示从第一次使用业务时间点开始的一段时间内可以无限制的使用。超过包时段的时长后,重新计算包时段的起始时间点。6:包时段有限次,表示从第一次使用业务时间点开始的一段时间内只能按基本单价累计使用限定的次数。超过限定次数后,重新开始计算包时段起始时间点及限制次数。7:包时段限时长,表示从第一次使用业务时间点开始的一段时间内只能按基本单价累计使用限定的时长。例如24小时内通话180分钟。超过限定时长后,重新开始计算包时段起始时间点及限定时长。8:包时段限流量,表示从第一次使用业务时间点开始的一段时间内只能按基本单价累计使用限定的下载流量。超过限定的下载流量后,重新开始计算包时段起始时间点及限定的下载流量。9:按次,按使用次数计费。10:按时长,按使用时长计费。11:按流量,按使用下载流量计费。(若需按使用上载流量计费,可另行定义“rateUnit”取值。)12:免费,表示无限制免费使用。(若需规定免费使用周期,可另行定义“rateUnit”取值。)13:免费有限次,表示在累计使用次数未超过限定值之前可以免费使用。14:免费限时长,表示在累计使用时长未超过限定值之前可以免费使用。整型4第79页
15:免费限流量,表示在累计使用下载流量未超过限定值之前可以免费使用。rateUnitLimitParameter基本单价单位限制参数l如果产品基本单价单位为包月有限次,取值为一个月以内按基本单价计费的限制次数,单位为“次”。l如果产品基本单价单位为包月限时长,取值为一个月以内按基本单价计费的限制时长,单位为“秒”。l如果产品基本单价单位为包月限流量,取值为一个月以内按基本单价计费的限制总流量,单位为“兆字节”。l如果产品基本单价单位为包时段,取值为每次计费的使用时间段长度,在该时间段内不重复计费,单位“分钟”。如取值“720”表示12小时内可反复使用。l如果产品基本单价单位为包时段有限次,包时段限时长,包时段限流量,取值为每次计费的使用时间段长度,在该时间段内不重复计费,单位“分钟”。具体限制参数参见“offLimitUnit”。l如果产品基本单价单位为按次,取值为每次计费的使用次数,单位为“次”。例如,“3”表示每使用3次按基本单价计费一次。l如果产品基本单价单位为按时长,取值每次计费的使用时长,单位为“秒”。例如,“60”表示每分钟按基本单价计费一次。l如果产品基本单价单位为按流量,取值每次计费的下载流量,单位为“K字节”。例如,“2”表示每下载2K字节按基本单价计费一次。l如果产品基本单价单位为免费有限次,取值为在收费之前可以免费累计使用的次数,单位为“次”。l如果产品基本单价单位为免费限时长,取值为在收费之前可以免费累计使用的时长,单位为“分”。l如果产品基本单价单位为免费限流量,取值为在收费之前可以免费累计使用的下载流量,单位为“M字节”。如果产品基本单价单位为其他类型,本参数无效,且对取值不做规定。整型4offLimitRate超限单价单位,即超过基本单价单位限制参数时的单价,单位“分”。若基本单价单位整型4第79页
不是包月有限次、包月限时长、包月限流量中的任何一种,本参数无效。对取值不做规定。offLimitUnit超限单价,即超过基本单价单位限制参数时的单价:l若基本单价单位为包月有限次,取值为超过限定次数之后,每次计费的使用次数,单位为“次”。例如,“3”表示每使用3次按单价计费一次l若基本单价单位为包月限时长,取值为超过限定时长之后,每次计费的使用时长,单位为“秒”。例如,“60”表示每分钟按单价计费一次。l若基本单价单位为包月限流量,取值为超过限定流量之后,每次计费的下载流量,单位为“K字节”。例如,“2048”表示每下载2M字节按单价计费一次。l若基本单价单位为包时段有限次,取值为限定时间段内的限制次数,单位“次”。l若基本单价单位为包时段限时长,取值为限定时间段内的限制时长,单位“分”。l若基本单价单位为包时段限流量,取值为限定时间段内的限制下载流量,单位“M字节”。若基本单价单位为其他,本参数无效。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)synPBPResponse接口调用返回状态:同步IPTV产品计费策略信息操作是否成功1:同步成功2:同步失败整型41.1添加IPTV产品计费策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:addProdBillingPolicy接口功能:向97系统中添加单个新定义的IPTV产品计费策略。备注说明:根据需要手工调用。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4billingPolicyName计费策略名称字符串最大100status计费策略状态:1:正常5:测试整型4Rate基本单价,单位“分”。整型4rateUnit基本单价单位,参见5.5。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。整型4offLimitRate超限单价单位,参见5.5。整型4offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)addPBPResponse接口调用返回状态:添加计费策略信息操作是否成功1:添加成功2:添加失败3:目标计费策略ID已存在整型41.2修改IPTV产品计费策略状态接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:synPBPStatus接口功能:修改97系统中IPTV产品计费策略状态。备注说明:根据需要手工调用。对被删除的产品计费策略的处理方法,IPTV业务管理系统和97系统可分别定义,不做统一规定。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)productBPList计费策略列表结构数组变长listNum数组元素个数,取值必须大于0整型4计费策略参数定义:第79页
名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4status计费策略状态:1:正常2:暂停3:注销4:删除5:测试整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)synPBPStatusResponse接口调用返回状态:修改计费策略状态操作是否成功1:修改成功2:修改失败整型4execFailedPBPList修改失败的目标计费策略列表若修改成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若修改成功,则取值必须为0整型4不存在的目标计费策略列表元素定义:名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4failReason失败原因:1:目标产品计费策略ID不存在2:原状态与目标状态相同整型41.1同步IPTV产品优惠策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:synProdPreferentialPolicy接口功能:省级IPTV业务管理系统将IPTV产品优惠策略同步到97系统中。备注说明:根据需要手工调用。对于接口传递参数中包含的优惠策略(以优惠策略ID为唯一标识),若97系统中已经存在则进行更新,若97系统中不存在则添加相应的优惠策略;对于97系统中已经存在但接口传递参数中不存在的优惠策略,在97系统中保持不变。1.1.2接口参数待定第79页
1.1添加IPTV产品优惠策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:addProdPreferentialPolicy接口功能:向97系统中添加单个新定义的IPTV产品优惠策略。备注说明:根据需要手工调用。1.1.2接口参数待定1.2修改IPTV产品优惠策略状态接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→97系统调用接口:synPPPStatus接口功能:修改97系统中IPTV产品优惠策略状态。备注说明:根据需要手工调用。对被删除的产品优惠策略的处理方法,IPTV业务管理系统和97系统可分别定义,不做统一规定。1.2.2接口参数待定1.3发送新开户用户资料接口1.3.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:newIPTVUsr接口功能:从97系统向IPTV业务管理系统发送新开户的用户资料。备注说明:实时调用。IPTV业务管理系统中不保存全部用户信息,只保存必要的用户信息。97系统中不保存用户密码(包括IPTV业务密码和IPTV接入密码)。1.3.2接口参数l接口调用参数名称说明数据类型长度(字节)第79页
usrPhoneNumxDSL接入用户绑定的电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNumxDSL接入用户绑定的电话业务合同编号;用户无电话号码时取值为“-”。字符串20usrID用户全局唯一标识整型4usrIdentityCardNum当前开户用户的身份证号码对于15位身份证号码,最右边3位用字符“-”填充字符串18usrName用户姓名字符串最大20usrIPTVAccount用户IPTV业务帐号字符串16usrIPTVPass用户IPTV业务密码字符串最大30usrNAAccount用户网络层接入帐号字符串16usrNAPass用户网络层接入密码字符串最大30usrNAType接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4usrNABandwidth接入带宽(512K/1M/2M/4M等)字符串4usrOpenTime开户时间,数据格式为:yyyyMMddHHmmss字符串14usrType用户类型1:普通用户2:酒店用户整型4usrAreaCode区域标识,即用户所属地区的编号字符串6usrPaymentType付费类型1:预付费2:后付费整型4usrStatus用户状态,固定取值“2”,表示“开户暂停状态”,即用户新开户,第一次开机接入之前的状态标识。用户激活之后修改用户状态为“1”,表示“用户正常使用业务”整型4InstallID机顶盒第一次开机时使用的安装ID(参见机顶盒与IPTV业务平台接口规范)字符串32InstallPIN机顶盒第一次开机时使用的安装PIN(参见机顶盒与IPTV业务平台接口规范)字符串32productList产品列表结构数组变长productListNum产品列表元素个数,取值必须大于0整型4serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100产品列表元素定义:第79页
名称说明数据类型长度(字节)productID产品全局唯一标识整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14autoContinueTag自动续订标志:1:自动续订2:不自动续订若产品本身不支持自动续订,则此参数无效,取值不做规定。整型4autoContinueDuration若产品支持自动续订,则自动续订时间长度1:1周2:1个月3:3个月若产品不支持自动续订,则本参数无效。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)newIPTVUsrResponse接口调用返回状态:添加IPTV业务用户是否成功1:添加成功2:添加失败3:目标用户ID已存在整型41.1修改用户电话号码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:modPhoneNumber接口功能:修改省级IPTV业务管理系统中指定用户的电话号码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrPhoneNum更新的xDSL接入用户绑定的电话号码。整型4l接口响应参数第79页
名称说明数据类型长度(字节)modUPNResponse接口调用返回状态:修改用户电话号码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户姓名接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrName接口功能:修改目标系统中指定用户的用户姓名信息。备注说明:实时调用。接口可双向调用,调用关系参见4.1节中参考点A相关说明。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrName更新的用户姓名字符串最大20l接口响应参数名称说明数据类型长度(字节)modUNResponse接口调用返回状态:修改用户姓名操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户IPTV业务密码接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrIPTVPass接口功能:修改目标系统中指定用户的IPTV业务密码信息。备注说明:实时调用。接口可双向调用,调用关系参见4.1节中参考点A相关说明。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrIPTVPass更新的用户IPTV业务密码字符串最大30l接口响应参数名称说明数据类型长度(字节)modUIPTVPResponse接口调用返回状态:修改用户IPTV业务密码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户接入密码接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrNAPass接口功能:修改目标系统中指定用户的接入密码信息。备注说明:实时调用。接口可双向调用,调用关系参见4.1节中参考点A相关说明。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrNAPass更新的用户网络层接入密码字符串最大30l接口响应参数名称说明数据类型长度(字节)modUNAPResponse接口调用返回状态:修改用户接入密码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型4第79页
1.1修改用户接入类型接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:modUsrNAType接口功能:修改省级IPTV业务管理系统中指定用户的接入类型信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrNAType更新的接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4l接口响应参数名称说明数据类型长度(字节)modUNATResponse接口调用返回状态:修改用户接入类型操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户接入带宽接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:modUsrNABandwidth接口功能:修改省级IPTV业务管理系统中指定用户的接入带宽信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)第79页
usrID用户全局唯一标识整型4newUsrNABandwidth更新的接入带宽:(512K/1M/2M/4M等)字符串4l接口响应参数名称说明数据类型长度(字节)modUNABResponse接口调用返回状态:修改用户接入带宽操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户接入区域代码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:modUsrAreaCode接口功能:修改省级IPTV业务管理系统中指定用户的接入区域代码信息。备注说明:此接口需在派送用户移机工单之前调用,定时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrAreaCode更新的区域标识,即用户所属地区的编号字符串6l接口响应参数名称说明数据类型长度(字节)modUACResponse接口调用返回状态:修改用户接入区域代码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型4第79页
1.1修改用户付费类型接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrPaymentType接口功能:修改目标系统中指定用户的付费类型信息。备注说明:实时调用。接口可双向调用,调用关系参见4.1节中参考点A相关说明。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrPaymentType更新的付费类型1:预付费2:后付费整型4l接口响应参数名称说明数据类型长度(字节)modUPTResponse接口调用返回状态:修改用户接入付费类型是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户状态接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrStatus接口功能:修改省级IPTV业务管理系统中指定用户的状态信息。备注说明:实时调用。用户状态变为欠费停机或复机开通时,如不需要实时调用可以调用批量操作接口,参见5.25及5.26。用户状态由“开户暂停”或“调试”变为“正常”时,由IPTV业务管理系统通知97系统用户状态变化。用户状态由“正常”变为“主动暂停”、“欠费停机”、“预消户”、“消户”、“调试”时,由97系统通知IPTV业务管理系统用户状态变化。调用限制条件参见4.1节中参考点A相关说明。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4newUsrStatus更新的用户状态1:正常2:开户暂停,用户新开户,第一次开机接入之前的状态标识3:主动暂停,用户主动要求停机的状态标识4:欠费停机5:预消户,用户主动要求消户或因欠费而被消户,但尚未将终端设备收回或尚未交清欠款时的状态标识6:消户,已经将用户帐户注销并收回终端设备且已交清欠款后的状态标识7:调试状态,用户更换机顶盒、用户移机等情况下的状态标识整型4l接口响应参数名称说明数据类型长度(字节)modUSResponse接口调用返回状态:修改用户状态是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户扩展信息接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:modUsrExtInfo接口功能:修改目标系统中指定用户的扩展信息。备注说明:实时调用。接口可双向调用,调用关系参见4.1节中参考点A相关说明。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4第79页
newUsrExtInfo更新的扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)modUEIResponse接口调用返回状态:修改用户扩展是否成功1:修改成功2:修改失败3:目标帐号不存在整型41.1更新用户订购信息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统;省级IPTV业务管理系统→97系统调用接口:updateUsrOrderInfo接口功能:更新目标系统中指定用户的产品订购关系。备注说明:实时调用。对用户订购信息历史记录的处理方法,IPTV业务管理系统和97系统可分别定义,不做统一规定。接口可双向调用,调用关系参见4.1节中参考点A相关说明。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4productList产品列表结构数组变长productListNum产品列表元素个数,取值必须大于0整型4serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14第79页
autoContinueTag自动续订标志:1:自动续订2:不自动续订若产品本身不支持自动续订,则此参数无效,取值不做规定。整型4autoContinueDuration若产品支持自动续订,则自动续订时间长度1:1周2:1个月3:3个月若产品不支持自动续订,则本参数无效。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)updateUOIResponse接口调用返回状态:发送用户定购信息操作是否成功1:发送成功2:发送失败3:目标用户ID不存在整型41.1用户更换机顶盒数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:changeUsrSTBMessage接口功能:97系统通知IPTV业务管理系统指定的用户需要更换机顶盒。备注说明:实时调用。用户机顶盒发生故障需要更换时,由97系统为用户分配新的InstallID和InstallPIN。IPTV业务管理系统收到该消息后将用户状态置为“调试”1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4InstallID机顶盒第一次开机时使用的安装ID(参见机顶盒与IPTV业务平台接口规范)字符串32InstallPIN机顶盒第一次开机时使用的安装PIN(参见机顶盒与IPTV业务平台接口规范)字符串32l接口响应参数第79页
名称说明数据类型长度(字节)changeUsrSTBMsgResponse接口调用返回状态:发送用户更换机顶盒数据是否成功1:发送成功2:发送失败3:目标用户ID不存在整型41.1发送用户消户消息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:delIPTVUsrMessage接口功能:97系统通知IPTV业务管理系统对指定的用户做消户处理。备注说明:实时调用。对已消户的用户资料的处理方法,IPTV业务管理系统和97系统可分别定义,不做统一规定。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4l接口响应参数名称说明数据类型长度(字节)delIPTVUsrMsgResponse接口调用返回状态:删除IPTV业务用户是否成功1:删除成功2:删除失败3:目标用户ID不存在整型41.2用户业务欠费停机数据接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:sendUsrArrearageSuspensionList接口功能:97系统通知省级IPTV业务管理系统指定的用户因欠费而被停机。备注说明:定时调用。用户发生欠费时,综合帐务系统将欠费停机的用户标识发送给97系统,97系统转发该用户ID到省级IPTV业务管理系统。省级IPTV业务管理系统将对应用户的状态修改为“欠费停机”并通知其他系统修改用户状态。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)sendUASList欠费停机用户信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4欠费停机用户信息列表元素定义名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrSuspBeginTime开始停机时间,数据格式为:yyyyMMddHHmmss若当前时间超过参数值规定的时间点,则立即生效。字符串14l接口响应参数名称说明数据类型长度(字节)sendUASListResponse接口调用返回状态:发送欠费停机用户ID列表操作是否成功1:发送成功2:发送失败3:目标用户ID不存在整型4notExistedUsrIDList不存在的目标用户ID列表若发送成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若发送成功,则取值必须为0整型4不存在的目标用户ID列表元素定义:名称说明数据类型长度(字节)usrID用户全局唯一标识整型41.2用户业务复机开通数据接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:97系统→省级IPTV业务管理系统调用接口:sendUsrResumeList接口功能:97系统通知省级IPTV业务管理系统指定的用户复机开通。备注说明:定时操作。由综合帐务系统将复机开通的用户标识发送给97系统,97系统转发该用户标识到省级IPTV业务管理系统,省级IPTV业务管理系统将对应用户的状态修改为“正常”并通知其他系统修改用户状态。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)sendURList复机用户信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4复机用户信息列表元素定义名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrResumeTime开始复机时间,数据格式为:yyyyMMddHHmmss若当前时间超过参数值规定的时间点,则立即生效。字符串14l接口响应参数名称说明数据类型长度(字节)sendURListResponse接口调用返回状态:发送复机用户ID列表操作是否成功1:发送成功2:发送失败3:目标用户ID不存在整型4notExistedUsrIDList不存在的目标用户ID列表若发送成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若发送成功,则取值必须为0整型4不存在的目标用户ID列表元素定义:名称说明数据类型长度(字节)usrID用户全局唯一标识整型41.2发送机顶盒首次开机激活认证服务器域名接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→97系统调用接口:sendAuthenSrvDomainName接口功能:向97系统发送发送机顶盒首次开机激活认证服务器域名备注说明:根据需要手工调用。97系统将该服务器域名(同时包括机顶盒InstallID和InstallPIN,参见机顶盒与IPTV业务平台接口规范)发送给工单系统。外线施工人员利用该域名(和InstallID、InstallPIN第79页
)为用户进行机顶盒第一次开机激活操作。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)authenSrvDomainName机顶盒首次开机完成激活认证时访问的服务器域名。字符串最大32l接口响应参数名称说明数据类型长度(字节)sendASDNResponse接口调用返回状态:发送域名操作是否成功:1:发送成功2:发送失败整型42IPTV业务管理系统与IPTV接入认证系统接口2.1接口示意图省级IPTV业务管理系统IPTV接入认证系统发送用户网络层接入认证权限数据信息修改用户网络层接入认证权限数据信息图6-1IPTV业务管理系统与IPTV接入认证系统接口示意2.2添加用户STB接入认证权限数据发送接口2.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:synNetAccessInfo接口功能:将在用户开户时为用户分配的网络层接入帐号及密码发送到IPTV接入认证系统。备注说明:定时操作。用户使用IPTV业务时,需要首先利用接入设备(ADSLmodem或STB)完成网络层接入认证操作。此接口需在派送用户开户施工工单之前调用。IPTV接入认证系统中,以用户接入帐号为唯一标识。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrNAIList用户接入认证信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4用户接入认证信息列表元素定义:名称说明数据类型长度(字节)usrPhoneNumxDSL接入用户绑定的电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNumxDSL接入用户绑定的电话业务合同编号;用户无电话号码时取值为“-”。字符串20usrID用户全局唯一标识整型4usrNAAccount用户网络层接入帐号字符串16usrNAPass用户网络层接入密码字符串最大30usrNAType接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4usrNABandwidth接入带宽(512K/1M/2M/4M等)字符串4usrOpenTime开户时间,数据格式为:yyyyMMddHHmmss字符串14usrType用户类型1:普通用户2:酒店用户整型4usrAreaCode区域标识,即用户所属地区的编号字符串6usrPaymentType付费类型1:预付费2:后付费整型4usrStatus用户状态,固定取值“2”,表示“开户暂停状态”,即用户新开户,第一次开机接入之前的状态标识。用户激活之后修改用户状态为“1”,表示“用户正常使用业务”。整型4usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数第79页
名称说明数据类型长度(字节)synUsrNAIResponse接口调用返回状态:用户接入认证权限信息数据传递是否成功1:添加成功2:添加失败3:目标帐号已存在整型4existedUsrNAAccountList已存在的目标帐号列表若添加成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若添加成功,则取值必须为0整型4已存在的目标帐号列表元素定义:名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串161.1删除用户STB接入认证权限数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:delNAIUsrAccount接口功能:从IPTV接入认证系统中删除指定帐号的网络层接入认证信息。备注说明:用户消户以后,可以删除对应帐号的网络层接入认证信息。此接口只能在用户状态被置为“消户”之后调用,实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16l接口响应参数名称说明数据类型长度(字节)delUsrNAAResponse接口调用返回状态:删除用户接入认证权限信息操作是否成功1:删除成功2:删除失败3:目标帐号不存在4:目标帐号状态不是“已消户”整型4第79页
1.1修改用户电话号码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIPhoneNumber接口功能:修改IPTV接入认证系统中指定帐号的电话号码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrPhoneNum更新的xDSL接入用户绑定的电话号码。整型4l接口响应参数名称说明数据类型长度(字节)modUPNResponse接口调用返回状态:修改用户电话号码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户姓名接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrName接口功能:修改IPTV接入认证系统中指定帐号的用户姓名信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrName更新的用户姓名字符串最大20l接口响应参数第79页
名称说明数据类型长度(字节)modUNResponse接口调用返回状态:修改用户姓名操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户接入密码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrPass接口功能:修改IPTV接入认证系统中指定帐号的接入密码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrNAPass更新的用户网络层接入密码字符串最大30l接口响应参数名称说明数据类型长度(字节)modNAUPResponse接口调用返回状态:修改用户接入密码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户接入类型接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrType接口功能:修改IPTV接入认证系统中指定帐号的接入类型信息。备注说明:实时调用。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrNAType更新的接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4l接口响应参数名称说明数据类型长度(字节)modUNATResponse接口调用返回状态:修改用户接入类型操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户接入带宽接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrNABandwidth接口功能:修改IPTV接入认证系统中指定帐号的接入带宽信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrNABandwidth更新的接入带宽(512K/1M/2M/4M等)字符串4l接口响应参数第79页
名称说明数据类型长度(字节)modUNABResponse接口调用返回状态:修改用户接入带宽操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户接入区域代码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrAreaCode接口功能:修改IPTV接入认证系统中指定帐号的接入区域代码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrAreaCode更新的区域标识,即用户所属地区的编号字符串6l接口响应参数名称说明数据类型长度(字节)modUACResponse接口调用返回状态:修改用户接入区域代码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户付费类型接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrPaymentType接口功能:修改IPTV接入认证系统中指定帐号的付费类型信息。备注说明:实时调用。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrPaymentType更新的付费类型1:预付费2:后付费整型4l接口响应参数名称说明数据类型长度(字节)modUPTResponse接口调用返回状态:修改用户接入付费类型是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户状态接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrStatus接口功能:修改IPTV接入认证系统中指定帐号的状态信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16第79页
newUsrStatus更新的用户状态1:正常2:开户暂停,用户新开户,第一次开机接入之前的状态标识3:主动暂停,用户主动要求停机的状态标识4:欠费停机5:预消户,用户主动要求消户或因欠费而被消户,但尚未将终端设备收回或尚未交清欠款时的状态标识6:消户,已经将用户帐户注销并收回终端设备且已交清欠款后的状态标识7:调试状态,用户更换机顶盒、用户移机等情况下的状态标识整型4l接口响应参数名称说明数据类型长度(字节)modUSResponse接口调用返回状态:修改用户状态是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户扩展信息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→IPTV接入认证系统调用接口:modNAIUsrExtInfo接口功能:修改IPTV接入认证系统中指定帐号的扩展信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrNAAccount用户网络层接入帐号字符串16newUsrExtInfo更新的用户扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数第79页
名称说明数据类型长度(字节)modUEIResponse接口调用返回状态:修改用户扩展信息是否成功1:修改成功2:修改失败3:目标帐号不存在整型41IPTV业务管理系统与客服系统接口1.1接口示意图省级IPTV业务管理系统客服系统查询用户信息接口查询用户业务使用详单接口发送用户投诉信息接口图7-1IPTV业务管理系统与工单管理系统接口示意1.2查询用户信息数据接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:客服系统→省级IPTV业务管理系统调用接口:queryUsrInfo接口功能:向IPTV业务管理系统查询用户信息。备注说明:根据需要手工调用。客服系统根据用户IPTV业务帐号查询用户IPTV业务相关信息。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16l接口响应参数第79页
名称说明数据类型长度(字节)queryUsrInfoResponse接口调用返回状态:查询用户信息操作是否成功。1:查询成功2:查询失败3:目标用户IPTV帐号不存在对于失败查询,不对下列参数的返回值做任何规定。整型4usrPhoneNumxDSL接入用户绑定的电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNumxDSL接入用户绑定的电话业务合同编号;用户无电话号码时取值为“-”。字符串20usrID用户全局唯一标识整型4usrIdentityCardNum当前开户用户的身份证号码对于15位身份证号码,最右边3位用字符“-”填充字符串18usrName用户姓名字符串最大20usrNAAccount用户网络层接入帐号字符串16usrNAType接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4usrNABandwidth接入带宽(512K/1M/2M/4M等)字符串4usrOpenTime开户时间,数据格式为:yyyyMMddHHmmss字符串14usrType用户类型1:普通用户2:酒店用户整型4usrAreaCode区域标识,即用户所属地区的编号字符串6usrPaymentType付费类型1:预付费2:后付费整型4usrStatus用户状态1:正常2:开户暂停,用户新开户,第一次开机接入之前的状态标识3:主动暂停,用户主动要求停机的状态标识4:欠费停机5:预消户,用户主动要求消户或因欠费而被消户,但尚未将终端设备收回或尚未交清欠款时的状态标识6:消户,已经将用户帐户注销并收回终端设备且已交清欠款后的状态标识7:调试状态,用户更换机顶盒、用户移机等情况下的状态标识整型4usrScore用户当前累计积分值。整型4第79页
usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大1001.1查询用户业务使用详单数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:客服系统→省级IPTV业务管理系统调用接口:queryUsrDetailBill接口功能:从省级IPTV业务管理系统查询指定用户的业务使用记录详单。备注说明:根据需要手工调用。用户通过客服系统进行投诉时可能需要查看用户IPTV业务使用详单,客服系统可通过该接口从省级IPTV业务管理系统中获取该用户的详细记录。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16acctItemTypeID帐目类型标识整型4billingCycleID帐务周期标识整型4billingCycleBeginDate帐务周期开始时间,数据格式为:yyyyMMddHHmmss字符串14billingCycleEndDate帐务周期结束时间,数据格式为:yyyyMMddHHmmss字符串14l接口响应参数名称说明数据类型长度(字节)queryUDBResponse接口调用返回状态:查询指定用户详单是否成功。1:查询成功2:查询失败3:目标用户IPTV帐号不存在4:错误的帐务周期对于失败查询,不对下列参数的返回值做任何规定。整型4usrPhoneNumxDSL接入用户绑定的电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNumxDSL接入用户绑定的电话业务合同编号;用户无电话号码时取值为“-”。字符串20productID产品全局唯一标识整型4productName产品名称字符串最大100Rate基本单价,单位“分”。整型4rateUnit基本单价单位,参见5.5。整型4第79页
rateUnitLimitParameter基本单价单位限制参数,参见5.5。整型4offLimitRate超限单价单位,参见5.5。整型4offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14duration使用时长(单位:秒),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4flux使用流量(单位:KB),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4count使用次数(单位:次),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4acctItemTypeID帐目类型标识整型4charge费用,单位:分整型4extInfo扩展信息,如优惠折扣说明。无扩展信息时取值为空串。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4Rate基本单价,单位“分”。若内容不独立计费,此参数取值不做规定。整型4rateUnit基本单价单位,参见5.5。若内容不独立计费,此参数取值不做规定。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。若内容不独立计费,此参数取值不做规定。整型4offLimitRate超限单价单位,参见5.5。若内容不独立计费,此参数取值不做规定。整型4第79页
offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息,如优惠折扣说明。无扩展信息时取值为空串。字符串最大10241.1发送用户投诉信息数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:客服系统→省级IPTV业务管理系统调用接口:sendUsrComplainInfo接口功能:向IPTV业务管理系统发送用户投诉信息。备注说明:根据需要手工调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16usrComplainInfo用户投诉信息字符串最大1024l接口响应参数名称说明数据类型长度(字节)sendUCIResponse接口调用返回状态:发送用户投诉消息操作是否成功1:发送成功2:发送失败3:用户IPTV帐号不存在整型4第79页
1IPTV业务管理系统与综合帐务系统接口1.1接口示意图省级IPTV业务管理系统综合帐务系统上传用户业务使用帐单消息查询用户业务使用详单信息实时出帐消息接口图8-1IPTV业务管理系统与综合帐务系统接口示意1.2上传用户业务使用帐单消息接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→综合帐务系统调用接口:uploadUsrBillMessage接口功能:通知综合帐务系统到指定位置以FTP方式取IPTV业务用户帐单文本文件。备注说明:一般在每个帐务周期结束后定时上传。帐单按照每产品为单位(一条记录)上传,以支持帐务系统中的帐务级优惠策略。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrBillFileNameIPTV业务用户帐单文本文件全路径名。字符串最大1024usrBillFileSrvAddr存放IPTV业务用户帐单文本文件的FTP服务器IP地址整型4usrBillFileSrvAccount存放IPTV业务用户帐单文本文件的FTP服务器帐号,空串表示采用默认帐号。字符串最大20usrBillFileSrvPass存放IPTV业务用户帐单文本文件的FTP服务器密码,空串表示采用默认密码。字符串最大20IPTV业务用户帐单文本文件每行表示一条每用户每产品使用帐单记录。每行的每个参数之间用“/”分隔。若参数本身包含字符“/”,则用连续的两个字符“/”表示单个字符“/”。第79页
用户帐单记录参数定义:名称说明数据类型长度(字节)usrPhoneNum用户电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNum用户的电话业务合同编号;用户无电话业务合同时取值为“-”。字符串最大20usrID用户全局唯一标识整型4productID产品全局唯一标识整型4acctItemTypeID帐目类型标识整型4acctItemName账单名称字符串最大20billingCycleID帐务周期标识整型4billingCycleBeginDate帐务周期开始时间,数据格式为:yyyyMMddHHmmss字符串14billingCycleEndDate帐务周期结束时间,数据格式为:yyyyMMddHHmmss字符串14charge费用,单位:分整型4extInfo扩展信息。无扩展信息时取值为“-”。字符串最大100l接口响应参数名称说明数据类型长度(字节)uploadUBMsgResponse接口调用返回状态:下载IPTV业务用户帐单文本文件操作是否成功1:文件下载成功2:文件下载失败3:FTP服务器不可达4:FTP用户名或密码无效5:目标文件不存在整型41.1查询用户业务使用详单数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:综合帐务系统→省级IPTV业务管理系统调用接口:queryUsrDetailBill接口功能:综合帐务系统使用该接口从省级IPTV业务管理系统查询指定用户的业务使用记录详单。备注说明:用户在营业厅缴费时如需要查询IPTV业务使用详细记录,则综合帐务系统可通过该接口从省级IPTV业务管理系统中获取该用户的详细记录。省级IPTV业务管理系统中,以用户ID为唯一标识。1.1.2接口参数l接口调用参数第79页
名称说明数据类型长度(字节)usrID用户全局唯一标识整型4acctItemTypeID帐目类型标识整型4billingCycleID帐务周期标识整型4billingCycleBeginDate帐务周期开始时间,数据格式为:yyyyMMddHHmmss字符串14billingCycleEndDate帐务周期结束时间,数据格式为:yyyyMMddHHmmss字符串14l接口响应参数名称说明数据类型长度(字节)queryUDBResponse接口调用返回状态:查询指定用户详单是否成功。1:查询成功2:查询失败3:目标用户身份证号码不存在4:错误的帐务周期对于失败查询,不对下列参数的返回值做任何规定。整型4usrPhoneNumxDSL接入用户绑定的电话号码;用户无电话号码时取值为“-1”。整型4usrPhoneServiceContractNumxDSL接入用户绑定的电话业务合同编号;用户无电话号码时取值为“-”。字符串20productID产品全局唯一标识整型4productName产品名称字符串最大100Rate基本单价,单位“分”。整型4rateUnit基本单价单位,参见5.5。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。整型4offLimitRate超限单价单位,参见5.5。整型4offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14duration使用时长(单位:秒),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4flux使用流量(单位:KB),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4第79页
count使用次数(单位:次),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4acctItemTypeID帐目类型标识整型4charge费用,单位:分整型4extInfo扩展信息,如优惠折扣说明。无扩展信息时取值为空串。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4Rate基本单价,单位“分”。若内容不独立计费,此参数取值不做规定。整型4rateUnit基本单价单位,参见5.5。若内容不独立计费,此参数取值不做规定。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。若内容不独立计费,此参数取值不做规定。整型4offLimitRate超限单价单位,参见5.5。若内容不独立计费,此参数取值不做规定。整型4offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息,如优惠折扣说明。无扩展信息时取值为空串。字符串最大10241.1实时出帐消息接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:综合帐务系统→省级IPTV业务管理系统调用接口:realtimeBillingMessage接口功能:综合帐务系统通知IPTV业务管理系统对指定的用户做实时出帐处理。备注说明:用户消户时,需要对用户当月费用做实时出帐处理。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)第79页
usrID用户全局唯一标识整型4acctItemTypeID帐目类型标识整型4acctItemName账单名称字符串最大20billingCycleID帐务周期标识整型4billingCycleBeginDate帐务周期开始时间,数据格式为:yyyyMMddHHmmss字符串14billingCycleEndDate帐务周期结束时间,数据格式为:yyyyMMddHHmmss字符串14l接口响应参数名称说明数据类型长度(字节)realtimeBillingMsgResponse接口调用返回状态:对指定用户实时出帐操作是否成功1:成功2:失败3:指定用户ID不存在若调用失败,则以下参数取值不做规定。整型4productList产品列表结构数组变长productListNum产品列表元素个数,取值必须大于0整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大100产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4charge费用,单位:分。若操作失败,取值不做定义。整型41IPTV业务管理系统与DSLAM网管系统接口参见CCSA《组播业务系统控制逻辑接口规范(征求意见稿)》第79页
1IPTV业务管理系统与BSSP接口1.1接口示意图省级IPTV业务管理系统BSSPIPTV业务管理系统至BSSP用户鉴权数据接口IPTV业务用户请求使用互联网业务重定向接口BSSP至IPTV业务管理系统用户鉴权数据接口互联网业务用户请求使用IPTV业务重定向接口图10-1IPTV业务管理系统与BSSP接口示意1.2IPTV业务管理系统至BSSP用户数据同步接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→BSSP调用接口:sendIPTVUsrAuthenticationInfoToBSSP接口功能:将准备使用宽带互联网业务的IPTV业务用户鉴权信息发送到BSSP系统中备注说明:实时调用。用户在使用IPTV业务的时候,可以通过EPG页面上的链接转向使用宽带互联网业务服务。此时区域IPTV业务管理系统会通知省级IPTV业务管理系统将用户鉴权信息发送给BSSP。以用户ID为唯一标识符。(BSSP业务用户ID与IPTV业务用户ID可以通过取值范围进行区分;也可以不进行直接区分,而通过其他附加标识进行区分。)此后用户在宽带互联网服务页面上进行操作时,如果不重新输入帐号和密码,则BSSP会根据从省级IPTV业务管理系统获得的用户鉴权信息,向区域IPTV业务管理系统进行认证。认证通过后,允许用户使用互联网业务。IPTV用户使用互联网业务的计费操作由BSSP系统完成。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrIPTVAccount用户IPTV业务帐号字符串16usrIPTVPass用户IPTV业务密码字符串最大30第79页
usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)sendIPTVUAItoBSSPResponse接口调用返回状态:发送用户认证权限信息数据是否成功1:发送成功2:发送失败整型41.1IPTV业务用户请求使用互联网业务重定向接口1.1.1接口描述承载协议:HTTP/HTTPs接口方向:省级IPTV业务管理系统→BSSP调用接口:http://bsspServiceMainPage/接口功能:将用户当前页面重定向到宽带互联网业务主页面备注说明:IPTV用户在使用IPTV业务时,可以通过EPG页面上的URL链接进入宽带互联网业务主页面。在WEB页面提示下,用户可以选择使用其他宽带业务(如宽带接入帐号、16900帐号等)的用户帐号和密码再次进行登陆操作,由BSSP完成用户的认证授权和计费;也可以不输入用户帐号和密码,此时默认使用IPTV业务的用户帐号和密码。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)http://bsspServiceMainPage/重定向链接,将用户当前页面重定向到宽带互联网业务主页面N/AN/Al接口响应参数无1.2BSSP至IPTV业务管理系统用户数据同步接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:BSSP→省级IPTV业务管理系统调用接口:sendBSSPUsrAuthenticationInfoToIPTV接口功能:将准备使用IPTV业务的宽带互联网业务用户鉴权信息发送到IPTV系统中第79页
备注说明:实时调用。互联网用户在使用宽带互联网业务时候,可以通过浏览器打开IPTV业务的EPG页面使用IPTV业务服务。此时BSSP将互联网用户鉴权数据发送至省级IPTV业务管理系统。以用户ID为唯一标识符。(BSSP业务用户ID与IPTV业务用户ID可以通过取值范围进行区分;也可以不进行直接区分,而通过其他附加标识进行区分。)此后用户在IPTV服务页面上进行操作时,如果不重新输入帐号和密码,则省级IPTV业务管理会根据从BSSP系统获得的用户鉴权信息,向BSSP业务管理系统进行认证。认证通过后,允许用户使用IPTV业务。BSSP用户使用IPTV业务的计费操作由省级IPTV业务管理系统完成。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrBSSPAccount用户BSSP业务帐号字符串16usrBSSPPass用户BSSP业务帐号密码字符串最大30usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)sendBSSPUAItoIPTVResponse接口调用返回状态:发送用户认证权限信息数据是否成功1:发送成功2:发送失败整型41.2互联网业务用户请求使用IPTV业务重定向接口1.2.1接口描述承载协议:HTTP/HTTPs接口方向:BSSP→省级IPTV业务管理系统调用接口:http://iptvEPGMainPage/接口功能:将用户当前页面重定向到IPTV的EPG主页面备注说明:互联网用户在使用宽带业务时,可以通过浏览器打开IPTV的EPG主页面使用IPTV业务。在页面提示下,用户可以选择使用其他业务(如宽带接入帐号、16900帐号等)用户帐号和密码再次进行登陆操作(此时可能需求与其他系统的接口支持,不在本规范中定义。),由省级IPTV业务管理系统完成对BSSP用户的认证授权和计费;也可以不输入用户帐号密码,此时默认使用宽带互联网业务用户帐号和密码。1.2.2接口参数l接口调用参数第79页
名称说明数据类型长度(字节)http://iptvEPGMainPage/重定向链接,将用户当前页面重定向到IPTV的EPG主页面N/AN/Al接口响应参数无1IPTV业务管理系统与预付费管理系统接口1.1接口示意图省级IPTV业务管理系统预付费管理系统预付费用户余额查询接口预付费用户扣费记录对帐接口预付费用户扣费请求接口图11-1IPTV业务管理系统与预付费管理系统接口示意1.2预付费用户扣费请求接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→预付费管理系统调用接口:consumeRequest接口功能:向预付费管理管理系统请求进行预付费用户业务使用扣费操作。备注说明:由区域中心的预付费扣费请求触发,实时调用。预付费用户在区域中心IPTV系统进行授权时,通过该接口向省级IPTV业务管理系统申请扣除指定预付费用户的本次消费产品的费用;省级IPTV业务管理系统将来自区域中心的操作请求进行批价后转发到预付费管理系统实现对用户的实时扣费。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)sequenceNum流水号整型4usrCardID用户卡ID字符串20usrCardPass用户卡密码字符串最大20第79页
charge用户消费金额,单位:分整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)consumeRequestResponse接口调用返回状态:请求扣费操作是否成功1:扣费成功2:用户余额不足整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大10241.1预付费用户余额查询接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→预付费管理系统调用接口:queryUsrBalance接口功能:从预付费管理系统中查询当前用户的余额信息。备注说明:1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)sequenceNum流水号整型4usrCardID用户卡ID字符串20usrCardPass用户卡密码字符串最大20extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)queryUsrBalanceResponse接口调用返回状态:查询用户余额操作是否成功1:查询成功2:查询失败3:目标卡号不存在整型4usrBalance卡帐户余额,若查询失败则此参数取值不做规定。整型4第79页
1.1预付费用户扣费记录对帐接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:预付费管理系统→省级IPTV业务管理系统调用接口:uploadAccountingBalance接口功能:将预付费管理系统中成功交易的扣费清单以文本文件形式发送给省级IPTV业务管理系统。备注说明:定时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)accountingBalanceFileName成功交易的扣费清单文本文件目标径名。字符串最大1024accountingBalanceFileSrvAddr存放成功交易的扣费清单文本文件的目标FTP服务器IP地址整型4accountingBalanceFileSrvAccount存放成功交易的扣费清单文本文件的目标FTP服务器帐号,空串表示采用默认帐号。字符串最大20accountingBalanceFileSrvPass存放成功交易的扣费清单文本文件的目标FTP服务器密码,空串表示采用默认密码。字符串最大20成功交易的扣费清单文本文件格每行表示一条用户预付费扣费记录,每行的每个参数之间用“/”分隔。若参数本身包含字符“/”,则用连续的两个字符“/”表示单个字符“/”。用户预付费扣费记录参数定义:名称说明数据类型长度(字节)sequenceNum流水号整型4usrCardID用户卡ID字符串20beginTime开始扣费时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束扣费时间,数据格式为:yyyyMMddHHmmss字符串14charge扣费金额,单位:分整型4extInfo扩展信息。无扩展信息时取值为“-”。字符串最大1024l接口响应参数第79页
名称说明数据类型长度(字节)uploadUABResponse接口调用返回状态:上传成功交易的扣费清单文本文件操作是否成功1:文件上传成功2:文件上传失败3:FTP服务器不可达4:FTP用户名或密码无效5:目标路径不存在或无权访问整型4第79页
1省级与区域中心IPTV业务管理系统接口1.1接口示意图省级IPTV业务管理系统区域中心IPTV业务管理系统用户数据下发接口产品数据下发接口用户业务定购关系下发接口用户信息变更接口产品信息变更接口用户激活消息接口用户欠费停机接口统计数据上传接口原始话单上传接口预付费用户扣费请求接口用户欠费复机开通接口下发计费策略接口同步用户机顶盒与用户帐号绑定关系接口用户转向互联网业务主页面消息接口图12-1省级与区域中心IPTV业务管理系统接口示意第79页
1.1用户信息下发接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synUsrInfo接口功能:由省级IPTV业务管理系统将新开户的用户数据同步给区域中心IPTV业务管理系统备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrInfoList用户信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4用户信息列表元素定义:名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrNAAccount用户网络层接入帐号。字符串16usrIPTVAccount用户IPTV业务帐号字符串16usrIPTVPass用户IPTV业务密码字符串最大30usrNAType接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4usrNABandwidth接入带宽(512K/1M/2M/4M等)字符串4usrOpenTime开户时间,数据格式为:yyyyMMddHHmmss字符串14usrType用户类型1:普通用户2:酒店用户整型4usrAreaCode区域标识,即用户所属地区的编号字符串6usrPaymentType付费类型1:预付费2:后付费整型4usrStatus用户状态,固定取值“2”,表示“开户暂停状态”,即用户新开户,第一次开机接入之前的状态标识。用户激活之后修改用户状态为“1”,表示“用户正常使用业务”。整型4productList产品列表结构数组变长第79页
productListNum产品列表元素个数,取值必须大于0整型4serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14autoContinueTag自动续订标志:1:自动续订2:不自动续订若产品本身不支持自动续订,则此参数无效,取值不做规定。整型4autoContinueDuration若产品支持自动续订,则自动续订时间长度1:1周2:1个月3:3个月若产品不支持自动续订,则本参数无效。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)synUsrInfoResponse接口调用返回状态:下发用户信息数据是否成功:1:下发成功2:下发失败3:目标帐号已存在整型4existedUsrNAAccountList已存在的目标帐号列表若下发成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若添加成功,则取值必须为0整型4已存在的目标帐号列表元素定义:名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16第79页
1.1用户激活消息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:activateUsr接口功能:修改区域中心IPTV业务管理系统中用户状态为“正常”。备注说明:实时调用。机顶盒第一次开机激活由省级IPTV业务管理系统完成。施工人员给用户安装机顶盒时,用户首次开机会到省级IPTV业务管理系统进行认证,省级IPTV业务管理系统会将机顶盒的ID和用户、业务订购信息进行绑定,并激活用户。再由省中心IPTV业务管理系统将用户和机顶盒的绑定信息以及用户状态等信息分发至区域中心IPTV业务管理系统和IPTV终端管理系统,同时将区域中心IPTV业务管理系统IP地址发送给机顶盒,机顶盒第二次开机时直接向区域中心IPTV业务管理系统进行认证。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16l接口响应参数名称说明数据类型长度(字节)activateUsrResponse接口调用返回状态:激活用户操作是否成功1:激活成功2:激活失败3:目标用户IPTV业务帐号不存在整型41.2删除IPTV业务用户接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:delIPTVUsrAccount接口功能:从区域中心IPTV业务管理系统中删除指定的IPTV帐号。备注说明:实时调用。用户消户以后,可以删除对应帐号在区域中心IPTV业务管理系统中的认证信息。此接口只能在用户状态被置为“消户”之后调用。1.2.2接口参数l接口调用参数第79页
名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16l接口响应参数名称说明数据类型长度(字节)delUsrIPTVAResponse接口调用返回状态:从区域IPTV业务管理系统中删除指定的IPTV帐号操作是否成功1:删除成功2:删除失败3:目标帐号不存在4:目标帐号状态不是“已消户”整型41.1修改用户姓名接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrName接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的用户姓名信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16newUsrName更新的用户姓名字符串最大20l接口响应参数名称说明数据类型长度(字节)modUNResponse接口调用返回状态:修改用户姓名操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型4第79页
1.1修改用户IPTV业务密码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrPass接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的业务密码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16newUsrNAPass更新的IPTV业务密码字符串最大30l接口响应参数名称说明数据类型长度(字节)modUPResponse接口调用返回状态:修改用户IPTV业务密码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户接入类型接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrNAType接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的接入类型信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16第79页
newUsrNAType更新的接入类型1:ADSL2:ADSL2/2+3:VDSL4:LAN5:其他整型4l接口响应参数名称说明数据类型长度(字节)modUNATResponse接口调用返回状态:修改用户接入类型操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户接入带宽接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrNABandwidth接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的接入带宽信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16newUsrNABandwidth更新的接入带宽(512K/1M/2M/4M等)字符串4l接口响应参数名称说明数据类型长度(字节)modUNABResponse接口调用返回状态:修改用户接入带宽操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型4第79页
1.1修改用户接入区域代码接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrAreaCode接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的接入区域代码信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount待移机的IPTV帐号结构数组变长newUsrAreaCode更新的区域标识,即用户所属地区的编号字符串6l接口响应参数名称说明数据类型长度(字节)modUACResponse接口调用返回状态:修改用户接入区域代码操作是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.2修改用户付费类型接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrPaymentType接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的付费类型信息。备注说明:实时调用。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16第79页
newUsrPaymentType更新的付费类型1:预付费2:后付费整型4l接口响应参数名称说明数据类型长度(字节)modUPTResponse接口调用返回状态:修改用户IPTV付费类型是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户状态接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrStatus接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的状态信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16newUsrStatus更新的用户状态1:正常2:开户暂停,用户新开户,第一次开机接入之前的状态标识3:主动暂停,用户主动要求停机的状态标识4:欠费停机5:预消户,用户主动要求消户或因欠费而被消户,但尚未将终端设备收回或尚未交清欠款时的状态标识6:消户,已经将用户帐户注销并收回终端设备且已交清欠款后的状态标识7:调试状态,用户更换机顶盒、用户移机等情况下的状态标识整型4l接口响应参数第79页
名称说明数据类型长度(字节)modUSResponse接口调用返回状态:修改用户状态是否成功1:修改成功2:修改失败3:目标帐号不存在4:目标值与原值相同整型41.1修改用户扩展信息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:modIPTVUsrExtInfo接口功能:修改区域中心IPTV业务管理系统中指定的IPTV帐号的扩展信息。备注说明:实时调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrIPTVAccount用户IPTV业务帐号字符串16newUsrExtInfo更新的用户扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)modUEIResponse接口调用返回状态:修改用户扩展信息是否成功1:修改成功2:修改失败3:目标帐号不存在整型41.2同步IPTV产品列表消息接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synProductListMessage接口功能:省级IPTV业务管理系统将IPTV产品列表同步到区域中心IPTV业务管理系统中。第79页
备注说明:根据需要手工调用。将IPTV产品列表以数据文件形式发送给区域中心IPTV业务管理系统。区域中心IPTV业务管理系统成功接收该文件后,将对比本地保存的IPTV产品列表与数据文件中的产品列表,对于数据文件中包含的产品(以产品ID为唯一标识),若在本地不存在则在本地产品列表中添加对应产品,若本地已经存在则更新对应产品;对于本地产品列表中存在而数据文件中不存在的产品,保持本地产品属性不变。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)productListFileNameIPTV产品列表文本文件全路径名。字符串最大1024productListFileSrvAddr存放IPTV产品列表文本文件的FTP服务器IP地址整型4productListFileSrvAccount存放IPTV产品列表文本文件的FTP服务器帐号,空串表示采用默认帐号。字符串最大20productListFileSrvPass存放IPTV产品列表文本文件的FTP服务器密码,空串表示采用默认密码。字符串最大20IPTV产品列表文本文件每两行或多行表示一个产品。每行的每个参数之间用“/”分隔。如果一个产品只包含一个内容项,每两行表示一个产品,其中第一行为产品参数,第二行为内容参数。如果产品包含多个内容项,其中第一行为产品参数,第二行开始的连续若干行(行数与内容项数相等)为内容参数。若参数本身包含字符“/”,则用连续的两个字符“/”表示单个字符“/”。产品参数定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4productName产品名称字符串最大100billingPolicyID计费策略全局唯一标识整型4PreferentialID优惠策略全局唯一标识,无优惠策略时取值为“-1”。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16productStatus产品状态:1:正常2:暂停3:注销4:删除5:测试整型4orderLimitation订购产品的限制条件1:18岁以下可订购2:18岁以上可订购整型4第79页
autoContinueTag自动续订标志1:支持自动续订2:不支持自动续订整型4serviceID保留,暂不做规定,且在接口上传送时取值为“-1”。整型4serviceName保留,暂不做规定,且在接口上传送时取值为“-”。字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4extInfo扩展信息。无扩展信息时取值为“-”。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4billingPolicyID计费策略全局唯一标识,若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)synPLMsgResponse接口调用返回状态:下载IPTV产品列表数据文件操作是否成功1:文件下载成功2:文件下载失败3:FTP服务器不可达4:FTP用户名或密码无效5:目标文件不存在整型41.1添加IPTV产品接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:addProduct接口功能:向区域中心IPTV业务管理系统中添加单个新定义的IPTV产品。备注说明:根据需要手工调用。第79页
1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)productID产品全局唯一标识整型4productName产品名称字符串最大100billingPolicyID计费策略全局唯一标识整型4PreferentialID优惠策略全局唯一标识,无优惠策略时取值为“-1”。整型4productTypeID保留,取值暂不做规定。整型4productType保留,取值暂不做规定。字符串最大16productStatus产品状态:1:正常4:测试整型4orderLimitation订购产品的限制条件1:18岁以下可订购2:18岁以上可订购整型4autoContinueTag自动续订标志1:支持自动续订2:不支持自动续订整型4serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100contentList内容列表结构数组变长contentListNum内容列表元素个数,取值必须大于0整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024内容列表元素定义:名称说明数据类型长度(字节)contentID内容标识整型4contentName内容名称字符串最大100independentRating独立计费标志:1:内容独立计费,不受所属产品费率限制。2:内容不独立计费。整型4billingPolicyID计费策略全局唯一标识,若内容不独立计费,此参数取值不做规定。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)addProductResponse接口调用返回状态:添加IPTV产品操作是否成功1:添加成功2:添加失败3:目标产品已存在整型4第79页
1.1修改IPTV产品状态接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synProductStatus接口功能:修改区域中心IPTV业务管理系统中产品状态。备注说明:根据需要手工调用。一次可删除多个IPTV产品1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)productID产品全局唯一标识整型4productStatus产品状态:1:正常2:暂停3:注销4:删除5:测试整型4l接口响应参数名称说明数据类型长度(字节)synProductStatusResponse接口调用返回状态:修改IPTV产品状态操作是否成功1:修改成功2:修改失败整型41.2更新用户订购信息接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:updateUsrOrderInfo接口功能:由省级IPTV管理系统将产品订购关系下发给区域中心IPTV业务管理系统备注说明:实时调用。对区域中心IPTV业务管理系统中已经存在对应用户的产品订购关系进行更新。1.2.2接口参数l接口调用参数第79页
名称说明数据类型长度(字节)usrID用户全局唯一标识整型4productList产品列表结构数组变长productListNum产品列表元素个数,取值必须大于0整型4serviceID保留,取值暂不做规定整型4serviceName保留,取值暂不做规定字符串最大100usrExtInfo扩展信息。无扩展信息时取值为空串。字符串最大100产品列表元素定义:名称说明数据类型长度(字节)productID产品全局唯一标识整型4beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14autoContinueTag自动续订标志:1:自动续订2:不自动续订若产品本身不支持自动续订,则此参数无效,取值不做规定。整型4autoContinueDuration若产品支持自动续订,则自动续订时间长度1:1周2:1个月3:3个月若产品不支持自动续订,则本参数无效。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大100l接口响应参数名称说明数据类型长度(字节)updateUOIResponse接口调用返回状态:更新用户定购信息操作是否成功1:更新成功2:更新失败3:目标用户ID不存在整型41.1用户业务欠费停机数据接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:sendUsrArrearageSuspensionList接口功能:省级IPTV业务管理系统通知区域中心IPTV业务管理系统用户欠费停机。第79页
备注说明:定时调用。计费帐务系统将欠费停机的用户标识发送给省级IPTV业务管理系统,省级IPTV业务管理系统转发欠费停机的用户标识到区域中心。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)sendUASList欠费停机用户信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4欠费停机用户信息列表元素定义名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrSuspBeginTime开始停机时间,数据格式为:yyyyMMddHHmmss若当前时间超过参数值规定的时间点,则立即生效。字符串14l接口响应参数名称说明数据类型长度(字节)sendUASListResponse接口调用返回状态:发送欠费停机用户ID列表操作是否成功1:发送成功2:发送失败3:目标用户ID不存在整型4notExistedUsrIDList不存在的目标用户ID列表若发送成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若发送成功,则取值必须为0整型4不存在的目标用户ID列表元素定义:名称说明数据类型长度(字节)usrID用户全局唯一标识整型41.2用户业务复机开通信息接口1.2.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:sendUsrResumeList接口功能:省级IPTV业务管理系统通知区域中心IPTV业务管理系统用户复机开通。第79页
备注说明:实时调用。计费帐务系统将复机的用户标识发送给省级IPTV业务管理系统,省级IPTV业务管理系统转发复机的用户标识到区域中心。1.1.1接口参数l接口调用参数名称说明数据类型长度(字节)sendURList复机用户信息列表结构数组变长listNum数组元素个数,取值必须大于0整型4复机用户信息列表元素定义名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrResumeTime开始复机时间,数据格式为:yyyyMMddHHmmss若当前时间超过参数值规定的时间点,则立即生效。字符串14l接口响应参数名称说明数据类型长度(字节)sendURListResponse接口调用返回状态:发送复机用户ID列表操作是否成功1:发送成功2:发送失败3:目标用户ID不存在整型4notExistedUsrIDList不存在的目标用户ID列表若发送成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若发送成功,则取值必须为0整型4不存在的目标用户ID列表元素定义:名称说明数据类型长度(字节)usrID用户全局唯一标识整型41.2统计信息上传接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:区域中心IPTV业务管理系统→省级IPTV业务管理系统调用接口:uploadStatisticData接口功能:第79页
由区域中心IPTV业务管理系统将本区域的IPTV业务使用统计信息上传到省级IPTV业务管理系统。备注说明:定时批量上传统计信息文本文件操作。1.1.1接口参数l接口调用参数具体内容根据实际需要确定,暂时不做统一规定。l接口响应参数具体内容根据实际需要确定,暂时不做统一规定。1.2用户原始话单上传接口1.2.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:区域中心IPTV业务管理系统→省级IPTV业务管理系统调用接口:uploadUsrCallRecord接口功能:将用户原始话单文本文件以FTP方式上传置省级IPTV业务管理系统。备注说明:定时调用。对于后付费用户,由省级IPTV管理系统采集区域中心IPTV系统的原始话单。1.2.2接口参数l接口调用参数名称说明数据类型长度(字节)usrCallRecordFileNameIPTV业务用户原始话单文本文件目标径名。字符串最大1024usrCallRecordFileSrvAddr存放IPTV业务用户原始话单文本文件的目标FTP服务器IP地址整型4usrCallRecordFileSrvAccount存放IPTV业务用户原始话单文本文件的目标FTP服务器帐号,空串表示采用默认帐号。字符串最大20usrCallRecordFileSrvPass存放IPTV业务用户原始话单文本文件的目标FTP服务器密码,空串表示采用默认密码。字符串最大20用户原始话单文本文件每行表示一条用户原始话单信息记录,每行的每个参数之间用“/”分隔。若参数本身包含字符“/”,则用连续的两个字符“/”表示单个字符“/”。统计信息参数定义:名称说明数据类型长度(字节)sequenceNum流水号整型4usrID用户全局唯一标识整型4第79页
beginTime开始使用时间,数据格式为:yyyyMMddHHmmss字符串14endTime结束使用时间,数据格式为:yyyyMMddHHmmss字符串14duration使用时长(单位:秒),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4flux使用流量(单位:KB),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4count使用次数(单位:次),只对特定的资费类型有效,参见5.5,无效时取值不做规定。整型4productID产品全局唯一标识整型4productTypeID保留,取值暂不做规定。整型4serviceID保留,暂时不做规定,且取值为“-1”整型4contentID内容标识整型4extInfo扩展信息。无扩展信息时取值为“-”。字符串最大1024l接口响应参数名称说明数据类型长度(字节)uploadUCRResponse接口调用返回状态:上传IPTV业务用户原始话单文本文件操作是否成功1:文件上传成功2:文件上传失败3:FTP服务器不可达4:FTP用户名或密码无效5:目标路径不存整型41.1预付费扣费请求接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:区域中心IPTV业务管理系统→省级IPTV业务管理系统调用接口:productOrderRequest接口功能:向省级IPTV业务管理系统请求进行预付费用户业务使用扣费操作。备注说明:根据产品的计费类型,每个计费周期(时长、次数、流量等)实时调用一次。预付费用户在区域中心IPTV系统进行授权时,通过该接口向省级IPTV业务管理系统申请扣除指定预付费用户的本次消费的费用。用户卡号及密码为用户每次开机后第一次使用业务前输入通过机顶盒一次。1.1.2接口参数l接口调用参数第79页
名称说明数据类型长度(字节)sequenceNum流水号整型4usrID用户全局唯一标识整型4usrCardID用户卡ID字符串20usrCardPass用户卡密码字符串最大20productID产品全局唯一标识整型4productTypeID保留,取值暂不做规定。整型4serviceID保留,取值暂不做规定整型4contentID内容标识整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)productORResponse接口调用返回状态:请求扣费操作是否成功1:扣费成功2:扣费失败3:用户余额不足整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大10241.1同步计费策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synProdBillingPolicy接口功能:将计费策略同步到区域中心IPTV业务管理系统中。备注说明:根据需要手工调用。对于接口传递参数中包含的计费策略(以计费策略ID为唯一标识),若区域中心IPTV业务管理系统中已经存在则进行更新,若区域中心IPTV业务管理系统中不存在则添加相应的计费策略;对于区域中心IPTV业务管理系统中已经存在但接口传递参数中不存在的计费策略,在区域中心IPTV业务管理系统中保持不变。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)productBPListIPTV产品计费策略列表。结构数组变长listNum数组元素个数,取值必须大于0整型4计费策略参数定义:第79页
名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4billingPolicyName计费策略名称字符串最大100status计费策略状态:1:正常5:测试整型4Rate基本单价,单位“分”。整型4rateUnit基本单价单位,参见5.5。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。整型4offLimitRate超限单价单位,参见5.5。整型4offLimitUnit超限单价,即超过基本单价单位限制参数时的单价,参见5.5。整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)synPBPResponse接口调用返回状态:同步IPTV产品计费策略信息操作是否成功1:同步成功2:同步失败整型41.1添加IPTV产品计费策略接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:addProdBillingPolicy接口功能:向区域中心IPTV业务管理系统中添加单个新定义的IPTV产品计费策略。备注说明:根据需要手工调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4billingPolicyName计费策略名称字符串最大100status计费策略状态:1:正常5:测试整型4Rate基本单价,单位“分”。整型4rateUnit基本单价单位,参见5.5。整型4rateUnitLimitParameter基本单价单位限制参数,参见5.5。整型4offLimitRate超限单价单位,参见5.5。整型4offLimitUnit整型4第79页
超限单价,即超过基本单价单位限制参数时的单价,参见5.5。extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数名称说明数据类型长度(字节)addPBPResponse接口调用返回状态:添加计费策略信息操作是否成功1:添加成功2:添加失败3:目标计费策略ID已存在整型41.1修改IPTV产品计费策略状态接口1.1.1接口描述承载协议:SOAP/CORBA/XML,FTP接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synPBPStatus接口功能:修改区域中心IPTV业务管理系统中IPTV产品计费策略状态。备注说明:根据需要手工调用。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)productBPList计费策略列表结构数组变长listNum数组元素个数,取值必须大于0整型4计费策略参数定义:名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4status计费策略状态:1:正常2:暂停3:注销4:删除5:测试整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数第79页
名称说明数据类型长度(字节)synPBPStatusResponse接口调用返回状态:修改计费策略状态操作是否成功1:修改成功2:修改失败整型4execFailedPBPList修改失败的目标计费策略列表若修改成功,则取值不做规定。结构数组变长listNum数组元素个数,取值大于或等于0若修改成功,则取值必须为0整型4不存在的目标计费策略列表元素定义:名称说明数据类型长度(字节)billingPolicyID计费策略全局唯一标识整型4failReason失败原因:1:目标产品计费策略ID不存在2:原状态与目标状态相同整型41.1同步用户机顶盒ID与用户帐号绑定关系接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:省级IPTV业务管理系统→区域中心IPTV业务管理系统调用接口:synSTBUsrAccountBindingRelation接口功能:向区域中心IPTV业务管理系统发送用户机顶盒ID与用户帐号绑定关系。备注说明:实时调用。用户开户机顶盒激活后(激活前用户状态为“开户暂停”)或用户更换机顶盒并激活后(激活前用户状态为“调试”),省级IPTV业务管理系统下发用户机顶盒ID与用户帐号绑定关系到区域中心。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4usrIPTVAccount用户IPTV业务帐号字符串16STBID与用户IPTV业务帐号绑定的机顶盒ID(参见机顶盒与IPTV业务平台接口规范)字符串最大32extInfo扩展信息。无扩展信息时取值为空串。字符串最大1024l接口响应参数第79页
名称说明数据类型长度(字节)synSTBUABRResponse接口调用返回状态:发送用户机顶盒ID与用户帐号绑定关系是否成功:1:成功2:失败3:目标用户ID不存在4:目标用户IPTV业务帐号不存在5:用户状态不是“开户暂停”或“调试”整型4extInfo扩展信息。无扩展信息时取值为空串。字符串最大10241.1发送用户转向互联网业务主页面消息接口1.1.1接口描述承载协议:SOAP/CORBA/XML接口方向:区域中心IPTV业务管理系统→省级IPTV业务管理系统调用接口:sendUsrRedirectMessage接口功能:区域IPTV业务管理系统通知省级IPTV业务管理系统将用户鉴权信息发送给BSSP。备注说明:实时调用。参见10.2。1.1.2接口参数l接口调用参数名称说明数据类型长度(字节)usrID用户全局唯一标识整型4l接口响应参数名称说明数据类型长度(字节)sendURedirectMsgResponse接口调用返回状态:发送用户重定向消息是否成功1:发送成功2:发送失败3:目标用户ID不存在整型4第79页'
您可能关注的文档
- 属制品技术规范—铝及铝型材技术要求new
- 南方电网运行安全风险量化评估技术规范
- 粮食储存场所消防安全管理技术规范
- 变电站无线测温在线监测系统技术规范书
- 中国电信业务网络设备技术规范-增值业务运营数据管理设备(vsod)技术规范(v0.1.0)
- 中国电信种子云管理平台技术规范v1.1
- 中国电信网络视频监控业务技术规范(v3.0)—中心服务平台分册_v5
- 中国电信网络视频监控业务技术规范v3-bss分册-v5
- 中国移动网元omc安全接入接口技术规范 v0.9
- 中国联通gsm无线网持续性网络优化dt技术规范
- 中国联通oss-gsmwcdma网络优化及业务分析系统部省接口技术规范_第二部分:与gsm无线接入网相关的信息模型v1
- 中国联通传输网综合网络管理系统技术规范-总册
- 中国联通光传送网(otn)技术规范v1.1
- 中国联通增值业务综合网管系统技术规范 第三分册:语音类增值业务网关技术规范v3.0-正式版本
- 中国联通增值业务综合网管系统技术规范 第一分册:公共增值业务网管技术规范v3.0-正式版本
- 国家标准《尾矿堆积坝岩土工程技术规范》
- 国家药品标准物质技术规范
- 苏州市城市房屋征收评估技术规范(试行)