X直播新版API文档

X直播 App API 接口

接口修改说明

日期 修改人
2015/11/30 王小柱

目录

[TOC]

接口文档概要说明

  • 文档是《X直播平台接口通讯协议》的补充版本， 旨在快速定义相关接口
  • 系统接口使用http作为承载协议，使用HTTP GET 请求；传递参数为URL UTF-8编码，返回结果为UTF-8编码
  • 加密Sig为32位MD5数字签名大写字符串
  • 接口加密方式照旧
  • 接口返回参数为json格式
  • 接口地址由接口url与调用method确定唯一性
  • 所有接口请求头中将加入参数Channel: 渠道 version: 版本号 Device-Id: 设备号 platform: 平台 android/ios user: 用户id 可能会为空
  • 所有接口传入的默认参数为
    • method 方法名
    • name 调用用户
    • password 调用密码
    • meid 设备号
    • timestamp 时间戳
    • sig 加密串
  • 所有接口参数拼接加密后 使用http:\\xxxx:port/com/xxx.action?paramStr=加密串方式请求服务器

API LIST

1、首页推介接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页接口，包括首页推荐列表和直播条信息

请求参数

  • user_id: 用户id

返回参数

  • errorcode 00 成功
  • msg 服务器提示信息
  • recData: 首页推荐信息（直播条）,列表
    • id
    • type: 类型 0: 视频 1: 音频 2: 文章 3: 专题
    • tag: 标签，界面显示的红色文字标签
    • title: 标题
    • desc: 描述
  • vidData 视频信息，列表
    • title: 标题
    • id: 可以根据id获取对应的列表
    • vids 视频列表
      • id
      • channelType: 类型 0: 视频 1: 音频 2: 文章 3: 专题
      • img: 预览图
      • title: 标题
      • view: 点击量
      • comments 评论数
{
    "errorcode": 0,
    "msg": "提示",
    "recData": [
        {
            "id": 1231231232,
            "type": 3,
            "tag": "直播",
            "desc": "描述",
            "title": "标题"
        },
        {
            "id": 1231231232,
            "type": 3,
            "tag": "直播",
            "desc": "描述",
            "title": "标题"
        }
    ],
    "vidData": [
        {
            "title": "附近人都在看",
            "id": "列表id",
            "vids": [
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次数",
                    "comments": "1234评论次数"
                },
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次数",
                    "comments": "1234评论次数"
                }
            ]
        },
        {
            "title": "最近热播",
            "id": "列表id",
            "vids": [
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次数",
                    "comments": "1234评论次数"
                },
                {
                    "id": 23142341,
                    "title": "真娘子",
                    "channelType": 2,
                    "img": "http:\\sssss.jpg",
                    "url": "播放地址",
                    "view": "12421 播放次数",
                    "comments": "1234评论次数"
                }
            ]
        }
    ]
}

2、首页电视接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的电视列表页

请求参数

无

返回参数

  • errorcode 00 成功
  • msg
  • data 分类列表
    • id
    • programImg 当前节目图片
    • title 电视台名称
    • program 当前节目
    • timeTag 时间安排， 如 直播时间 10:26-20:00 或者每周五 10:26-20:00
    • fan 当前观看人数
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "CCTV5",
            "program": "动物世界",
            "timeTag": "直播时间 10:26-20:00",
            "fan": 342451
        },
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "CCTV8",
            "program": "金瓶梅",
            "timeTag": "直播时间 18:26-22:00",
            "fan": 324511
        }
    ]
}

3、首页电台接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的电台的列表接口，需要 返回历史收听记录和所有的电台

请求参数

无

返回参数

  • errorcode 00 成功
  • msg
  • data 分类列表
    • id
    • programImg 当前节目图片
    • title 电视台名称
    • program 当前节目
    • timeTag 时间安排， 如 直播时间 10:26-20:00 或者每周五 10:26-20:00
    • fan 当前观看人数
  • hotData 热门电台
    • id
    • title 电台名称
    • img电台图片
    • fan 当前观看人数
  • historyData 最近收听
    • id
    • title 电台名称
    • logo电台小图logo
    • fan 当前观看人数
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "fn 987",
            "program": "动物世界",
            "timeTag": "直播时间 10:26-20:00",
            "fan": 342451
        },
        {
            "id": "dafdasdf",
            "programImg": "xxx.jsg",
            "title": "FM 451",
            "program": "金瓶梅",
            "timeTag": "直播时间 18:26-22:00",
            "fan": 324511
        }
    ],
    "hotData": [
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        },
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        }
    ],
    "historyData": [
        {
            "id": "dafdasdf",
            "logo": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        },
        {
            "id": "dafdasdf",
            "logo": "xxx.jsg",
            "title": "FM 451",
            "fan": 324511
        }
    ]
}

4、首页活动接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
首页的活动列表接口

请求参数

无

返回参数

  • errorcode 00 成功
  • msg
  • data 分类列表
    • id
    • img 活动图片
    • title 活动名称
    • desc 活动的介绍、摘要
    • timeTag 时间安排， 如 活动时间 10:26-20:00 或者报名截止日期： 10:26-20:00
    • fan 当前参与人数
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "desc": "武汉晚报讯（记者万勤）夫妻俩协议离婚后，为争夺儿子的抚养权两人对簿公堂，女方说儿子非男方亲生，经亲子鉴定竟真的如此，男方一怒之下索赔50万。",
            "title": "夫妻离婚争抚养权发现儿子非亲生 男子索赔50万",
            "timeTag": "直播时间 10:26-20:00",
            "fan": 342451,
            "img": "活动图片"
        }
    ]
}

5、点播分类首页接口

| url | method |
| ----------|-------------------------------:|
| http://ip:port/interface/user/xxx.action | method|
点播分类接口展示点播界面的分类，点击根据分类id能够进入响应的分类

请求参数

无

返回参数

  • errorcode 00 成功
  • msg
  • data 分类列表
    • id
    • img 图标
    • title 标题
    • subData 次级栏目信息
      • id 可以通过列表接口
      • title
{
    "errorcode": 0,
    "msg": "提示",
    "data": [
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "体育",
            "subData": [
                {
                    "id": "l",
                    "title": "精选"
                },
                {
                    "id": 2,
                    "title": "热门"
                }
            ]
        },
        {
            "id": "dafdasdf",
            "img": "xxx.jsg",
            "title": "经济",
            "subData": [
                {
                    "id": "l",
                    "title": "精选"
                },
                {
                    "id": 2,
                    "title": "热门"
                }
            ]
        }
    ]
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 135,478评论 19赞 139
  • Android - 收藏集
    Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 175,653评论 25赞 709
  • Java初级面试题
    1. Java基础部分 基础部分的顺序：基本语法，类相关的语法，内部类的语法，继承相关的语法，异常的语法，线程的语...
    子非鱼_t_阅读 31,955评论 18赞 399
  • 每一个人都是你的贵人
    文/月方 阿洁，九十年代生女子，自小聪颖活泼，善于调停身边各色孩子，是方圆有名的“孩子王”。但阿洁对学习却相当反感...
    月方阅读 3,437评论 0赞 0
  • 有多远就走多远
    有风的日子， 一切东西， 都在奔跑…… 就让你的梦， 在那自然风的吹拂下， 有多远就走多远， 在那看不到路的尽头……
    小剧在成长阅读 1,904评论 0赞 6