文档

PublishLive - 发布直播

更新时间:

发布直播,将直播状态转变为直播中,并获取推拉流地址。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用加粗字体表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imp:PublishLiveWrite
  • IMP
    acs:imp::{#accountId}:*

请求参数

名称类型必填描述示例值
LiveIdstring

直播资源的唯一标识ID。

b7f2****ebb3
UserIdstring

用户UserId,在AppId下单独唯一。小写英文、数字、下划线(_)和小数点(.)组成,最大长度32个字符。

as****hs

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

FE22D613-D3C6-4A58-87CA-F21FC85AA08E
Resultobject

发布直播的返回结果。

LiveIdstring

直播资源的唯一标识ID。

b7f2****ebb3
AnchorIdstring

主播ID。

as****hs
Statusstring

直播状态。类型为字符串,取值:

  • 1:直播中。
1
PushUrlstring

直播推流地址。

rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3
LiveUrlstring

直播拉流地址。

http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3

示例

请求示例

http(s)://[Endpoint]/?Action=PublishLive
&LiveId=b7f2****ebb3
&UserId=as****hs
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "LiveId": "b7f2****ebb3",
        "AnchorId": "as****hs",
        "Status": "1",
        "PushUrl": "rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3",
        "LiveUrl": "http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3"
    }
}

XML格式

<PublishLiveResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <LiveId>b7f2****ebb3</LiveId>
        <AnchorId>as****hs</AnchorId>
        <Status>1</Status>
        <PushUrl>rtmp://demo-app-push.com/live/b7f2****ebb3?auth_key=e620****a8e3</PushUrl>
        <LiveUrl>http://demo-app-live.com/live/b7f2****ebb3.flv?auth_key=e620****a8e3</LiveUrl>
    </Result>
</PublishLiveResponse>

错误码

Http code错误码错误信息描述
400InvalidLiveId.Live.NotFoundThe live broadcast does not exist.直播不存在。

访问错误中心查看更多错误码。