电视上网媒体信息接口说明.doc

电视上网平台媒体信息接口说明电视上网平台媒体信息接口V0.12007年3月目录1、 接口描述32、 获取区域信息43、 获取频道信息接口53.1 基本数据53.2 获取频道个数53.3 获取频道信息64、 影片信息84.1 基本数据84.1.1 媒体基本信息84.1.2 媒体详细信息84.1.3 剧集基本信息104.1.4 剧集详细信息114.2 获取影片信息124.2.1 获取影片数量124.2.2 分页获取影片信息134.2.3 查询影片信息144.2.4 获取影片详细信息144.3 获取剧集信息154.3.1 获取剧集数量154.3.2 分页获取文件信息164.3.3 获取文件详细信息174.4 播放接口171、 概述本文档对电视上网平台的媒体信息接口进行了描述，各个EPG可以通过该接口获得媒体信息数据，同时第三方同电视上网系统需要对接的平台也建议采用此接口。2、 接口描述接口采用SOAP协议3、 获取区域信息4、 获取频道信息接口 强终端，弱终端 得到所有频道信息，频道包括基本频道和专题频道，如果是专题频道4.1 基本数据频道信息元数据字段名称名称类型长度（字节）是否必选ChannelType频道类型 1 基本频道 2 专题频道 3 其他频道Int4必选ChannelId频道标识Int4必选ChannelCode频道编码String32可选ChannelName频道名称string32必选ChannelDescription频道描述string256可选ParentChannelId父频道代码string20可选SubChannels子频道信息ChannelInfo4.2 获取频道个数GetChannelCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域int4MTMType终端类型,1 强终端2 弱终端 Int4MChannelType频道类型 0 所有频道 1 基本频道 2 专题频道 3 其他频道Int4MParentChannel上级频道，0 根频道 -1所有频道 其他值返回该频道下的子频道Int4MGetChannelCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 int4MCodeDescription 返回值描述值string64O ChannelCount 频道数量Int4M4.3 获取频道信息GetChannelList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 Int4MChannelType频道类型 0 所有频道 1 基本频道 2 专题频道 3 其他频道Int4MParentChannel上级频道，0 根频道 -1所有频道 其他值返回该频道下的子频道Int4MPageIndex页号，从1开始Int4MPageSize每页大小,如果为-1 那么返回所有的Int4MGetChannelListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值Int 4OCodeDescription返回值描述string64MChannels频道信息ChannelInfo5、 影片信息5.1 基本数据5.1.1 媒体基本信息MediaInfo影片基本信息字段名称名称类型长度（字节）是否必选SPCodeSP编码String 32必选SPNameSP名称string64必选ChannelCode频道编码String32必选ChannelName频道名称String64必选MediaId媒体标识Int4必选MediaName媒体名称string64必选EpisodeNum集数，仅对连续剧有效Int4必选Summary内容简介String256可选Description内容介绍string1024可选Star星级int1可选Poster海报图片的URLstring256可选Encoder编码方式int4可选Bitrate比特率int8可选Caption字幕语言string256可选ClickCount点击次数Int 4可选LastVisitTime最近一次访问时间String14可选5.1.2 媒体详细信息MediaDetailInfo影片内容详细信息字段名称名称类型长度（字节）是否必选SPCodeSP编码String32必选SPNameSP名称string64必选ChannelCode频道编码String32必选ChannelName频道名称string32可选MediaId媒体标识Int4必选MediaName媒体名称string64必选Summary内容简介String256可选Description内容介绍string1024可选Star星级int1可选Poster海报图片的URLstring256可选Encoder编码方式String32可选Bitrate比特率int8可选EpisodeNum集数，仅对连续剧有效Int4可选Caption字幕语言string256可选Country内容所属国家string32可选Area内容所属地区string32可选LanguageName语言名称String32可选AudioType音频类型string32可选Length长度int8必选Director导演string64可选Actor演员string256可选EnglishName英文名string256可选Producer出品方string256可选PlayWriter作者string64可选ProductCompany制作公司string64可选PublishCompany发行公司string64可选Rating级别分类int4可选Awards奖项string256可选ProductTime发行时间string14可选ScreenFormat屏幕类型string16可选SearchKey搜索关键字string32可选ScreenRate分辩率string64可选PublishTime发布时间20061012120030String 14可选ClickCount点击次数Int 4可选LastVisitTime最近一次访问时间String14可选5.1.3 剧集基本信息EpisodeInfo剧集基本信息字段名称名称类型长度（字节）是否必选MediaId媒体标识string32必选MediaName媒体名称string64必选EpisodeId剧集标识Int4必选EpisodeIndex集号，仅对连续剧有效Int4必选EpisodeName剧集名称String64 可选Summary内容简介String256可选Description内容介绍string1024可选Poster海报图片的URLstring256可选ClickCount点击次数Int 4可选LastVisitTime最近一次访问时间String14可选5.1.4 剧集详细信息EpisodeDetailInfo剧集内容详细信息字段名称名称类型长度（字节）是否必选MediaId媒体标识Int4必选MediaName媒体名称string64必选EpisodeId集标识Int8必选EpisodeIndex集号Int8必选EpisodeName集名称String 64必选Country内容所属国家string32可选Area内容所属地区string32可选Summary内容简介String256可选Description内容介绍string1024可选LanguageName语言名称String32可选AudioType音频类型String32可选Star星级int1可选Poster海报图片的URLstring256可选Encoder编码方式String32可选Bitrate比特率Int8可选Length长度Int8必选Director导演String64可选Actor演员String256可选EnglishName英文名String256可选Producer出品方String256可选PlayWriter作者string64可选ProductCompany制作公司string64可选PublishCompany发行公司string64可选Rating级别分类int4可选Caption字幕语言string256可选Awards奖项string256可选ProductTime发行时间string14可选ScreenFormat屏幕类型string16可选SearchKey搜索关键字string32可选ScreenRate分辩率string64可选ClickCount点击次数Int 4可选LastVisitTime最近一次访问时间String14可选5.1.5 评论详细信息CommentDetailInfo名称说明数据类型长度（字节）是否必选MediaId影片标识 Int4MMediaName影片名String64MEpisodeIndex剧集序号Int4OEpisodeId 剧集标识String64OEpisodeName剧集名string64OCommentTitle标题String256OCommentDetail详细信息string1024OCommentUser发表评论人String64OCommentTime发表评论时间string14O5.1.6 服务详细信息ServiceDetailInfo名称说明数据类型长度（字节）是否必选MediaId影片标识 Int4MMediaName影片名String64MEpisodeIndex剧集序号Int4OEpisodeId 剧集标识String64OEpisodeName剧集名string64OServiceId服务标识String32MServiceCode服务编号String64MServiceName服务名称String64MServiceDesc服务描述string1024OServiceFee服务费用String64M5.2 获取影片信息5.2.1 获取影片数量GetMediaCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 Int4M ChannelCode频道编码String32MConditions查询条件，SQL语法，具体字段名称参见MediaDetailInfo所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OGetMediaCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O MediaCount 数量Int4M5.2.2 分页获取影片信息GetMediaList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 int4M ChannelCode频道编码String32O PageIndex页号Int4MPageSize页大小int4MConditions查询条件，类SQL语法，具体字段名称参见MediaDetailInfo所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OOrderInfo排序信息String 256OGetMediaListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 int4OCodeDescription 返回值描述值string64M MediaInfos MediaInfo5.2.3 获取影片详细信息GetMediaDetailInfo名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MMediaId返回值 string36MGetMediaDetailInfoResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 int4MCodeDescription 返回值描述值string64O DetailInfo 媒体信息MediaDetailInfo5.3 查询影片5.3.1 获取数量GetSearchMediaCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 int4M ChannelCode频道编码String32OSearchMode1按节目名称拼音首字母搜索，2按节目名称字数搜索，3按节目名称首字笔画数搜索4按导演拼音首字母搜索，5按导演字数搜索，6按导演首字笔画数搜索7按主演拼音首字母搜索，8按主演字数搜索，9按主演首字笔画数搜索Int4MSearchValue查询值String256MConditions查询条件，类SQL语法，具体字段名称参见MediaDetailInfo所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OGetSearchMediaCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O MediaCount 数量Int 4M5.3.2 分页查询除了上面分页获取影片信息外，还可以通过特点算法查询影片GetSearchMediaList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 int4M ChannelCode频道编码String32O PageIndex页号Int4MPageSize页大小int4MSearchMode1按节目名称拼音首字母搜索，2按节目名称字数搜索，3按节目名称首字笔画数搜索4按导演拼音首字母搜索，5按导演字数搜索，6按导演首字笔画数搜索7按主演拼音首字母搜索，8按主演字数搜索，9按主演首字笔画数搜索Int4MSearchValue查询值String256MConditions查询条件，类SQL语法，具体字段名称参见MediaDetailInfo所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OOrderInfo排序信息String 256OGetSearchMediaListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 int4OCodeDescription 返回值描述值string64M MediaInfos MediaInfo5.4 获取推荐影片信息5.4.1 获取推荐影片数量GetRecommendMediaCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 Int4MChannelCode频道编码String32MConditions查询条件，SQL语法，具体字段名称参见MediaDetailInfo和RecommendSequence 序号所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OGetRecommendMediaCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O MediaCount 数量Int4M5.4.2 分页获取推荐影片信息GetRecommendMediaList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MTMType终端类型1 强终端2 弱终端 int4MChannelCode频道编码String 32M PageIndex页号Int4MPageSize页大小int4MConditions查询条件，类SQL语法，具体字段名称参见MediaDetailInfo所有字段用#字段名#例如 #MediaName# =测试影片 AND #Star#=5 String256OOrderInfo排序信息String 256OGetRecommendMediaListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O MediaInfos MediaInfoO5.5 获取剧集信息5.5.1 获取剧集数量GetEpisodeCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int 4M MediaId媒体标识Int4MConditions查询条件，SQL语法，具体字段名称参见MediaEpisodeDetailInfo所有字段用#字段名#例如 #EpisodeName# =测试影片 AND #EpisodeIndex#=5 String256OGetEpisodeCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64OEpisodeCount 数量Int4M5.5.2 分页获取剧集信息GetEpisodeList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4M MediaId影片标识Int4M PageIndex页号Int4OPageSize页大小Int4OConditions查询条件，类SQL语法，具体字段名称参见EpisodeDetailInfo所有字段用#字段名#例如 #EpisodeName# =测试影片 AND #EpisodeIndex#=5 String256OOrderInfo排序信息，类SQL语法具体字段名称参见EpisodeDetailInfo所有字段用#字段名#,例如 #EpisodeIndex# ASC,#PublishTime# DESCString 256OGetEpisodeListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O EpisodeInfos 影片剧集信息EpisodeInfoO5.5.3 获取剧集详细信息GetEpisodeDetailInfo名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4MMediaId媒体标识Int4MEpisodeId集标识Int4OGetEpisodeDetailInfoResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O DetailInfo 媒体信息EpisodeDetailInfo5.6 获取评论信息5.6.1 获取评论数量GetCommentCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int 4M MediaId媒体标识Int4MEpisodeId剧集标识Int4MConditions查询条件，SQL语法，具体字段名称参见CommentDetailInfo所有字段用#字段名#String256OGetCommentCountResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64OCommentCount 数量Int4M5.6.2 分页获取评论信息GetCommentList名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int4M MediaId影片标识Int4MEpisodeId剧集标识，0 表示该评论针对本影片，对连续剧，可以对单剧集进行评论Int4O PageIndex页号Int4OPageSize页大小Int4OConditions查询条件，类SQL语法，具体字段名称参见CommentDetailInfo所有字段用#字段名#String256OOrderInfo排序信息，类SQL语法具体字段名称参见CommentDetailInfoString 256OGetCommentListResult名称说明数据类型长度（字节）是否必选ReturnCode返回值 Int4MCodeDescription 返回值描述值string64O Comments 评论信息CommentDetailInfoO5.7 获取收费服务信息5.7.1 获取服务数量GetServiceCount名称说明数据类型长度（字节）是否必选Region区域0 代表平台内容 -1 代表所有区域Int 4M MediaId媒体标识Int4MEpisodeId剧集Int4 OConditi