广东电信IPTV内容管理系统与外部接口说明

1、iptv内容管理系统与epg、vnet、外部cms接口说明1 名词解释n vnet：负责产品或服务管理，对内容进行资费的管理n 内容编排管理系统（content management systemcms）：负责将保存在服务器中数据进行分类整理，为实现节目的导航做准备；同时为了在epg上展现给最终用户提供最终服务, 将需要单独定价的节目或者频道和vnet系统定义的服务绑定n epg系统：负责向最终用户的展现，并实现节目的导航,引导用户完成认证授权,计费等操作n 服务: 在cms系统中, 侧重于节目分类编排, 主要面向频道,栏目或者节目, 在vnet系统中侧重于计费,主要面向产品和资费, 服务是沟

2、通两个系统的桥梁, 是提供给vnet系统可以作为最小单位进行计费的一个实体.vnet系统中可以对这个服务定义多个资费, 变成了多个产品。2 内容管理系统与vnet系统的接口内容管理系统与vnet系统的接口主要是服务创建和产品变更通知的同步接口2.1 服务创建(从vnet把产品服务信息传递到cms中)接口名：registerserviceif接口方式：webservice接受方：cms 发送方：vnet输入参数request：属性名称属性描述属性格式spcodesp编号string 类型, 64位servicecode服务编码string 类型, 64位servicename服务名称string

3、 类型,256位servicedescription服务描述string 类型,256位servicebegintime服务开始时间(yyyymmddhhmmss)intserviceendtime服务结束时间(yyyymmddhhmmss)intstatus状态：1-正常，2-暂停，3-停止intdetailparams扩展信息，用xml形式描述，如“游戏”string 类型, 1024位输出参数registerserviceresponse：属性名称属性描述属性格式detailparams扩展信息，用xml形式描述，如“游戏”string 类型, 1024位returncode消息代码，0

4、成功，1失败intmessage返回消息string 类型,256位3 内容管理系统与外部cms系统的接口在流媒体管理系统中，内容管理系统负责片库管理、频道编排和内容发布，定义了epg的频道组织和内容展现方式，而epg系统负责导航信息的展现。3.1 xml实体说明3.1.1 概述xml实体关系为: 实体说明n cms : 是所有实体的根, 没有具体含义n epg: 表示用户看到stb页面集合, 是频道,节目的集合n channel : 频道, 对应影片的分类编排, 可以嵌套n program : 点播节目n property : 对应点播节目的属性n tv : 网上电视n service :

5、服务, 用于和外部oss(vnet)系统做计费帐务的实体n arrange : 编排实体, 表示频道和program/tv 的对应关系n request : 表示命令请求n response : 表示应答3.1.2 cms 实体n 说明n xml 示例 n 属性说明无3.1.3 epg实体n 说明n xml 示例 n 属性说明属性名称数据类型可选说明id唯一标识string(32)否全局是唯一nameepg名称string(64)否status状态string(10)否在下面中选择: active，inactive action动作string(10)否表示对这个实体的操作,有new, del

6、ete, update3.1.4 channel实体n 说明 定义频道n xml 示例 n 属性说明属性名称数据类型可选说明epgid归属的epg标识string(32)否应用epg实体的标识parentid上层频道标识string(32)否对于一级频道, 为0,对于二级频道,这个字段引用一级频道的标识id频道标识string(32)否唯一标识name频道名称string(64)否status状态string(10).否在下面中选择: active，inactive order显示顺序integer否从1开始, 值越小越在前面显示comment描述信息string(256)是logo对应的lo

7、go 标识string(1024)是对应logo的图片urlaction对实体的操作类型string(10)否表示对这个实体的操作,有new, delete（删除本身节点）, update3.1.5 program/property实体n 说明用于描述点播类的实体, 包括影视, 连续剧。 program实体表示了基本的属性, 对于一些可选的属性, 统一使用property element 来表示。n xml 示例abperter520n 属性说明属性名称数据类型可选说明contentid节目标识string(32)否全局唯一的, 对于连续剧,单集的contentid是相同的name节目名称st

8、ring(128)否search_name快速查询名称string(64)否starttime开始日期string(14)否“yyyymmddhh24miss”endtime结束日期string(14)否“yyyymmddhh24miss”spidsp标识string(64)否cpidcp标识string(64)是url播放文件urlstring(1024)否servicecode服务标识string(64)否授权时使用type分类string(64)是分类信息描述: 动作片,爱情片, 。push是否推送cdnint是0不推送； 1推送episodeindex剧集第几集int是连续剧才又有效e

9、pisodenum总的剧集数目int是连续剧才又有效actor男演员string(1024)是多个使用;分隔actress女演员string(1024)是多个使用;分隔director导演string(1024)是多个使用;分隔producer出品人string(1024)是多个使用;分隔poster海报string(1024)是图片url, 多个使用;分隔summary剧情string(1024)是country地区string(64)是language对白语言string(64)是caption字幕语言string(64)是awards奖项string(1024)是多个使用;分隔ratin

10、g级别分类string(10)是r00,r12,r15,r18,r20length播放时长int是分preview预览urlstring(1024)是一个urlstar星级int是1-5分screenformat屏幕类型string(64)是16:9 4:3audiotype声音类型string(64)是bitrate码流int是kbpsscreen_rate分辩率string(64)是encoder编码方式string(64)是status状态string(10)否在下面中选择: active，inactive action 对实体的操作类型string(10)否表示对这个实体的操作,有ne

11、w, delete, update3.1.6 tv/tvschedule实体 n 说明n xml 示例 n 属性说明属性名称数据类型可选说明channelseq频道号string(32)否和channel实体标识没有关系channelname频道名称string(64)否spidsp标识string(64)否starttime每天开始时间string(6)否格式为: “hh24miss”endtime每天结束时间string(6)否格式为: “hh24miss”servicecode服务标识string(64)否授权时使用bitrate码流int是kbpsrating级别分类string(64

12、)是限制级, 。poster海报string(1024)是图片url, 多个使用;分隔language对白语言string(64)是country地区string(64)是encoder编码方式string(64)是logo对应的logo urlstring(1024)是对应logo的图片urlcomment描述信息string(1024)是ip组播ipstring(32)否port组播端口int否contentid节目标识string(32)否全局唯一的,和点播类节目不重复contentname节目名称string(64)否节目的名称summary剧情string(1024)是rating级

13、别分类string(10)是r00,r12,r15,r18,r20duration播放时长int是以秒为单位start_date开始播放日期string(8)否格式为: yyyymmddstart_time播放时间string(6)否格式为: hh24misschannelurl频道地址string(64)是更加厂家对直播实现机制定义，可选status状态string(10)否在下面中选择: active，inactive action 对实体的操作类型string(10)否表示对这个实体的操作,有new, delete, update3.1.7 arranget实体 n 说明用于描述频道和节

14、目的编排关系, 一个节目可以被编排到多个频道中。element的值,定义了节目的标识。n xml 示例 n 属性说明属性名称数据类型可选说明id唯一标识string(1024)否channelid对应的频道标识string(32)否对channel实体的引用channelseq频道标识string(32)是定义channel实体里的频道contentid节目标识string(32)是定义channel实体里的节目action 对实体的操作类型string(10)否表示对这个实体的操作,有new(增加), delete, 3.1.8 service实体 n 说明在cms系统中, 侧重于节目分类编

15、排, 主要面向频道,栏目或者节目, 在vnet系统中侧重于计费,主要面向产品和资费, 服务是沟通两个系统的桥梁, 是提供给vnet系统可以作为最小单位进行计费的一个实体.vnet系统中可以对这个服务定义多个资费, 变成了多个产品。element的值,定义了频道的标识。n xml 示例 n 属性说明属性名称数据类型可选说明id唯一标识string(64)否name服务的名称string(1024)否对资费的描述channelseq频道标识string(32)是定义channel实体里的频道contentid节目标识string(32)是定义channel实体里的节目action 对实体的操作类型

16、string(64)否表示对这个实体的操作,有new, delete,update3.1.9 request实体 n 说明命令实体, n xml 示例 n 属性说明属性名称数据类型可选说明issuedatetime命令发布时间string(14)否格式为: yyyymmddhh24misssequence命令序列号string(64)否（完整的文件名）3.1.10 response实体 n 说明描述应答实体。n xml 示例 未知错误 n 属性说明属性名称数据类型可选说明sequence命令序列号string(64)否（完整的文件名）cmscode子cms标识string(2)否全局唯一sta

17、rttime命令发布时间string(14)否格式为: yyyymmddhh24missendtime命令执行时间string(14)否格式为: yyyymmddhh24missresultcode执行返回值int否0：成功1：接口解析失败，包括文件不完整，xml格式不正确，通过errormsg进行具体描述2：实体信息不一致，包括epg/channel/program/tv实体等信息与子cms内部信息不一致， 如删除一个在子cms不存在的channel，或者增加一个在子cms已存在的progrma3：子cms系统内部错误，一般该错误由子系统自身错误引起，如数据库连接不成功。该错误属于可恢复的错

18、误。99：其它错误errormsg错误描述string(1024)是错误的具体描述n3.2 文件接口通讯方式3.2.1 系统通讯模式考虑到系统中传输的数据量比较大, 通过实时接口发送数据的时候, 可能因为数据量的问题, 造成通讯错误, 或者不能实时处理的问题, 在中心cms和子cms系统中间, 主要通过文件方式进行耦合。 在中心cms系统内部因为有新的节目上线, 编排发生变化或者其他原因, 要求和子cms系统做数据同步的时候, 中心cms系统生成命令文件, 这个文件中包含命令和对应的实体信息。子cms系统会定时(或被通知)去获取命令文件, 执行命令, 生成应答文件, 同样中心cms系统通过解析

19、子cms系统返回的应答文件, 就可以知道子cms系统对命令执行情况。在支持文件方式的同时, 也提供实时的接口。主要使用下面两种模式:n 纯文件模式处理流程 1) 中心cms生成命令文件2) 子cms系统定向查询ftpserver, 根据最后处理的文件序列号, 获取到命令文件;在子cms系统内部处理命令文件;3) 子cms系统对命令文件执行完毕后,根据对命令文件的执行情况, 生成应答文件，为了避免命令文件处理中出现“跳跃”的情况，规定上一个命令文件执行结束之前，不启动后续命令文件的执行;当前一个命令文件处理失败，后续命令可以继续执行，当所有命令文件执行完毕以后，子cms向中心cms上报命令执行情

20、况。4) 中心cms定时查询应答文件, 更新命令执行情况列表;5) 如果中心cms发现子cms命令执行出现错误，则重传命令文件触发子cms再次执行6) 如出现子cms三次执行都不成功，则中心cms触发相应告警机制。n 文件扩展模式处理流程 1) 中心cms生成命令文件2) 中心cms系统通知子cms系统, 要求子cms到ftp上获取命令文件.3) 子cms根据根据最后处理的文件序列号, 获取到命令文件;在子cms系统内部处理执行命令文件，为了避免命令文件处理中出现“跳跃”的情况，规定上一个命令文件执行结束之前，不启动后续命令文件的执行;当前一个命令文件处理失败，后续命令可以继续执行，当所有命令

21、文件执行完毕以后，子cms向中心cms上报命令执行情况。4) 中心cms定时查询应答文件, 更新命令执行情况列表;5) 如果中心cms发现子cms命令执行出现错误，则重传命令文件触发子cms再次执行6) 如出现子cms三次执行都不成功，则中心cms触发相应告警机制。两种模式的基本处理流程是类似的, 在文件扩展模式下, 对系统的时效性更好。 3.2.2 命令或者应答文件规范命令或者应答都会作为文件保存在ftp空间上, cms系统获取和做解析。文件名称规范:命令文件: request_yyyymmdd_seq.xml应答文件: response_yyyymmdd_seq_cmscode.xml说明: 1) 根据request/response这两个文件名前缀, 可以区分命令文件和应答文件;2) yyyymmdd 为