IPTV业务管理平台与业务系统接口技术

1、.文件编号： SHDX/ZS/CZ/JG/002/A/2008中国电信集团上海市电信公司IPTV 业务管理平台与业务系统接口技术规范V2.21 目的本规范是在中国电信集团公司发布的 IPTV 业务管理平台与业务系统接口技术规范 V2.0的基础上，根据中国电信上海公司 IPTV 运营的实际情况，进一步调整修订而成的。本规范供引入 IPTV 能力平台设备、 IPTV 业务管理平台设备时参照执行。本技术规范的增补、 修订和解释权归中国电信上海公司所有。 如中国电信上海公司在此之前的文件与本技术规范有矛盾， 按此技术规范执行。本技术规范自发布之日起实施。2 适用范围本规范规定了 IPTV 业务管理平台

2、与业务系统之间的接口。本规范适用于 IPTV 业务管理平台、 EPG服务系统、内容分发系统之间的接口开发。为中国电信上海公司 IPTV 机顶盒和平台的接口开放的测试提供依据。为中国电信上海公司 IPTV 能力平台设备、 IPTV 业务管理平台设备的选择提供了依据。.下载可编辑 .3 引用文件 / 标准下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准， 然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。RFC2616: Hypertext Tr

3、ansfer ProtocolRFC3275: Extensible Makeup LanguageW3C: Web Services Description Language IPTV 业务管理平台技术规范4 定义/术语EPGElectronic Programmer Guide电子节目单HTTPHypertext Transfer Protocol超文 本 传输 协议IPInternet Protocol网络协议MACMedia Access Control媒体访问控制层SOAP Simple Object Access Protocol简单对象访问协议STBSet Top Box机顶盒U

4、RLUniform Resource Locator统一资源定位符.下载可编辑 .5 IPTV 业务管理平台与业务系统接口5.1 总体框架业务系统包括EPG服务系统、内容分发系统、增值业务系统和其他 IPTV 的业务系统， IPTV 业务管理平台与业务系统的总体框架如图所示：业务系统EPG 服务系统内容分发系统业务管理平台增值业务系统其他业务系统图 5-1-1 ：IPTV 业务管理平台与业务系统框架图IPTV 业务管理平台与业务系统接口包括以下接口：a) EPG首页鉴权接口接口描述：本接口在用户访问EPG首页时， EPG服务系统向业务管理平台请求鉴权。承载协议： SOAPb) UserToke

5、n 更新接口接口描述：本接口在用户令牌UserToken（参见机顶盒与 IPTV.下载可编辑 .业务运营平台接口技术规范 ）失效时， EPG服务系统重定向到业务管理平台请求新的UserToken。承载协议： HTTPc)Session 丢失后获取接口接口描述：本接口机顶盒访问EPG平台时， EPG 平台通过Session （或 cookie ）记忆用户的临时身份凭证（ UserToken）。但是，由于 Session （或 Cookie）的时限性，使得机顶盒在一段时间内没有访问 EPG页面时，机顶盒将丢失与 EPG之间的 Session ，从而使得 EPG丢失用户的 UserToken，无法继

6、续为该用户机顶盒提供 IPTV 服务。承载协议： HTTPd) 业务鉴权接口接口描述：本接口在用户通过 EPG请求业务资源时， EPG服务系统向业务管理平台请求业务鉴权，业务管理平台将鉴权结果返回给 EPG服务系统。承载协议： SOAPe) 业务订购接口接口描述：本接口在用户请求使用业务时， EPG服务系统向业务管理平台请求业务订购，用户完成订购后， EPG服务系统保存订购信息，再返回处理页面给用户。承载协议： SOAPf) 直播频道列表更新接口.下载可编辑 .接口描述：本接口在用户请求订购直播频道， 当业务管理平台返回订购成功响应后， EPG服务系统将用户重定向至业务管理平台，要求重新设置直

7、播频道列表。 业务管理平台通过 CTCSetConfig 设置订购成功的频道列表，并将机顶盒重定向至 EPG服务系统。承载协议： HTTPg) 产品包信息获取接口接口描述：本接口为 EPG服务系统向业务管理平台请求产品包信息，业务管理系统将产品包信息返回给 EPG服务系统。承载协议： SOAPh) 用户身份重定向接口接口描述：本接口在用户请求使用业务时，接收到 HTTP重定向命令，要求重定向到业务管理平台的业务订购页面时触发，用户完成订购后， EPG服务系统保存订购信息，再返回处理页面给用户。承载协议： HTTPi) 增值业务订购查询接口接口描述：增值业务平台向业务管理平台请求查询用户订购过的

8、所有产品信息。承载协议： SOAPj) 增值业务产品详细信息查询接口接口描述：增值业务平台向业务管理平台请求查询用户订购过的产品详细信息。.下载可编辑 .承载协议： SOAPk) 增值业务产品订购接口接口描述：当用户选择订购某增值业务时，增值业务平台将用户重定向至业务管理平台进行该增值业务的订购。当用户订购成功后，业务管理平台能将用户重定向回增值业务平台显示订购结果。承载协议： HTTPl) 业务能力系统数据采集接口接口描述：为了进行 IPTV 业务的经营分析需要向IPTV 平台采集相关数据。承载协议： FTP（【注】当业务能力平台、增值业务系统与业务管理平台进行横向 SOAP接口进行交互时，

9、能够对横向接口连接情况进行监测，并在横向接口连接时间超过 10s 的情况下通过错误提示页面告知用户，并要求机顶盒重新发起认证请求。）.下载可编辑 .5.2 EPG首页鉴权接口接口时序STBEPG 服务系统业务管理平台a） HTTP 请求b） SOAP 请求c） SOAP 响应d） HTTP 响应图 5-2-1-1 ：EPG首页鉴权流程接口协议内容承载协议：SOAP接口方向：EPG服务系统 业务管理平台接口功能：EPG服务系统向业务管理平台请求鉴权，通过鉴权后再给用户下发 EPG首页SOAP接口请求消息 EPGAuth包含如下信息：表 5-2-2-1：请求 EPGAuth名称说明数据长度是否类型

10、（字节）必选UserToken业务管理平台为该用户分配的临时身32M份证明StringSOAP接口应答消息 EPGAuthResponse包含以下信息：表 5-2-2-2 ：响应 EPGAuthResponse名称说明数据长度是否.下载可编辑 .类型（字节）必选UserIDIPTV 用户业务编号String36MResult结果， 0：成功 其他：失败String4MDescription结果描述String256OUserGroupNMB用户对应的用户分组信息标识String8OEPGGroupNMB用户对应的 EPG分组信息标识String8MSTBID机顶盒编号string32OMAC机

11、顶盒的 MAC地址，格式为：13Oxx:xx:xx:xx:xx:xxString用户已购买的IPTV 产品编号组合，组合间采用” ; ”分隔， 组合内采用” , ”分隔，分别为产品 ID ，内容 ID ，可以为以下情形：1、 ProductID：表示整个产品的订购关系，且有效期未知；2、 ProductID,ExpiredTime：表示整个产品的订购关系，且存在有效期；3、 ProductID,ContentID：未知有效Products期的内容订购关系，如ContentID 为 String不定O直播频道ID ，则为直播频道订购关系，如为点播内容ID ，则为点播内容订购关系；4、Produc

12、tID,ExpiredTime,ContentID：存在有效期的内容订购关系，如ContentID为直播频道ID ，则为直播频道订购关系，如为点播内容ID ，则为点播内容订购关系。.下载可编辑 .UserToken的失效时间，格式为：TokenExpiredTimeYYYYMMDDhhmmss。缺少该参数表示在一String14O次登录期间，永久有效。5.3 UserToken 更新接口接口时序STBEPG 服务系统业务管理平台a） Http 请求b） UserToken 未过期c） Http 响应d） UserToken 已过期e）重定向f）频道更新或重认证g）频道更新或重认证结束请求h）返

13、回新的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) 如业务管理平台需要 STB重新认证或发生频道更改需要更新频道列表，则下发重认证页面或频

14、道更新页面；g) STB重新认证或更新频道结束后，由页面逻辑控制发起重定向请求；h) 业务管理平台返回新的 UserToken，返回参数 NewUserToken、 Result 。（【注】：IPTV 业务能力平台在完成用户 UserToken 更新后都应该再次发起首页鉴权请求，以保证当前用户已订购产品列表为最新且可用的。）接口协议内容承载协议：HTTP GET接口方向：EPG服务系统重定向 业务管理平台接口功能：UserToken 失效时， EPG服务系统重定向到业务管理平台请求新的 UserToken。请求消息包含以下关键参数表 5-3-2-1：更新 UserToken 请求参数说明名称数

15、据长度是否说明（字节）必选类型.下载可编辑 .SPIDSP 的唯一标识String8OUserIDIPTV 用户业务编号string36OOldUserToken过期的 UserTokenString32M更新 UserToken后返回的URL，采用256MReturnURLstringURLEncoding 的 ANSI 方式操作类型，此处使用：ActionString20M“UserTokenExpired ”响应消息表 5-3-2-2 ：更新 UserToken 返回参数说明名称说明数据长度是否类型（字节）必选SPIDSP的唯一标识String8OUserIDIPTV 用户业务编号str

16、ing36MNewUserToken新的 UserTokenString32MResult更新结果 0 ：成功 其他：失败String4MUserToken 的失效时间，格式为：TokenExpiredTimeYYYYMMDDhhmmss。缺少该参数表示String14O永久有效。5.4 Session 丢失后获取接口机顶盒访问 EPG平台时， EPG平台通过 Session （或 cookie ）记.下载可编辑 .忆用户的临时身份凭证（UserToken）。但是，由于 Session（或 Cookie ）的时限性，使得机顶盒在一段时间内没有访问 EPG页面时，机顶盒将丢失与 EPG之间的 S

17、ession ，从而使得 EPG丢失用户的 UserToken，无法继续为该用户机顶盒提供 IPTV 服务。接口时序为了解决这一问题，可以采用SSO流程获取用户的UserToken。以下是机顶盒与EPG交互、 Session 丢失和 EPG处理流程：a). 机顶盒开机认证通过，业务管理平台为其分配临时身份凭证UserTokenb). 机顶盒访问 EPG首页，携带 UserTokenc). EPG以 Session （或 Cookie ）方式保存用户的UserTokend). EPG在调用业务管理平台的业务鉴权、产品订购时必需携带有效的 UserToken。EPG通过 UserToken 更新机

18、制来保证UserToken 的有效性。e). 机顶盒通过访问 EPG页面来维持机顶盒与EPG之间的 Session有效。机顶盒在一段时间内没有操作或者机顶盒离开EPG访问增值业务，超过 Session 的超时时限，机顶盒丢失与EPG之间的 Session 。f). 机顶盒再次访问EPG，EPG因 Session 丢失，无法获得机顶盒的 UserToken.下载可编辑 .g). EPG系统将机顶盒重定向到业务管理系统，发起用户身份重定向 SSO请求 , 携带 ReturnURL等参数h). 业务管理平台获取机顶盒的UserToken 后，通过通过重定向携带参数方式，将UserToken 等参数返

19、回给 EPG系统i).EPG获得用户身份，继续为用户提供服务。接口协议内容承载协议：HTTP SSO接口方向：EPG服务系统 业务管理平台接口功能：采用 SSO流程获取用户的UserToken。业务身份重定向 SSO请求参数：表 5-4-2-1 ：业务身份重定向SSO请求参数说明名称说明数据长度是否类型（字节）必选SPIDSP的唯一标识string8MReturnURL返回增值业务系统页面的URLstring256MReturnInfo返回增值业务系统页面需要携带的额外信string256O息，可用于区分不同的SSO请求Action操作类型，此处使用：UserTokenRequeststrin

20、g20M业务身份重定向 SSO返回参数：表 5-4-2-2：业务身份重定向SSO响应参数说明名称说明数据长度是否类型(字节)必选Result身份获取结果string4M.下载可编辑 .0：成功；其他：失败UserTokenIPTV用户业务编号string36MSPIDSP的唯一标识string8OUserIDIPTV用户业务编号string36OEPGGroupNMB用户对应的 EPG分组信息标识string8OUserGroupNMB用户对应的分组信息标识string8ODescription结果描述string256OUserToken 的 失 效 时 间 ， 格 式 为ExpiredTi

21、meYYYYMMDDhhmmss。缺少在一次开机过程string14O中该参数表示永久有效。ReturnInfo返回 EPG页面需要携带的额外信息，可用string256O于区分不同的 SSO请求5.5 业务鉴权接口时序业务鉴权接口时序流程如下：.下载可编辑 .STB业务系统业务管理平台(电信 )开机认证流程a）用户业务使用请求b）业务鉴权请求（产品id,UserToken 等）c)鉴权d)返回鉴权结果e)鉴权未通过，转业务定购流程f) 鉴权通过g）业务使用请求响应，返回实际服务内容图 5-4-1-1 ：业务鉴权流程图a) 终端访问业务系统的业务使用入口，请求使用某项业务；b) 业务系统要求鉴

22、权，发起到业务管理平台的SOAP请求，携带ProductID 、UserToken 等信息；c) 业务管理平台根据产品、用户信息进行业务鉴权；d) 业务管理平台通过 SOAP响应返回鉴权结果；e) 如果鉴权未通过，则业务系统发起业务订购的流程；f) 如果鉴权通过，则业务系统允许使用；g) 业务系统返回用户请求的实际业务内容，继续业务的使用。接口协议内容承载协议：SOAP.下载可编辑 .接口方向：业务系统 业务管理平台接口功能：业务系统向业务管理平台请求使用业务表 5-4-2-1：业务鉴权请求 ServiceAuthReq名称数据长度是否说明（字节）必选类型SPID增值业务 SP的编号，基本业务

23、鉴权时无效String8OUserID用户登录业务帐号String36O业务管理平台为该用户分配的临时身份证UserTokenString32M明，这里通过EPG上传给业务管理平台ProductIDIPTV 产品编号String32MServiceIDIPTV 服务编号String32OContentIDIPTV 内容编号String32MdigitTimeStamp从 1970 年 1 月 1 日 0 时开始的毫秒数 <=18 M stringIPIP 地址String39O机顶盒的MAC地址，格式为：MACString 17 O xx:xx:xx:xx:xx:xxTransactio

24、nI事务编号string40OD表 5-4-2-2：业务鉴权请求响应名称数据长度是否说 明（字节）必选类型Result0：成功String4M.下载可编辑 .其他：失败UserID用户登录业务帐号String36OProductID产品 IDString32MServiceID服务 IDString32OContentID内容 IDString32MSTBID机顶盒 IDstring32OIPIP 地址string39OMAC机顶盒的MAC地址，格式为：string17Oxx:xx:xx:xx:xx:xxTransactionI事务编号string40OD本订购关系的鉴权失效时间，用绝对时间表

25、示。格式为：YYYYMMDDhhmmss。如本参ExpiredTime数为空，则表示该订购关系的鉴权长期有String14O效；如本参数为当前时间，则表示该订购关系的鉴权一次性有效。预付费用户余额，单位为Balance分。如为后付费用户，该int4O参数缺失或为空可订购的产品列表，在订ProductList购失败并返回“用户未订Produc不定Ot购”的情况下携带该参数。.下载可编辑 .表 5-4-2-2 ： Product结构名称说 明数据长度是否类型（字节）必选ProductID产品 IDString32MProductName产品名称String100MFee产品价格，以分为单位Int4

26、M0：包月支付，用户选择订购产品后，按照固定包月费用计费，在当月内无需再次向业务管理平台发起订购请求；1：按次支付，用户选择订购产品后，按照使用次数进行计费无需重新发起订购请求PurchaseType2：免费Int4O3 ： ppv ，用户选择订购产品后，进行一次性计费。再次使用时仍需订购该产品4： SVOD；5： PVOD；ProductDesc产品描述String200OListPrice标称价格，以分为单位Int4ORentalTerm租期Int4OLimitTimes可使用次数Int4O.下载可编辑 .5.6 业务订购接口时序STB业务系统业务管理平台a）订购请求b）业务订购请求c）返

27、回订购响应d）保存订购信息e）返回处理页面图 5-5-1-1 ：即时业务订购流程图接口协议内容承载协议：SOAP接口方向：EPG服务系统 业务管理平台接口功能：用户订购业务请求消息包含以下关键参数表 5-5-2-1：业务订购请求参数名称说明数据长度是否类型（字节）必选SPIDSP的唯一标识string8O.下载可编辑 .UserIDIPTV 用户业务编号string36O业务管理平台为该用户分配的临时身份证UserTokenstring32M明，可采用Cookie 的方式传递ContentID内容 IDstring32MServiceIDIPTV 服务编号string32OProductIDI

28、PTV 产品编号string32M操作类型：Action1：表示订购；String20M2：表示退订。业务管理平台返回的响应消息携带以下参数：表 5-5-2-2 ： SOAP响应消息名称说明数据长度是否类型（字节）必选Result业务订购结果0 ：成功 其他：失败String4MDescription结果描述String256OUserIDIPTV 用户业务编号string36OUserToken业务管理平台为该用户分配的临时身份string32O证明，可采用Cookie 的方式传递ContentID内容 IDstring32MServiceIDIPTV 服务编号string32OProduc

29、tIDIPTV 产品编号string32M.下载可编辑 .SPIDSP的唯一标识string8OTransactionID订购的事务编号string40O订购关系的失效时间，格式为ExpiredTimeYYYYMMDDhhmmss。缺少该参数表示永久有String14O效。预付费用户的费用余额，Balance单位为分。如为后付费用Int4O户，该参数缺失或为空。Fee产品价格，以分为单位Int4M0：包月支付，用户选择订购产品后，按照固定包月费用计费，在当月内无需再次向业务管理平台发起订购请求；1：按次支付，用户选择订购产品后，按照使用次数进行计费无需重新发起订购请求PurchaseTypeI

30、nt4O2：免费3： ppv，用户选择订购产品后，进行一次性计费。再次使用时仍需订购该产品4： SVOD5： PVOD.下载可编辑 .5.7 直播频道列表更新接口接口时序STBEPG 服务系统业务管理平台a)直播频道成功订购流程b)重定向，设置新的频道列表c)频道更新响应图 5-6-1-1 ：直播频道列表更新流程图a) STB通过业务订购接口完成对于直播频道的订购，并通过直播订购接口步骤 7 返回订购成功的响应。b) EPG服务系统将用户重定向至业务管理平台，要求重新设置直播频道列表。c) 业务管理平台通过 CTCSetConfig 设置订购成功的频道列表，并将机顶盒重定向至 EPG服务系统。

31、接口协议内容承载协议：HTTP GET接口方向：EPG服务系统重定向 业务管理平台接口功能：直播频道订购成功后，对直播频道列表进行更新.下载可编辑 .请求消息包含以下关键参数表 5-6-2-1：更新直播频道列表请求参数说明名称说明数据长度是否类型（字节）必选SPIDSP 的唯一标识String8OUserIDIPTV 用户业务编号string36M更新 UserToken后返回的URL，采用ReturnURLURLEncoding 的 ANSI 方式string256M操作类型，此处使用：ActionString20M“ChannelListUpdate ”ChannelIDLis需要更新的频

32、道列表， 采用” | ”分隔的tString256M频道 ID 列表，如 134|123|335业务管理系统重定向返回，通过URL参数携带以下信息表 5-6-2-2：更新直播频道列表返回参数说明名称说明数据长度是否类型（字节）必选SPIDSP 的唯一标识String8OUserIDIPTV 用户业务编号string36MResult更新结果 0 ：成功 其他：失败String4M5.8 产品包信息获取接口.下载可编辑 .接口时序EPG 服务系统业务管理平台a）产品包获取请求b）产品包获取响应图 5-7-1-1 ：产品包信息获取流程图接口协议内容承载协议：SOAP接口方向：EPG服务系统 业务管

33、理平台接口功能：EPG服务系统从业务管理平台获取产品包信息。SOAP接口请求消息 ProInfo不包含任何信息。SOAP接口响应消息 ProInfoResponse ，需要包含以下信息：表 5-7-2-1 ：响应 ProInfoResponse名称数据长度是否说明（字节）必选类型ProductAmount产品数量Int4M见表ProductProduct5-6-2-2Pr产品列表Moduct 说明.下载可编辑 .表 5-7-2-2： Product说明名称说明数据长度是否类型（字节）必选ProductIDIPTV 产品编号String32MServiceAmount服务数量Int4M见表Ser

34、vice5-7-2-3SeService服务列表Mrvice说明表 5-7-2-3： Service说明名称说明数据长度是否类型（字节）必选ServiceIDIPTV 服务编号string32M.下载可编辑 .5.9 增值业务认证鉴权STB增值业务系统业务管理平台a）首次访问b） SSO 获取用户身份c）查询增值业务订购信息d）增值业务访问e）业务订购f）增值业务鉴权g）业务使用图 5-9-1 ：即时业务订购流程图a) 用户首次访问增值业务系统；b) 增值业务系统通过 SSO过程获取用户身份，参见；c) 增值业务系统查询增值业务订购信息，参见；d) 用户进行增值业务访问；e) 如用户未订购业务

35、，则要求用户进行订购，参见 5.5 ；f) 增值业务系统进行业务鉴权，参见 5.4 ；g) 用户使用增值业务。.下载可编辑 .用户身份重定向（ SSO）接口时序STB增值业务系统业务管理平台a）业务请求b）检测到UserTokenc）请求响应d）未检测到UserTokene） HTTP 重定向f）SSO 返回新的 UserToken图 5-9-1-1-1：重定向认证用户身份流程在用户首次访问增值业务系统无法判断用户身份时，使用该SSO重定向过程获取UserToken 以判定用户身份：a) 用户访问增值业务系统 /IPTV 业务系统；b) 增值业务系统检测 UserToken；c) 如增值业务系

36、统检测到合法 UserToken，则返回正常使用响应；d) 增值业务系统无法获取 UserToken，则开始重定向过程；e) 增值业务系统将用户重定向到业务管理平台，携带ReturnURL等参数；.下载可编辑 .f) 业务管理平台检查用户 cookie 获取 UserToken，如果没有检测到，通过重新认证产生 UserToken（参见 5.3 ），并通过重定向参数方式，将 UserToken 等参数返回给增值业务系统。接口协议内容承载协议：SSO接口方向：增值业务系统 业务管理平台在用户首次访问增值业务系统无法判断用户身接口功能：份时，使用该 SSO重定向过程获取UserToken 以判定用户身份。请求消息包含以下参数表 5-9-1-2-1：业务身份重定向请求参数名称数据长度是否说明（字节）必选类型SPIDSP的唯一标识string8MReturnURL返回增值业务系统页面的URLstring256M返回增值业务系统页面需要携带的额外信ReturnInfoString256O息，可用于区分不同的SSO请求操作类型，此处使用：ActionString20MUserTokenRequest用户身份获取后， 业