文档中心

实时音视频

请输入

输入在线媒体流

查询在线媒体流输入任务 ListRelayStream

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 ListRelayStream 接口，获取指定 RTC 房间或应用下，在线媒体流输入任务的列表及详细信息，如任务状态、创建时间、媒体流地址等。单次查询可返回多达 10000 条任务信息。

注意事项

请求频率：QPS 不得超过 150。

请求说明

请求方式：GET

请求地址：https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

Action String 必选示例值：ListRelayStream

接口名称。当前 API 的名称为 ListRelayStream。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

AppId String 必选示例值：66*****3cf

RTC 或 WTN 应用 ID。与 StartRelayStream 发起推送时设置的保持一致。

RTC 应用 ID：在 RTC 控制台获取。

WTN 应用 ID：在 WTN 控制台获取。

RoomId String 必选示例值：Room1

RTC 房间 ID。

注意

仅当查询 RTC 房间推流任务时为必填。

Offset Integer 可选示例值：0

起始位置，取值范围为[0,9999]，默认值为 0。

Limit Integer 可选示例值：10

页大小，取值范围为[1,100]，默认值为 10。

Order Integer 可选示例值：0

接口调用时间顺序。

0：倒序。

1：正序。

默认值为0。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

Task Object[] 示例值：-

任务列表。

AppId String 示例值：66****cf

应用 ID。

RoomId String 示例值：Room1

RTC 房间 ID。

UserId String 示例值：User1

在线媒体流对应的 UserId。

TaskId String 示例值：Task1

任务 ID。

Status Integer 示例值：1

任务当前状态。

1：任务启动中。

2：任务运行中。

3：任务已结束。

CreateTime Integer 示例值：1656332552

任务开始时间，Unix 时间戳，单位为秒。

StreamUrl String 示例值：rtmp://xxx

在线媒体流地址。

StreamMode Integer 示例值：0

流处理模式。

0：转码

1：转封装

MediaType Integer 示例值：0

媒体类型。

0：音视频

1：音频

2：视频

VideoWidth Integer 示例值：640

视频宽度，单位为像素。

VideoHeight Integer 示例值：480

视频高度，单位为像素。

FrameRate Integer 示例值：15

发送帧率。

Volume Integer 示例值：100

在线媒体流播放音量，范围是 [0, 400]，单位为 %。

0：静音

100（默认值）：原始音量。

400：原始音量的 4 倍。

Total Integer 示例值：1

当前页大小。

Offset Integer 示例值：0

下一页索引。

Limit Integer 示例值：10

页大小。

请求示例

GET https://rtc.volcengineapi.com?Action=ListRelayStream&Version=2023-11-01&AppId=661e7ae5543cf&RoomId=Room1&Offset=0&Limit=10&Order=0​

返回示例

{​
    "Result": {​
        "Task": [​
            {​
                "AppId": "66****cf",​
                "RoomId": "Room1",​
                "TaskId": "Task1",​
                "StreamUrl": "rtmp://xxx",​
                "MediaType": 0,​
                "StreamMode": 0,​
                "VideoWidth": 1920,​
                "VideoHeight": 1080,​
                "FrameRate": 30,​
                "Bitrate": 6000,​
                "Loop": true,​
                "UserId": "user1",​
                "Status": 2,​
                "CreateTime": 1656332552​
            }​
        ],​
        "Offset": 0,​
        "Limit": 10,​
        "Total": 1​
    },​
    "ResponseMetadata": {​
        "RequestId": "20230604110420",​
        "Action": "ListRelayStream",​
        "Version": "2023-11-01"​
    }​
}​

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.04.10 12:03:00

这个页面对您有帮助吗？

有用

无用