You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /企业直播/API 参考/直播间状态和直播频道配置/GetStreamsAPI - 获取推流直播和拉流直播信息
GetStreamsAPI - 获取推流直播和拉流直播信息
最近更新时间：2025.06.06 16:12:35首次发布时间：2022.03.29 22:10:12
我的收藏
有用
有用
无用
无用

调用 GetStreamsAPI 接口，获取直播间内各直播频道的推流直播和拉流直播信息。

使用说明

在推流直播信息中，推流地址在生成后 15 天会过期不可用。您可以选择自动刷新或手动刷新推流地址。

  • 自动刷新：当推流地址过期时，可以调用该接口获取最新的推流地址。
  • 手动刷新：调用该接口时，将请求参数 NeedRefreshPushUrl 设置为 true，即可手动刷新推流地址并获取最新的推流地址。

注意事项

  • 请求频率：单用户请求频率限制为 120 次/分钟。
  • 前提条件：确保您拥有火山引擎主账号或具备直播间的直播控制 > 仅查看或可编辑权限的子账号。有关如何添加子账号，详见子账号管理。

请求说明

  • 请求方式：GET
  • 请求地址：https://livesaas.volcengineapi.com/?Action=GetStreamsAPI&Version=2020-06-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是GetStreamsAPI接口名称。当前 API 的名称为 GetStreamsAPI。
VersionString是2020-06-01接口版本。当前 API 的版本为 2020-06-01。

ActivityId

Long

是

1783****01300

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时，确保该直播间对子账号可见。有关如何配置子账号的可见范围，详见子账号管理。

NeedRefreshPushUrl

Boolean

否

false

是否手动刷新推流地址。默认值为 false。取值如下：

  • true：手动刷新，获取刷新后的推流地址和推流密钥
  • false：不手动刷新

返回参数

参数类型示例值描述
LineDetailsArray of LineDetails-直播频道的推流直播和拉流直播信息列表。

LineDetails

参数类型示例值描述
LineIdLong36**624直播频道 ID。
LineNameStringDefault直播频道名称。
MainPushInfoArray of MainPushInfo-推流直播的主流地址信息。
BackPushInfoArray of BackPushInfo-推流直播的备流地址信息。
RatioString1280x720直播频道的分辨率。

ForwardInfo

Array of ForwardInfo

-

拉流直播的主流地址信息。

说明

开始拉流后，拉流任务的有效时间为 48 小时。

BackupForwardInfo

Array of BackupForwardInfo

-

拉流直播的备流地址信息。

说明

开始拉流后，拉流任务的有效时间为 48 小时。

ExpireTimeLong1697167355推流地址的过期时间。Unix 时间戳，单位为秒。

MainPushInfo

参数类型示例值描述
PushPathStringrtmp://push-rtmp-l6-act.pstatp.com/activity/推流服务器地址。
StreamingCodeStringstream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57推流密钥。
PushUrlStringrtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57推流地址。

BackPushInfo

参数类型示例值描述
PushPathStringrtmp://push-rtmp-l6-act.pstatp.com/activity/推流服务器地址。
StreamingCodeStringstream-402918918124208216?k=3a221d196a806cbf&t=1710323159推流密钥。
PushUrlStringrtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?k=3a221d196a806cbf&t=1710323159推流地址。

ForwardInfo

参数类型示例值描述
PullStreamUrlStringhttps://example/livesaas?key=example拉流直播的主流地址。

PullStreamStatus

String

0

拉流直播任务状态。取值如下：

  • 0：拉流任务初始化中
  • 1：拉流任务运行中
  • 2：拉流任务已结束

PullStreamCheckStatus

String

0

拉流检测状态。取值如下：

  • 0：检测中
  • 1：源流未推流
  • 2：正常拉流
  • 3：拉流结束
  • 4：拉流异常

BackupForwardInfo

参数类型示例值描述
PullStreamUrlStringhttps://example2/livesaas?key=example拉流直播的备流地址。

PullStreamStatus

String

0

拉流直播任务状态。取值如下：

  • 0：拉流任务初始化中
  • 1：拉流任务运行中
  • 2：拉流任务已结束

PullStreamCheckStatus

String

0

拉流检测状态。取值如下：

  • 0：检测中
  • 1：源流未推流
  • 2：正常拉流
  • 3：拉流结束
  • 4：拉流异常

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetStreamsAPI&Version=2020-06-01&ActivityId=1783****01300&NeedRefreshPushUrl=false

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetStreamsAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "LineDetails": [
            {
                "LineId": 36**624,
                "LineName": "Default",
                "MainPushInfo": [
                    {
                        "PushPath": "rtmp://push-rtmp-l6-act.pstatp.com/activity/",
                        "PushUrl": "rtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57",
                        "StreamingCode": "stream-402918918124208216?keeptime=0013c680&wsSecret=3933d232d0560f8979fb4825843bf32c&wsTime=65ddaf57"
                    }
                ],
                "BackPushInfo": [
                    {
                        "PushPath": "rtmp://push-rtmp-l6-act.pstatp.com/activity/",
                        "PushUrl": "rtmp://push-rtmp-l6-act.pstatp.com/activity/stream-402918918124208216?k=3a221d196a806cbf&t=1710323159",
                        "StreamingCode": "stream-402918918124208216?k=3a221d196a806cbf&t=1710323159"
                    }
                ],
                "Ratio": "1280x720",
                "ForwardInfo": [
                    {
                        "PullStreamUrl": "https://example/livesaas?key=example",
                        "PullStreamStatus": "0",
                        "PullStreamCheckStatus": "0"
                    }
                ],
                "BackupForwardInfo": [
                    {
                        "PullStreamUrl": "https://example2/livesaas?key=example",
                        "PullStreamStatus": "0",
                        "PullStreamCheckStatus": "0"
                    }
                ],
                "ExpireTime": 1697167355
            }
        ]
    }
}

错误码

访问公共错误码和错误码获取详细信息。