Weibo Platform Logo

微博开放平台

weibo
跳转到： 导航, 搜索
(→微博直播OPEN API的限制)
 
（未显示2个用户的76个中间版本）
第1行： 第1行：
 +
=直播服务 OPEN API=
  
−
== 微博直播平台接入说明 ==
+
<div class="wiki_txtJ">
−
随着信息传播逐渐富媒体化的趋势，以及移动设备和网络环境的升级，移动视频直播越来越被大众熟悉、接受和使用。微博作为中国最大的社会化媒体平台，目前已支持直播内容的展示和播放，为了使第三方视直播内容更好的在微博上播放和传播，同时也肩负起社会化媒体平台的责任，微博将直播API开放给第三方软件开发者以及硬件厂商，共同打造移动视频直播生态。
+
阅读以下文档，帮助了解如何使用微博直播接口。
−
== 微博直播OPEN API功能特点 ==
+
−
1.广泛的直播形式接入
+
−
微博直播OPEN API不仅能支持网站、移动APP等软件开发者接入，同时也支持无人机、运动相机等硬件厂商接入，具有广泛的直播形式接入能力。
+
  
−
 
−
2.丰富的互动形式及回馈
 
−
直播内容在微博传播时，微博提供了丰富的互动形式让观看者和直播发布者互动，具体包含弹幕评论、喜欢、礼物打赏，同时直播OPEN API支持将这些互动内容同步回馈给接入的第三方。
 
  
 +
目前微博开放平台用户身份鉴权采用的是Oauth2.0，参见 [http://open.weibo.com/wiki/%E6%8E%88%E6%9D%83%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E 如何登录授权]
  
−
3.强大的直播支撑能力
+
关于频次限制，参考[http://open.weibo.com/wiki/Rate-limiting  接口访问权限说明]
−
微博直播拥有强大的直播支撑能力，可提供流畅的直播播放体验及较小的直播延迟时间，可支持千万级的同时在线，每秒百万级的互动信息下发。
+
</div>
  
  
−
4.高效的直播内容传播
+
==创建直播==
−
第三方直播内容接入后可享受微博直播统一的用户触达服务，具体包括直播push通知、直播置顶提示，同时也能享受直播feed大图卡片，增加直播内容的曝光率。
+
−
（加图）
+
  
 +
https://api.weibo.com/2/proxy/live/create
  
−
5.第三方品牌体现
+
POST
−
微博直播支持给接入的第三方适当的品牌体现，增加第三方品牌的影响力。
+
−
（加图）
+
  
 +
新建直播对象，获取直播推流地址，并同时发微博
  
−
== 微博直播OPEN API接入流程 ==
+
===参数===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段必选
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="65%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{api_args|access_token|true|string|采用OAuth授权方式为必填参数，OAuth授权后获得}}
 +
{{api_args|title|true|string|直播描述}}
 +
{{api_args|width|true|string|直播宽度}}
 +
{{api_args|height|true|string|直播高度}}
 +
{{api_args|summary|false|string|微博文本内容，必须做URLencode，内容不超过130个汉字}}
 +
{{api_args|published|false|string|微博是否发布，0：公开发布，1：仅自己可见，默认为0}}
 +
{{api_args|image|false|string|封面图地址，注意封面图的宽高和直播的宽高比例要一致。}}
 +
{{api_args|replay|false|string|是否录制，0：不录制，1：录制，默认为1}}
 +
{{api_args|is_panolive|false|string|是否全景直播，0：不是，1：是，默认为0}}
 +
|}
  
 +
===返回示例===
 +
<pre class="brush:js">
 +
{
 +
    "id": "230916c5fc9c48670bf72b9135261865ef35cd",
 +
    "room_id": "1042097:5617ce1cc0f822ebd37f93a0275c8660",
 +
    "url": "rtmp://ps.live.weibo.com/***/c5fc9c48670bf72b9135261865ef35cd?auth_key=***"
 +
}
 +
</pre>
  
 +
===返回字段说明===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="75%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{rdes_args|id|string|直播ID}}
 +
{{rdes_args|rtmp_url|string|直播推流地址}}
 +
{{rdes_args|room_id|string|房间id}}
 +
|}
  
  
 +
==直播推流==
  
−
== 微博直播OPEN API的限制 ==
+
第三方根据直播创建接口返回的推流地址rtmp_url开始推流
  
−
1.用户直播权限限制
 
−
目前微博直播只支持微博支付宝绑定用户、橙V认证用户、媒体蓝V开通直播功能，所以，不再此范围内的用户暂不能通过第三方接入的方式进行直播。
 
  
 +
==更新直播==
  
−
2.直播参数限制：
+
https://api.weibo.com/2/proxy/live/update
−
{{left|http://ww3.sinaimg.cn/large/67110a0cjw1f4ellgy581j20f602jweb.jpg}}
+
  
−
== 无技术开发能力的小伙伴如何使用微博直播服务？ ==
+
POST
  
−
针对无技术开发能力的机构或个人，微博还提供了另外一种快捷的直播方式，通过简单的几步操作即可完成一场直播。但目前此功能需要申请权限才能使用，私信微博直播的官方微博：微博直播 咨询开通。直播创建页面地址:http://weibo.com/p/231087001
+
直播对象信息、状态等更新
  
−
'''使用步骤说明'''
+
===参数===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段必选
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="65%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{api_args|access_token|true|string|采用OAuth授权方式为必填参数，OAuth授权后获得}}
 +
{{api_args|id|true|string|直播ID}}
 +
{{api_args|title|false|string|直播描述}}
 +
{{api_args|summary|false|string|微博文本内容，必须做URLencode，内容不超过130个汉字}}
 +
{{api_args|published|false|string|微博是否发布，0：公开发布，1：仅自己可见，2：不发布 默认为2}}
 +
{{api_args|image|false|string|直播封面图地址}}
 +
{{api_args|stop|false|string|直播结束，0：直播中，1：直播结束，默认为0}}
 +
{{api_args|replay_url|false|string|直播回放地址}}
 +
|}
  
−
1、 打开直播创建页面，点击新建直播。
+
===返回示例===
 +
<pre class="brush:js">
 +
{
 +
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
 +
}
 +
</pre>
  
 +
===返回字段说明===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="75%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{rdes_args|id|string|直播ID}}
 +
|}
  
−
{{center|http://ww2.sinaimg.cn/large/67110a0cjw1f4elc855laj20gz0e4acl.jpg}}
 
  
−
+
==删除直播==
−
2、 输入直播标题、微博正文、上传直播封面图。
+
  
 +
https://api.weibo.com/2/proxy/live/delete
  
−
{{center|http://ww2.sinaimg.cn/large/67110a0cjw1f4elc8gmvuj20ho0entaa.jpg}}
+
POST
  
 +
直播对象删除，不可逆
  
−
3、 点击下一步，返回推流地址，设置推荐软件，并开启推流。
+
===参数===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段必选
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="65%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{api_args|access_token|true|string|采用OAuth授权方式为必填参数，OAuth授权后获得}}
 +
{{api_args|id|true|string|直播ID}}
 +
|}
  
 +
===返回示例===
 +
<pre class="brush:js">
 +
{
 +
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
 +
}
 +
</pre>
  
−
{{center|http://ww4.sinaimg.cn/large/67110a0cjw1f4elc8ww9nj20ho0enjtj.jpg}}
+
===返回字段说明===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="75%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{rdes_args|id|string|直播ID}}
 +
|}
  
−
 
−
4、 预览直播内容，并发布直播微博。
 
  
−
{{center|http://ww1.sinaimg.cn/large/67110a0cjw1f4elc9myoej20gz0c3dnb.jpg}}
+
==获取直播信息==
  
−
== 联系方式 ==
+
https://api.weibo.com/2/proxy/live/show
  
−
如有问题请联系 wbdmt@staff.weibo.com
+
POST
 +
 
 +
直播对象信息、互动信息等获取
 +
 
 +
===参数===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段必选
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="65%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{api_args|access_token|true|string|采用OAuth授权方式为必填参数，OAuth授权后获得}}
 +
{{api_args|id|true|string|直播ID}}
 +
{{api_args|detail|false|string|直播详情，0：不返回，1：返回，默认为0}}
 +
|}
 +
 
 +
===返回示例===
 +
<pre class="brush:js">
 +
{
 +
    "id": "230912beaccf45a32ac3a36078b245ad8b5ddf",
 +
    "uid": "2791445053",
 +
    "title": "测试直播修改",
 +
    "summary": "测试直播修改简介",
 +
    "url": "http://live.weibo.com/show?id=1042097:beaccf45a32ac3a36078b245ad8b5ddf",
 +
    "status": 3,
 +
    "create_time": "2016-10-20 16:40:29"
 +
}
 +
</pre>
 +
 
 +
===返回字段说明===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|参数字段
 +
!width="10%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段类型
 +
!width="75%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|字段说明
 +
{{rdes_args|id|string|直播ID}}
 +
{{rdes_args|uid|string|直播作者ID}}
 +
{{rdes_args|title|string|直播标题}}
 +
{{rdes_args|summary|string|微博文本内容}}
 +
{{rdes_args|image|string|封面图地址}}
 +
{{rdes_args|url|string|直播落地页}}
 +
{{rdes_args|status|int|直播状态}}
 +
{{rdes_args|create_time|string|直播创建时间}}
 +
{{rdes_args|live_views|int|直播实时在线人数，detail为1时返回}}
 +
{{rdes_args|total_views|int|直播总在线人数，detail为1时返回}}
 +
{{rdes_args|total_stars|int|直播总点赞数，detail为1时返回}}
 +
|}
 +
 
 +
 
 +
==直播互动接口==
 +
 
 +
<div class="wiki_taglist">
 +
<ul class="clearfix">
 +
<li style="font-size:14px;">[[live/im/api|直播互动接口]]</li>
 +
</ul>
 +
</div>
 +
 
 +
 
 +
==错误代码==
 +
 
 +
===错误返回示例===
 +
<pre class="brush:js">
 +
{
 +
  request :
 +
  error_code :
 +
  error :
 +
}
 +
</pre>
 +
 
 +
===错误码字段说明===
 +
{| border="1" cellspacing="0" cellpadding="0" width="100%" class="parameters" style="border-color:#CCCCCC;"
 +
|-
 +
!width="15%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|错误码
 +
!width="40%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|错误msg
 +
!width="45%" style="text-align:left;padding-left:5px;font-weight:bolder;border:1px solid #cccccc"|描述
 +
{{rdes_args|20001|live create error|创建直播失败}}
 +
{{rdes_args|20002|update weibo error|发微博失败}}
 +
{{rdes_args|20003|post param loss|post参数缺失}}
 +
{{rdes_args|20004|get param loss|get参数缺失}}
 +
{{rdes_args|20005|live delete error|删除直播失败}}
 +
{{rdes_args|20006|live update error|更新直播失败}}
 +
{{rdes_args|20007|send message error|评论失败}}
 +
{{rdes_args|20008|rsync message error|拉取失败}}
 +
{{rdes_args|20009|live id unexist|直播ID不存在}}
 +
{{rdes_args|20010|weibo content more than 130 word|微博文字超过130字了}}
 +
{{rdes_args|20011|msg content more than 100 word,or is null|评论文字超过100字了，或者为空}}
 +
{{rdes_args|20012|msg content type error|发言的文本类型错误}}
 +
{{rdes_args|20013|authority not allow|权限不够(appkey or uid不一致)}}
 +
{{rdes_args|20014|user not allow|uid不符合要求(目前微博直播只支持橙V认证用户、媒体&政务蓝V认证用户开通直播功能，不在此范围内的用户需通过芝麻认证或人工认证才能进行直播)}}
 +
|}
 +
 
 +
 
 +
 
 +
__NOTOC__
 +
{{#a:nobtns|noheading}}

2017年9月21日 (四) 16:58的最后版本

直播服务 OPEN API

阅读以下文档，帮助了解如何使用微博直播接口。


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

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


创建直播

https://api.weibo.com/2/proxy/live/create

POST

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

参数

参数字段 字段必选 字段类型 字段说明
access_token true string 采用OAuth授权方式为必填参数，OAuth授权后获得
title true string 直播描述
width true string 直播宽度
height true string 直播高度
summary false string 微博文本内容，必须做URLencode，内容不超过130个汉字
published false string 微博是否发布，0：公开发布，1：仅自己可见，默认为0
image false string 封面图地址，注意封面图的宽高和直播的宽高比例要一致。
replay false string 是否录制，0：不录制，1：录制，默认为1
is_panolive false string 是否全景直播，0：不是，1：是，默认为0

返回示例

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

返回字段说明

参数字段 字段类型 字段说明
id string 直播ID
rtmp_url string 直播推流地址
room_id string 房间id


直播推流

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


更新直播

https://api.weibo.com/2/proxy/live/update

POST

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

参数

参数字段 字段必选 字段类型 字段说明
access_token true string 采用OAuth授权方式为必填参数，OAuth授权后获得
id true string 直播ID
title false string 直播描述
summary false string 微博文本内容，必须做URLencode，内容不超过130个汉字
published false string 微博是否发布，0：公开发布，1：仅自己可见，2：不发布 默认为2
image false string 直播封面图地址
stop false string 直播结束，0：直播中，1：直播结束，默认为0
replay_url false string 直播回放地址

返回示例

{
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
}

返回字段说明

参数字段 字段类型 字段说明
id string 直播ID


删除直播

https://api.weibo.com/2/proxy/live/delete

POST

直播对象删除，不可逆

参数

参数字段 字段必选 字段类型 字段说明
access_token true string 采用OAuth授权方式为必填参数，OAuth授权后获得
id true string 直播ID

返回示例

{
    "id": "230916c5fc9c48670bf72b9135261865ef35cd"
}

返回字段说明

参数字段 字段类型 字段说明
id string 直播ID


获取直播信息

https://api.weibo.com/2/proxy/live/show

POST

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

参数

参数字段 字段必选 字段类型 字段说明
access_token true string 采用OAuth授权方式为必填参数，OAuth授权后获得
id true string 直播ID
detail false string 直播详情，0：不返回，1：返回，默认为0

返回示例

{
    "id": "230912beaccf45a32ac3a36078b245ad8b5ddf",
    "uid": "2791445053",
    "title": "测试直播修改",
    "summary": "测试直播修改简介",
    "url": "http://live.weibo.com/show?id=1042097:beaccf45a32ac3a36078b245ad8b5ddf",
    "status": 3,
    "create_time": "2016-10-20 16:40:29"
}

返回字段说明

参数字段 字段类型 字段说明
id string 直播ID
uid string 直播作者ID
title string 直播标题
summary string 微博文本内容
image string 封面图地址
url string 直播落地页
status int 直播状态
create_time string 直播创建时间
live_views int 直播实时在线人数，detail为1时返回
total_views int 直播总在线人数，detail为1时返回
total_stars int 直播总点赞数，detail为1时返回


直播互动接口


错误代码

错误返回示例

{
  request :
  error_code :
  error :
}

错误码字段说明

错误码 错误msg 描述
20001 live create error 创建直播失败
20002 update weibo error 发微博失败
20003 post param loss post参数缺失
20004 get param loss get参数缺失
20005 live delete error 删除直播失败
20006 live update error 更新直播失败
20007 send message error 评论失败
20008 rsync message error 拉取失败
20009 live id unexist 直播ID不存在
20010 weibo content more than 130 word 微博文字超过130字了
20011 msg content more than 100 word,or is null 评论文字超过100字了，或者为空
20012 msg content type error 发言的文本类型错误
20013 authority not allow 权限不够(appkey or uid不一致)
20014 user not allow uid不符合要求(目前微博直播只支持橙V认证用户、媒体&政务蓝V认证用户开通直播功能，不在此范围内的用户需通过芝麻认证或人工认证才能进行直播)




来自“http://open.weibo.com/wiki/index.php?title=Live/api&oldid=15608”
文档更新时间: 2017-09-21

关于微博开放平台| 联系我们| 服务条款| 无线游戏| 开放平台官微

京网文 [2011] 0398-130号 京ICP证100780号 Copyright © 1996-2024 SINA