《IPTV业务管理平台与业务系统接口技术.docx》由会员分享，可在线阅读，更多相关《IPTV业务管理平台与业务系统接口技术.docx（67页珍藏版）》请在三一文库上搜索。
1、文件编号：SHDX/ZS/CZ/JG/002/A/20081中国电信集团上海市电信公司IPTV 业务管理平台与业务系统接口技术规范 V2.2目的本规范是在中国电信集团公司发布的IPTV 业务管理平台与业务系统接口技术规范 V2.0的基础上，根据中国电信上海公司 IPTV 运 营的实际情况，进一步调整修订而成的。本规范供引入 IPTV 能力平台设备、IPTV 业务管理平台设备时参 照执行。本技术规范的增补、修订和解释权归中国电信上海公司所有。如中国电信上海公司在此之前的文件与本技术规范有矛盾，按此技术规 范执行。本技术规范自发布之日起实施。2适用范围本规范规定了 IPTV 业务管理平台与业务系统
2、之间的接口。本规范适用于 IPTV 业务管理平台、EPG 服务系统、内容分发系统之间的接口开发。为中国电信上海公司 IPTV 机顶盒和平台的接口开放的测试提供依据。为中国电信上海公司 IPTV 能力平台设备、IPTV 业务管 理平台设备的选择提供了依据。3引用文件/标准下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最 新版本适用于本标准。RFC2616: Hypertext Transfer ProtocolR
3、FC3275: Extensible Makeup LanguageW3C: Web Services Description LanguageIPTV 业务管理平台技术规范4定义/术语EPGHTTPElectronic Programmer GuideHypertext Transfer Protocol电子节目单超文本传输协议IP Internet ProtocolMAC Media Access ControlSOAP Simple Object Access Protocol STB Set Top BoxURL Uniform Resource Locator网络协议媒体访问控制层简
4、单对象访问协议机顶盒统一资源定位符5 IPTV 业务管理平台与业务系统接口5.1 总体框架业务系统包括 EPG 服务系统、内容分发系统、增值业务系统和其他 IPTV 的业务系统，IPTV 业务管理平台与业务系统的总体框架如图 所示：业务系统EPG 服务系统内容分发系统业务管理平台增值业务系统其他业务系统图 5-1-1：IPTV 业务管理平台与业务系统框架图IPTV 业务管理平台与业务系统接口包括以下接口：a) EPG 首页鉴权接口l 接口描述：本接口在用户访问 EPG 首页时，EPG 服务系统向业 务管理平台请求鉴权。l 承载协议：SOAPb) UserToken 更新接口l 接口描述：本接口
5、在用户令牌 UserToken（参见机顶盒与 IPTV业务运营平台接口技术规范）失效时，EPG 服务系统重定向到业务管理平台请求新的 UserToken。l 承载协议：HTTPc) Session 丢失后获取接口l 接口描述：本接口机顶盒访问 EPG 平台时， EPG 平台通过Session（或 cookie）记忆用户的临时身份凭证（UserToken）。但是，由于 Session（或 Cookie）的时限性，使得机顶盒在一段时间内没有访问 EPG 页面时，机顶盒将丢失与 EPG 之间的 Session，从而使得 EPG 丢失用户的 UserToken，无法继续为该用户机顶盒提供 IPTV 服
6、务。l 承载协议：HTTPd) 业务鉴权接口l 接口描述：本接口在用户通过 EPG 请求业务资源时，EPG 服务系统向业务管理平台请求业务鉴权，业务管理平台将鉴权结果返 回给 EPG 服务系统。l 承载协议：SOAPe) 业务订购接口l 接口描述：本接口在用户请求使用业务时，EPG 服务系统向业务管理平台请求业务订购，用户完成订购后，EPG 服务系统保存 订购信息，再返回处理页面给用户。l 承载协议：SOAPf) 直播频道列表更新接口l 接口描述：本接口在用户请求订购直播频道，当业务管理平台返回订购成功响应后，EPG 服务系统将用户重定向至业务管理平台，要求重新设置直播频道列表。业务管理平台通
7、过 CTCSetConfig设置订购成功的频道列表，并将机顶盒重定向至 EPG 服务系统。 l 承载协议：HTTPg) 产品包信息获取接口l 接口描述：本接口为 EPG 服务系统向业务管理平台请求产品包信息，业务管理系统将产品包信息返回给 EPG 服务系统。 l 承载协议：SOAPh) 用户身份重定向接口l 接口描述：本接口在用户请求使用业务时，接收到 HTTP 重定向命令，要求重定向到业务管理平台的业务订购页面时触发，用户完成订购后，EPG 服务系统保存订购信息，再返回处理页面给 用户。l 承载协议：HTTPi) 增值业务订购查询接口l 接口描述：增值业务平台向业务管理平台请求查询用户订购过
8、 的所有产品信息。l 承载协议：SOAPj) 增值业务产品详细信息查询接口l 接口描述：增值业务平台向业务管理平台请求查询用户订购过 的产品详细信息。l 承载协议：SOAPk) 增值业务产品订购接口l 接口描述：当用户选择订购某增值业务时，增值业务平台将用户重定向至业务管理平台进行该增值业务的订购。当用户订购成功后，业务管理平台能将用户重定向回增值业务平台显示订购结 果。l 承载协议：HTTPl) 业务能力系统数据采集接口l 接口描述：为了进行 IPTV 业务的经营分析需要向 IPTV 平台采 集相关数据。l 承载协议：FTP（【注】当业务能力平台、增值业务系统与业务管理平台进行横向 SOAP
9、 接口进行交互时，能够对横向接口连接情况进行监测，并在横 向接口连接时间超过10s 的情况下通过错误提示页面告知用户并，要 求机顶盒重新发起认证请求）。5.2 EPG 首页鉴权接口5.2.1接口时序STB EPG 服务系统a）HTTP 请求d）HTTP 响应业务管理平台b） SOAP 请求c） SOAP 响应图 5-2-1-1：EPG 首页鉴权流程5.2.2接口协议内容承载协议： 接口方向：接口功能：SOAPEPG 服务系统 业务管理平台EPG 服务系统向业务管理平台请求鉴权，通过鉴 权后再给用户下发 EPG 首页SOAP 接口请求消息 EPGAuth 包含如下信息：表 5-2-2-1：请求
10、EPGAuth名称UserToken说明业务管理平台为该用户分配的临时身 份证明数据类型String长度（字节）32是否必选MSOAP 接口应答消息 EPGAuthResponse 包含以下信息：表 5-2-2-2：响应 EPGAuthResponse名称说明数据长度是否UserIDResultDescriptionUserGroupNMBEPGGroupNMBSTBIDIPTV 用户业务编号结果，0：成功 其他：失败结果描述用户对应的用户分组信息标识用户对应的 EPG 分组信息标识机顶盒编号类型StringStringStringStringStringstring（字节）364256883
11、2必选MMOOMO机 顶 盒 的 MAC 地 址 ， 格 式 为 ：MAC String 13 Oxx:xx:xx:xx:xx:xx用户已购买的 IPTV 产品编号组合，组合间采用”;”分隔，组合内采用”,”分隔，分别为产品 ID，内容 ID，可以为以下情形：1 、 ProductID：表示整个产品的订购关系，且有效期未知；2 、 ProductID,ExpiredTime ：表示整个产品的订购关系，且存在有效期；Products3 、 ProductID,ContentID：未知有效期String不定O的内容订购关系，如 ContentID 为直播频道 ID，则为直播频道订购关系，如为点播内
12、容 ID，则为点播内容订购关系；4 、 ProductID,ExpiredTime,ContentID：存 在 有 效 期 的 内 容 订 购 关 系 ， 如ContentID 为直播频道 ID，则为直播频道订购关系，如为点播内容 ID，则为点播内容订购关系。UserToken 的失效时间， 格式为：TokenExpiredTime String 14 OYYYYMMDDhhmmss 。缺少该参数表示在一次登录期间，永久有效。5.3 UserToken 更新接口5.3.1接口时序STBEPG 服务系统业务管理平台a）Http 请求c）Http 响应b）UserToken 未过期d）UserTo
13、ken 已过期e） 重定向f） 频道更新或重认证g） 频道更新或重认证结束请求h） 返回新的 UserToken图 5-3-1-1：UserToken 更新流程图用户 UserToken 更新过程如下：a) STB 向 EPG 服务系统发起 http 请求。b) EPG 服务系统检查 UserToken 是否过期，如果未过期，则跳转到 c，如果已过期，则跳转到 e。c) EPG 服务系统响应请求。d) UserToken 已过期。e) EPG 服务系统将用户请求重定向到业务管理平台，请求新的 UserToken，请求参数 ReturnURL,OldUserToken，Action。f) 如业务
14、管理平台需要 STB 重新认证或发生频道更改需要更新频 道列表，则下发重认证页面或频道更新页面；g) STB 重新认证或更新频道结束后，由页面逻辑控制发起重定向 请求；h) 业务管理平台返回新的 UserToken，返回参数 NewUserToken、 Result。（【注】：IPTV 业务能力平台在完成用户UserToken 更新后都应该再次发起首页鉴权请求，以保证当前用户已订购产品列表为最新且可用 的。）5.3.2接口协议内容承载协议： 接口方向：接口功能：HTTP GETEPG 服务系统重定向 业务管理平台 UserToken 失效时，EPG 服务系统重定向到业务管 理平台请求新的 Us
15、erToken 。请求消息包含以下关键参数表5-3-2-1：更新UserToken请求参数说明名称说明数据类型长度（字节）是否必选SPIDUserIDOldUserTokenSP 的唯一标识IPTV 用户业务编号过期的 UserTokenStringstringString83632OOMReturnURLAction更新 UserToken 后返回的 URL ，采用 URLEncoding 的 ANSI 方式操作类型，此处使用： “UserTokenExpired”string 256 MString 20 M响应消息表5-3-2-2：更新UserToken返回参数说明名称SPIDUserI
16、DNewUserTokenResult说明SP 的唯一标识IPTV 用户业务编号新的 UserToken更新结果 0：成功 其他：失败数据类型StringstringStringString长度（字节）836324是否必选OMMMUserToken 的失效时间，格式为：TokenExpiredTime YYYYMMDDhhmmss。缺少该参数表示永久有效。String 14 O5.4 Session 丢失后获取接口机顶盒访问 EPG 平台时，EPG 平台通过 Session（或 cookie）记忆用户的临时身份凭证（UserToken ）。但是，由于 Session（或 Cookie）的时限性
17、，使得机顶盒在一段时间内没有访问 EPG 页面时，机顶盒将丢失与 EPG 之间的 Session，从而使得 EPG 丢失用户的 UserToken，无 法继续为该用户机顶盒提供 IPTV 服务。5.4.1接口时序为了解决这一问题，可以采用 SSO 流程获取用户的 UserToken。以 下是机顶盒与 EPG 交互、Session 丢失和 EPG 处理流程：a). 机顶盒开机认证通过，业务管理平台为其分配临时身份凭证 UserTokenb). 机顶盒访问 EPG 首页，携带 UserTokenc). EPG 以 Session（或 Cookie）方式保存用户的 UserTokend). EPG
18、在调用业务管理平台的业务鉴权、产品订购时必需携带有效的 UserToken。EPG 通过 UserToken 更新机制来保证 UserToken 的有效性。e). 机顶盒通过访问 EPG 页面来维持机顶盒与 EPG 之间的 Session有效。机顶盒在一段时间内没有操作或者机顶盒离开 EPG 访问增值业务，超过 Session 的超时时限，机顶盒丢失与 EPG 之间 的 Session。f). 机顶盒再次访问 EPG，EPG 因 Session 丢失，无法获得机顶盒 的 UserTokeng). EPG 系统将机顶盒重定向到业务管理系统，发起用户身份重定 向 SSO 请求, 携带 Return
19、URL 等参数h). 业务管理平台获取机顶盒的 UserToken 后，通过通过重定向携 带参数方式，将 UserToken 等参数返回给 EPG 系统i). EPG 获得用户身份，继续为用户提供服务。5.4.2接口协议内容承载协议： 接口方向： 接口功能：HTTP SSOEPG 服务系统 业务管理平台采用 SSO 流程获取用户的 UserToken。业务身份重定向SSO请求参数：表5-4-2-1：业务身份重定向SSO请求参数说明名称SPIDReturnURL说明SP的唯一标识返回增值业务系统页面的URL数据类型stringstring长度（字节）8256是否必选MMReturnInfoAct
20、ion返回增值业务系统页面需要携带的额外信 息，可用于区分不同的SSO请求操作类型，此处使用：UserTokenRequeststring 256 Ostring 20 M业务身份重定向SSO返回参数：表5-4-2-2：业务身份重定向SSO响应参数说明名称说明数据类型长度(字节)是否必选Result身份获取结果string4M0：成功；其他：失败UserTokenSPIDUserIDEPGGroupNMBIPTV用户业务编号SP的唯一标识IPTV用户业务编号用户对应的EPG分组信息标识stringstringstringstring368368MOOOUserGroupNMB 用户对应的分组信
21、息标识string8ODescription结果描述string256OUserToken 的 失 效 时 间 ， 格 式 为ExpiredTime YYYYMMDDhhmmss。缺少在一次开机过程中该参数表示永久有效。string 14 O返回EPG页面需要携带的额外信息，可用ReturnInfo string 256 O于区分不同的SSO请求5.5 业务鉴权5.5.1接口时序业务鉴权接口时序流程如下：STB业务系统开机认证流程a）用户业务使用请求业务管理平台(电信)b）业务鉴权请求（产品id,UserToken等）c) 鉴权d) 返回鉴权结果e) 鉴权未通过，转业务定购流程f)鉴权通过g）
22、业务使用请求响应， 返回实际服务内容图 5-4-1-1：业务鉴权流程图a) 终端访问业务系统的业务使用入口，请求使用某项业务；b) 业务系统要求鉴权，发起到业务管理平台的 SOAP 请求，携带 ProductID、UserToken 等信息；c) 业务管理平台根据产品、用户信息进行业务鉴权；d) 业务管理平台通过 SOAP 响应返回鉴权结果；e) 如果鉴权未通过，则业务系统发起业务订购的流程；f) 如果鉴权通过，则业务系统允许使用；g) 业务系统返回用户请求的实际业务内容，继续业务的使用。5.5.2接口协议内容承载协议：SOAP接口方向： 接口功能：业务系统 业务管理平台业务系统向业务管理平台
23、请求使用业务表 5-4-2-1：业务鉴权请求 ServiceAuthReq名称SPID说明增值业务 SP 的编号，基本业务鉴权时无效数据类型String长度（字节）8是否必选OUserIDUserToken用户登录业务帐号业务管理平台为该用户分配的临时身份证 明，这里通过 EPG 上传给业务管理平台String 36 OString 32 MProductIDServiceIDContentIDIPTV 产品编号IPTV 服务编号IPTV 内容编号StringStringString323232MOMTimeStamp从 1970 年 1 月 1 日 0 时开始的毫秒数digitstring=
24、18 MIP IP 地址String39 OMACTransactionID机 顶 盒 的 MAC 地 址 ， 格 式 为 ： xx:xx:xx:xx:xx:xx事务编号String 17 Ostring 40 O表 5-4-2-2：业务鉴权请求响应名称说 明数据类型长度（字节）是否必选0：成功ResultString 4 M其他：失败UserIDProductIDServiceIDContentIDSTBIDIP用户登录业务帐号产品 ID服务 ID内容 ID机顶盒 IDIP 地址StringStringStringStringstringstring363232323239OMOMOOMAC
25、TransactionIDExpiredTimeBalance机 顶 盒 的 MAC 地 址 ， 格 式 为 ： xx:xx:xx:xx:xx:xx事务编号本订购关系的鉴权失效时间，用绝对时间 表示。格式为：YYYYMMDDhhmmss。如本 参数为空，则表示该订购关系的鉴权长期 有效；如本参数为当前时间，则表示该订 购关系的鉴权一次性有效。预付费用户余额，单位为分。如为后付费用户，该参数缺失或为空可订购的产品列表，在订string 17 Ostring 40 OString 14 Oint 4 OProductList购失败并返回“用户未订Product不定O购”的情况下携带该参数。表5-4
26、-2-2：Product 结构名称说 明数据类型长度（字节）是否必选ProductIDProductNameFee产品ID产品名称产品价格，以分为单位StringStringInt321004MMMPurchaseType0：包月支付，用户选择订购产品后，按照 固定包月费用计费，在当月内无需再次向 业务管理平台发起订购请求；1 ：按次支付，用户选择订购产品后，按照 使用次数进行计费无需重新发起订购请求2 ：免费3 ：ppv ，用户选择订购产品后，进行一次 性计费。再次使用时仍需订购该产品4 ：SVOD；5 ：PVOD；Int 4 OProductDescListPriceRentalTermL
27、imitTimes产品描述标称价格，以分为单位租期可使用次数StringIntIntInt200444OOOO5.6 业务订购接口时序5.6.1STBa）订购请求业务系统业务管理平台b） 业务订购请求c） 返回订购响应d）保存订购信息e）返回处理页面图 5-5-1-1：即时业务订购流程图5.6.2接口协议内容承载协议： 接口方向： 接口功能：SOAPEPG 服务系统 业务管理平台 用户订购业务请求消息包含以下关键参数表5-5-2-1：业务订购请求参数名称SPID SP 的唯一标识说明数据类型string长度（字节）8是否必选OUserID IPTV 用户业务编号业务管理平台为该用户分配的临时身
28、份证string 36 OUserToken明，可采用 Cookie 的方式传递string 32 MContentIDServiceIDProductID内容 IDIPTV 服务编号IPTV 产品编号stringstringstring323232MOM操作类型：Action 1：表示订购；2：表示退订。String 20 M业务管理平台返回的响应消息携带以下参数：表5-5-2-2：SOAP响应消息名称ResultDescriptionUserID说明业务订购结果 0：成功 其他：失败结果描述IPTV 用户业务编号数据类型StringStringstring长度（字节）425636是否必选M
29、OO业务管理平台为该用户分配的临时身份UserToken string 32 O证明，可采用 Cookie 的方式传递ContentIDServiceIDProductID内容 IDIPTV 服务编号IPTV 产品编号stringstringstring323232MOMSPIDTransactionIDSP 的唯一标识订购的事务编号stringstring840OO订购关系的失效时间， 格 式 为ExpiredTime YYYYMMDDhhmmss。缺少该参数表示永久有效。预付费用户的费用余额，String 14 OBalanceFeePurchaseType单位为分。如为后付费用户，该参数
30、缺失或为空。产品价格，以分为单位0：包月支付，用户选择订购产品后，按 照固定包月费用计费，在当月内无需再次 向业务管理平台发起订购请求；1 ：按次支付，用户选择订购产品后，按 照使用次数进行计费无需重新发起订购 请求2 ：免费3 ：ppv，用户选择订购产品后，进行一次 性计费。再次使用时仍需订购该产品4 ：SVOD5 ：PVODInt 4 OInt 4 MInt 4 O5.7 直播频道列表更新接口5.7.1接口时序STB EPG 服务系统业务管理平台a) 直播频道成功订购流程b) 重定向，设置新的频道列表c) 频道更新响应图 5-6-1-1：直播频道列表更新流程图a) STB 通过业务订购接口
31、完成对于直播频道的订购，并通过直播 订购接口步骤 7 返回订购成功的响应。b) EPG 服务系统将用户重定向至业务管理平台，要求重新设置直 播频道列表。c) 业务管理平台通过 CTCSetConfig 设置订购成功的频道列表，并 将机顶盒重定向至 EPG 服务系统。5.7.2接口协议内容承载协议： 接口方向： 接口功能：HTTP GETEPG 服务系统重定向 业务管理平台直播频道订购成功后，对直播频道列表进行更新请求消息包含以下关键参数表5-6-2-1：更新直播频道列表请求参数说明名称SPIDUserID说明SP 的唯一标识IPTV 用户业务编号数据类型Stringstring长度（字节）83
32、6是否必选OMReturnURLActionChannelIDList更新 UserToken 后返回的 URL ，采用 URLEncoding 的 ANSI 方式操作类型，此处使用： “ChannelListUpdate”需要更新的频道列表，采用”|”分隔的频 道 ID 列表，如 134|123|335string 256 MString 20 MString 256 M业务管理系统重定向返回，通过 URL 参数携带以下信息表5-6-2-2：更新直播频道列表返回参数说明名称SPIDUserIDResult说明SP 的唯一标识IPTV 用户业务编号更新结果 0：成功 其他：失败数据类型Stri
33、ngstringString长度（字节）8364是否必选OMM5.8 产品包信息获取接口5.8.1接口时序EPG 服务系统业务管理平台a） 产品包获取请求b） 产品包获取响应图 5-7-1-1：产品包信息获取流程图5.8.2接口协议内容承载协议： 接口方向： 接口功能：SOAPEPG 服务系统 业务管理平台EPG 服务系统从业务管理平台获取产品包信息。SOAP 接口请求消息 ProInfo 不包含任何信息。SOAP 接口响应消息 ProInfoResponse，需要包含以下信息：表 5-7-2-1：响应 ProInfoResponse名称说明数据类型长度（字节）是否必选ProductAmoun
34、t产品数量Int4M见表Product产品列表Product 5-6-2-2ProdMuct说明表 5-7-2-2： Product说明名称ProductID IPTV 产品编号说明数据类型String长度（字节）32是否必选MServiceAmount服务数量Int 4M见表Service服务列表Service 5-7-2-3SerMvice说明表 5-7-2-3： Service说明名称ServiceID IPTV 服务编号说明数据类型string长度（字节）32是否必选M5.9 增值业务认证鉴权STB增值业务系统业务管理平台a）首次访问b） SSO 获取用户身份c） 查询增值业务订购信息
35、d）增值业务访问e） 业务订购f） 增值业务鉴权g）业务使用图 5-9-1 ：即时业务订购流程图a) 用户首次访问增值业务系统；b) 增值业务系统通过 SSO 过程获取用户身份，参见 5.7.1； c) 增值业务系统查询增值业务订购信息，参见 5.7.2；d) 用户进行增值业务访问；e) 如用户未订购业务，则要求用户进行订购，参见 5.5； f) 增值业务系统进行业务鉴权，参见 5.4；g) 用户使用增值业务。5.9.1用户身份重定向（SSO）5.9.1.1 接口时序STBa）业务请求增值业务系统业务管理平台c）请求响应b）检测到 UserTokend）未检测到 UserTokene）HTTP
36、 重定向f）SSO 返回新的 UserToken图 5-9-1-1-1：重定向认证用户身份流程在用户首次访问增值业务系统无法判断用户身份时，使用该 SSO 重定向过程获取 UserToken 以判定用户身份：a) 用户访问增值业务系统/IPTV 业务系统；b) 增值业务系统检测 UserToken；c) 如增值业务系统检测到合法 UserToken，则返回正常使用响应； d) 增值业务系统无法获取 UserToken，则开始重定向过程；e) 增值业务系统将用户重定向到业务管理平台，携带 ReturnURL 等参数；f) 业务管理平台检查用户 cookie 获取 UserToken，如果没有检测到，通过重新认证产生 UserToken（参见 5.3），并通过重定向参数方式，将 UserToken 等参数返回给增值业务系统。5.9.1.2 接口协议内容承载协议： 接口方向：接口功