廣東電信IPTV內(nèi)容管理系統(tǒng)與外部接口說明

1、iptv內(nèi)容管理系統(tǒng)接口規(guī)范iptv內(nèi)容管理系統(tǒng)與epg、vnet、外部cms接口說明1 名詞解釋n vnet：負(fù)責(zé)產(chǎn)品或服務(wù)管理，對內(nèi)容進(jìn)行資費(fèi)的管理n 內(nèi)容編排管理系統(tǒng)（content management systemcms）：負(fù)責(zé)將保存在服務(wù)器中數(shù)據(jù)進(jìn)行分類整理，為實(shí)現(xiàn)節(jié)目的導(dǎo)航做準(zhǔn)備；同時為了在epg上展現(xiàn)給最終用戶提供最終服務(wù), 將需要單獨(dú)定價的節(jié)目或者頻道和vnet系統(tǒng)定義的服務(wù)綁定n epg系統(tǒng)：負(fù)責(zé)向最終用戶的展現(xiàn)，并實(shí)現(xiàn)節(jié)目的導(dǎo)航,引導(dǎo)用戶完成認(rèn)證授權(quán),計(jì)費(fèi)等操作n 服務(wù): 在cms系統(tǒng)中, 側(cè)重于節(jié)目分類編排, 主要面向頻道,欄目或者節(jié)目, 在vnet系統(tǒng)中側(cè)重于計(jì)費(fèi),主

2、要面向產(chǎn)品和資費(fèi), 服務(wù)是溝通兩個系統(tǒng)的橋梁, 是提供給vnet系統(tǒng)可以作為最小單位進(jìn)行計(jì)費(fèi)的一個實(shí)體.vnet系統(tǒng)中可以對這個服務(wù)定義多個資費(fèi), 變成了多個產(chǎn)品。2 內(nèi)容管理系統(tǒng)與vnet系統(tǒng)的接口內(nèi)容管理系統(tǒng)與vnet系統(tǒng)的接口主要是服務(wù)創(chuàng)建和產(chǎn)品變更通知的同步接口2.1 服務(wù)創(chuàng)建(從vnet把產(chǎn)品服務(wù)信息傳遞到cms中)接口名：registerserviceif接口方式：webservice接受方：cms 發(fā)送方：vnet輸入?yún)?shù)request：屬性名稱屬性描述屬性格式spcodesp編號string 類型, 64位servicecode服務(wù)編碼string 類型, 64位service

3、name服務(wù)名稱string 類型,256位servicedescription服務(wù)描述string 類型,256位servicebegintime服務(wù)開始時間(yyyymmddhhmmss)intserviceendtime服務(wù)結(jié)束時間(yyyymmddhhmmss)intstatus狀態(tài)：1-正常，2-暫停，3-停止intdetailparams擴(kuò)展信息，用xml形式描述，如“游戲”string 類型, 1024位輸出參數(shù)registerserviceresponse：屬性名稱屬性描述屬性格式detailparams擴(kuò)展信息，用xml形式描述，如“游戲”string 類型, 1024位re

4、turncode消息代碼，0成功，1失敗intmessage返回消息string 類型,256位3 內(nèi)容管理系統(tǒng)與外部cms系統(tǒng)的接口在流媒體管理系統(tǒng)中，內(nèi)容管理系統(tǒng)負(fù)責(zé)片庫管理、頻道編排和內(nèi)容發(fā)布，定義了epg的頻道組織和內(nèi)容展現(xiàn)方式，而epg系統(tǒng)負(fù)責(zé)導(dǎo)航信息的展現(xiàn)。3.1 xml實(shí)體說明3.1.1 概述xml實(shí)體關(guān)系為: 實(shí)體說明n cms : 是所有實(shí)體的根, 沒有具體含義n epg: 表示用戶看到stb頁面集合, 是頻道,節(jié)目的集合n channel : 頻道, 對應(yīng)影片的分類編排, 可以嵌套n program : 點(diǎn)播節(jié)目n property : 對應(yīng)點(diǎn)播節(jié)目的屬性n tv : 網(wǎng)上

5、電視n service : 服務(wù), 用于和外部oss(vnet)系統(tǒng)做計(jì)費(fèi)帳務(wù)的實(shí)體n arrange : 編排實(shí)體, 表示頻道和program/tv 的對應(yīng)關(guān)系n request : 表示命令請求n response : 表示應(yīng)答3.1.2 cms 實(shí)體n 說明n xml 示例 n 屬性說明無3.1.3 epg實(shí)體n 說明n xml 示例 n 屬性說明屬性名稱數(shù)據(jù)類型可選說明id唯一標(biāo)識string(32)否全局是唯一nameepg名稱string(64)否status狀態(tài)string(10)否在下面中選擇: active，inactive action動作string(10)否表示對這個實(shí)

6、體的操作,有new, delete, update3.1.4 channel實(shí)體n 說明 定義頻道n xml 示例 n 屬性說明屬性名稱數(shù)據(jù)類型可選說明epgid歸屬的epg標(biāo)識string(32)否應(yīng)用epg實(shí)體的標(biāo)識parentid上層頻道標(biāo)識string(32)否對于一級頻道, 為0,對于二級頻道,這個字段引用一級頻道的標(biāo)識id頻道標(biāo)識string(32)否唯一標(biāo)識name頻道名稱string(64)否status狀態(tài)string(10)否在下面中選擇: active，inactive order顯示順序integer否從1開始, 值越小越在前面顯示comment描述信息string(2

7、56)是logo對應(yīng)的logo 標(biāo)識string(1024)是對應(yīng)logo的圖片urlaction對實(shí)體的操作類型string(10)否表示對這個實(shí)體的操作,有new, delete（刪除本身節(jié)點(diǎn)）, update3.1.5 program/property實(shí)體n 說明用于描述點(diǎn)播類的實(shí)體, 包括影視, 連續(xù)劇。 program實(shí)體表示了基本的屬性, 對于一些可選的屬性, 統(tǒng)一使用property element 來表示。n xml 示例cms xmlns:xsi=/2001/xmlschema-instance xsi:nonamespaceschemaloc

8、ation=abperter520n 屬性說明屬性名稱數(shù)據(jù)類型可選說明contentid節(jié)目標(biāo)識string(32)否全局唯一的, 對于連續(xù)劇,單集的contentid是相同的name節(jié)目名稱string(128)否search_name快速查詢名稱string(64)否starttime開始日期string(14)否“yyyymmddhh24miss”endtime結(jié)束日期string(14)否“yyyymmddhh24miss”spidsp標(biāo)識string(64)否cpidcp標(biāo)識string(64)是url播放文件urlstring(1024)否servicecode服務(wù)標(biāo)識string

9、(64)否授權(quán)時使用type分類string(64)是分類信息描述: 動作片,愛情片, 。push是否推送cdnint是0不推送； 1推送episodeindex劇集第幾集int是連續(xù)劇才又有效episodenum總的劇集數(shù)目int是連續(xù)劇才又有效actor男演員string(1024)是多個使用;分隔actress女演員string(1024)是多個使用;分隔director導(dǎo)演string(1024)是多個使用;分隔producer出品人string(1024)是多個使用;分隔poster海報(bào)string(1024)是圖片url, 多個使用;分隔summary劇情string(1024)是

10、country地區(qū)string(64)是language對白語言string(64)是caption字幕語言string(64)是awards獎項(xiàng)string(1024)是多個使用;分隔rating級別分類string(10)是r00,r12,r15,r18,r20length播放時長int是分preview預(yù)覽urlstring(1024)是一個urlstar星級int是1-5分screenformat屏幕類型string(64)是16:9 4:3audiotype聲音類型string(64)是bitrate碼流int是kbpsscreen_rate分辯率string(64)是encoder

11、編碼方式string(64)是status狀態(tài)string(10)否在下面中選擇: active，inactive action 對實(shí)體的操作類型string(10)否表示對這個實(shí)體的操作,有new, delete, update3.1.6 tv/tvschedule實(shí)體 n 說明n xml 示例 n 屬性說明屬性名稱數(shù)據(jù)類型可選說明channelseq頻道號string(32)否和channel實(shí)體標(biāo)識沒有關(guān)系channelname頻道名稱string(64)否spidsp標(biāo)識string(64)否starttime每天開始時間string(6)否格式為: “hh24miss”endtime

12、每天結(jié)束時間string(6)否格式為: “hh24miss”servicecode服務(wù)標(biāo)識string(64)否授權(quán)時使用bitrate碼流int是kbpsrating級別分類string(64)是限制級, 。poster海報(bào)string(1024)是圖片url, 多個使用;分隔language對白語言string(64)是country地區(qū)string(64)是encoder編碼方式string(64)是logo對應(yīng)的logo urlstring(1024)是對應(yīng)logo的圖片urlcomment描述信息string(1024)是ip組播ipstring(32)否port組播端口int否c

13、ontentid節(jié)目標(biāo)識string(32)否全局唯一的,和點(diǎn)播類節(jié)目不重復(fù)contentname節(jié)目名稱string(64)否節(jié)目的名稱summary劇情string(1024)是rating級別分類string(10)是r00,r12,r15,r18,r20duration播放時長int是以秒為單位start_date開始播放日期string(8)否格式為: yyyymmddstart_time播放時間string(6)否格式為: hh24misschannelurl頻道地址string(64)是更加廠家對直播實(shí)現(xiàn)機(jī)制定義，可選status狀態(tài)string(10)否在下面中選擇: acti

14、ve，inactive action 對實(shí)體的操作類型string(10)否表示對這個實(shí)體的操作,有new, delete, update3.1.7 arranget實(shí)體 n 說明用于描述頻道和節(jié)目的編排關(guān)系, 一個節(jié)目可以被編排到多個頻道中。element的值,定義了節(jié)目的標(biāo)識。n xml 示例cms xmlns:xsi=/2001/xmlschema-instance xsi:nonamespaceschemalocation= n 屬性說明屬性名稱數(shù)據(jù)類型可選說明id唯一標(biāo)識string(1024)否channelid對應(yīng)的頻道標(biāo)識string(32)否對

15、channel實(shí)體的引用channelseq頻道標(biāo)識string(32)是定義channel實(shí)體里的頻道contentid節(jié)目標(biāo)識string(32)是定義channel實(shí)體里的節(jié)目action 對實(shí)體的操作類型string(10)否表示對這個實(shí)體的操作,有new(增加), delete, 3.1.8 service實(shí)體 n 說明在cms系統(tǒng)中, 側(cè)重于節(jié)目分類編排, 主要面向頻道,欄目或者節(jié)目, 在vnet系統(tǒng)中側(cè)重于計(jì)費(fèi),主要面向產(chǎn)品和資費(fèi), 服務(wù)是溝通兩個系統(tǒng)的橋梁, 是提供給vnet系統(tǒng)可以作為最小單位進(jìn)行計(jì)費(fèi)的一個實(shí)體.vnet系統(tǒng)中可以對這個服務(wù)定義多個資費(fèi), 變成了多個產(chǎn)品。el

16、ement的值,定義了頻道的標(biāo)識。n xml 示例cms xmlns:xsi=/2001/xmlschema-instance xsi:nonamespaceschemalocation= n 屬性說明屬性名稱數(shù)據(jù)類型可選說明id唯一標(biāo)識string(64)否name服務(wù)的名稱string(1024)否對資費(fèi)的描述channelseq頻道標(biāo)識string(32)是定義channel實(shí)體里的頻道contentid節(jié)目標(biāo)識string(32)是定義channel實(shí)體里的節(jié)目action 對實(shí)體的操作類型string(64)否表示對這個實(shí)體的操作,有new, dele

17、te,update3.1.9 request實(shí)體 n 說明命令實(shí)體, n xml 示例cms xmlns:xsi=/2001/xmlschema-instance xsi:nonamespaceschemalocation= n 屬性說明屬性名稱數(shù)據(jù)類型可選說明issuedatetime命令發(fā)布時間string(14)否格式為: yyyymmddhh24misssequence命令序列號string(64)否（完整的文件名）3.1.10 response實(shí)體 n 說明描述應(yīng)答實(shí)體。n xml 示例cms xmlns:xsi=/20

18、01/xmlschema-instance xsi:nonamespaceschemalocation= 未知錯誤 n 屬性說明屬性名稱數(shù)據(jù)類型可選說明sequence命令序列號string(64)否（完整的文件名）cmscode子cms標(biāo)識string(2)否全局唯一starttime命令發(fā)布時間string(14)否格式為: yyyymmddhh24missendtime命令執(zhí)行時間string(14)否格式為: yyyymmddhh24missresultcode執(zhí)行返回值int否0：成功1：接口解析失敗，包括文件不完整，xml格式不正確，通過errormsg進(jìn)行具體描述2：實(shí)體信息不一

19、致，包括epg/channel/program/tv實(shí)體等信息與子cms內(nèi)部信息不一致， 如刪除一個在子cms不存在的channel，或者增加一個在子cms已存在的progrma3：子cms系統(tǒng)內(nèi)部錯誤，一般該錯誤由子系統(tǒng)自身錯誤引起，如數(shù)據(jù)庫連接不成功。該錯誤屬于可恢復(fù)的錯誤。99：其它錯誤errormsg錯誤描述string(1024)是錯誤的具體描述n3.2 文件接口通訊方式3.2.1 系統(tǒng)通訊模式考慮到系統(tǒng)中傳輸?shù)臄?shù)據(jù)量比較大, 通過實(shí)時接口發(fā)送數(shù)據(jù)的時候, 可能因?yàn)閿?shù)據(jù)量的問題, 造成通訊錯誤, 或者不能實(shí)時處理的問題, 在中心cms和子cms系統(tǒng)中間, 主要通過文件方式進(jìn)行耦合。

20、在中心cms系統(tǒng)內(nèi)部因?yàn)橛行碌墓?jié)目上線, 編排發(fā)生變化或者其他原因, 要求和子cms系統(tǒng)做數(shù)據(jù)同步的時候, 中心cms系統(tǒng)生成命令文件, 這個文件中包含命令和對應(yīng)的實(shí)體信息。子cms系統(tǒng)會定時(或被通知)去獲取命令文件, 執(zhí)行命令, 生成應(yīng)答文件, 同樣中心cms系統(tǒng)通過解析子cms系統(tǒng)返回的應(yīng)答文件, 就可以知道子cms系統(tǒng)對命令執(zhí)行情況。在支持文件方式的同時, 也提供實(shí)時的接口。主要使用下面兩種模式:n 純文件模式處理流程 1) 中心cms生成命令文件2) 子cms系統(tǒng)定向查詢ftpserver, 根據(jù)最后處理的文件序列號, 獲取到命令文件;在子cms系統(tǒng)內(nèi)部處理命令文件;3) 子cms系

21、統(tǒng)對命令文件執(zhí)行完畢后,根據(jù)對命令文件的執(zhí)行情況, 生成應(yīng)答文件，為了避免命令文件處理中出現(xiàn)“跳躍”的情況，規(guī)定上一個命令文件執(zhí)行結(jié)束之前，不啟動后續(xù)命令文件的執(zhí)行;當(dāng)前一個命令文件處理失敗，后續(xù)命令可以繼續(xù)執(zhí)行，當(dāng)所有命令文件執(zhí)行完畢以后，子cms向中心cms上報(bào)命令執(zhí)行情況。4) 中心cms定時查詢應(yīng)答文件, 更新命令執(zhí)行情況列表;5) 如果中心cms發(fā)現(xiàn)子cms命令執(zhí)行出現(xiàn)錯誤，則重傳命令文件觸發(fā)子cms再次執(zhí)行6) 如出現(xiàn)子cms三次執(zhí)行都不成功，則中心cms觸發(fā)相應(yīng)告警機(jī)制。n 文件擴(kuò)展模式處理流程 1) 中心cms生成命令文件2) 中心cms系統(tǒng)通知子cms系統(tǒng), 要求子cms到f

22、tp上獲取命令文件.3) 子cms根據(jù)根據(jù)最后處理的文件序列號, 獲取到命令文件;在子cms系統(tǒng)內(nèi)部處理執(zhí)行命令文件，為了避免命令文件處理中出現(xiàn)“跳躍”的情況，規(guī)定上一個命令文件執(zhí)行結(jié)束之前，不啟動后續(xù)命令文件的執(zhí)行;當(dāng)前一個命令文件處理失敗，后續(xù)命令可以繼續(xù)執(zhí)行，當(dāng)所有命令文件執(zhí)行完畢以后，子cms向中心cms上報(bào)命令執(zhí)行情況。4) 中心cms定時查詢應(yīng)答文件, 更新命令執(zhí)行情況列表;5) 如果中心cms發(fā)現(xiàn)子cms命令執(zhí)行出現(xiàn)錯誤，則重傳命令文件觸發(fā)子cms再次執(zhí)行6) 如出現(xiàn)子cms三次執(zhí)行都不成功，則中心cms觸發(fā)相應(yīng)告警機(jī)制。兩種模式的基本處理流程是類似的, 在文件擴(kuò)展模式下, 對系統(tǒng)的時效性更好。 3.2.2 命令或者應(yīng)答文件規(guī)范命令或者應(yīng)答都會作為文件保存在ftp空間上, cms系統(tǒng)獲取和做解析。文件名稱規(guī)范:命令文件: request_yyyymmdd_seq.xml應(yīng)答文件: response_yyyymmdd_seq_cmscode.xml說明: 1) 根據(jù)request/response這兩個文件