2016年10月18日 (二) 11:20的版本

直播服务OPEN API

授权机制

目前微博开放平台用户身份鉴权采用的是Oauth2.0，参见 如何登录授权

访问频次限制

访问级别：普通接口

频次限制：是

关于频次限制，参考接口访问权限说明

创建直播

URL : https://api.weibo.com/2/proxy/live/create [POST]

说明：新建直播对象，获取直播推流地址，并同时发微博

参数：

返回：

示例：

{
    "id": "230916c5fc9c48670bf72b9135261865ef35cd",
    "url": "rtmp://ps.live.weibo.com/***/c5fc9c48670bf72b9135261865ef35cd?auth_key=***"
}

直播推流

第三方根据直播创建接口返回的推流地址rtmp_url开始推流

更新直播

URL : https://api.weibo.com/2/proxy/live/update [POST]

说明：直播对象信息、状态等更新

参数：

返回：

示例：

{
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
}

删除直播

URL : https://api.weibo.com/2/proxy/live/delete [POST]

说明：直播对象删除，不可逆

参数：

返回：

示例：

{
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
}

获取直播信息

URL : https://api.weibo.com/2/proxy/live/show [POST]

说明：直播对象信息、互动信息等获取

参数：

返回：

示例：

{
  id : 230916c5fc9c48670bf72b9135261865ef35cd
  uid : 3549297570
  title :  test
  url : http://live.weibo.com/show?id=1042097:c5fc9c48670bf72b9135261865ef35cd
  summary : test
  image : http://ww2.sinaimg.cn/large/8c447cdejw1f4a0uie0bmj20m80ciwg3.jpg
  status : 1
  live_views :  10
  total_views : 100
  total_stars : 100
  create_time : 2016-06-02 17:10:54
}

上传图片

URL：https://api.weibo.com/statuses/upload_pic.json[POST]

说明：上传图片接口

支持格式

JSON

是否需要登录

true 登录授权方式，请参见本WIKI内的 如何登录授权

请求参数

返回结果

//成功返回

{
    "pic_id": "946308c5jw1dv288whtylj",
    "thumbnail_pic": "http://ww3.sinaimg.cn/thumbnail/946308c5jw1dv288whtylj.jpg",
    "bmiddle_pic": "http://ww3.sinaimg.cn/bmiddle/946308c5jw1dv288whtylj.jpg",
    "original_pic": "http://ww3.sinaimg.cn/large/946308c5jw1dv288whtylj.jpg"
}
 

//失败返回

{
    "request": "/2/statuses/upload_pic.json",
    "error_code": "201XX",
    "error": "error message."
}

直播互动接口

创建上行互动

URL : https://api.weibo.com/2/proxy/live/chatroom/r_msg [POST]

说明：直播用户上行评论接口

参数：

返回：

示例：

{
    id : 230916c5fc9c48670bf72b9135261865ef35cd
    context : test
}

获取下行互动

URL : https://api.weibo.com/2/proxy/live/chatroom/r_sync [POST]

说明：直播者获取下行互动接口

参数：

返回示例：

[
    [MsgHeader,MsgBody],
    [NoticesHeader,NoticesBody],
    ......
]

MsgHeader = {
        type: "chatroom",
        proto: "r_msg",
        ......
    }
MsgBody = #r_msg: {
    "id": "uint64",     //下行时为消息的global id
    "from": "uint64",    //下行时为发送者的id
    "to": "string",     //互动id
    "type": "uint32",
    "content": "string",  
    "latitude": "string",
    "longitude": "string",
    "curr_play": "uint64",       //记录直播直播进度，精确到毫秒；-1：未开始；0：直播已结束
    "additional_desc": "string", 
    "user":{
            "id": "uint64",   //uid        
            "name": "string",   //昵称
            "avatar": "string"   //头像信息
        }
}

NoticesHeader = {
        type: "chatroom",
        proto: "r_notices",
        ......
    }
NoticesBody = #r_notices: {
    "id": "string",           //房间对应的room id
    "error_msg": "string",    //只有出错的时候才会提供此选项
    "notices": [{             //多个通知列表 
        "type": "uint32",
        "users":[{            //同一种类型事件通知，可以为空，可以是单个用户，或多个用户等。
            "id": "uint64",
            "name": "string",
            "avatar": "string"
        }],
        "value": "uint32",    //其值类型由type确定，可以为空
        "time": "uint64"
    }]
}

注：
type(通知类型)：
4：点赞数量，users为空，value为点赞数量，uint32

错误代码

错误码

示例：

{
  request :
  error_code :
  error :
}