CreateLiveRoom - 创建直播

调用CreateLiveRoom创建状态为未开播的新直播。

调试

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

调试

授权信息

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

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

请求参数

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

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
Titlestring

直播标题,支持中英文,最大长度32位。

Title001
Noticestring

直播公告,支持中英文,最大长度256位。

Notice001
CoverUrlstring

直播封面,支持图片地址链接格式,最大长度256位。

http://***.png
Extensionobject

拓展字段,按需传递,需要额外记录的直播属性。最大长度4096位。

string
test001
AnchorIdstring

主播ID,仅支持英文和数字,最大长度36位。

as****hs
AnchorNickstring

主播昵称,支持中英文,最大长度32位。

User001
UserIdstring

操作人ID,仅支持英文和数字,最大长度36位。

as****hs
EnableLinkMicboolean

是否开启连麦功能,默认为false。

false

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

创建直播返回的结果。

AppIdstring

用户的应用ID,在控制台创建应用时生成。包含小写字母、数字,长度为6个字符。

7m***q
RoomIdstring

房间的唯一标识ID。用于进出房间等相关接口的使用。

AE35-****-T95F
LiveIdstring

直播的唯一标识ID。

b7f2****ebb3
ChatIdstring

弹幕的唯一标识。用户发送消息等相关接口的使用。

09***f8
Titlestring

直播标题。

Title001
Noticestring

直播公告。

Notice001
CoverUrlstring

直播封面。

http://***.png
AnchorIdstring

主播ID。

as****hs
PlaybackUrlstring

直播回放地址。直播开始时生成,直播结束后可以观看。

http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3
PushUrlstring

直播推流地址。

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

直播播流地址。

http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3
PluginInstanceInfoListarray

活跃插件列表。

object
PluginTypestring

插件唯一标识,取值:

  • live:直播。
  • wb:白板。
  • chat:聊天。
  • rtc:音视频通信。
live
PluginIdstring

插件实例唯一标识。

HASU-****-ASHD
CreateTimeLong

插件实例创建时间戳,单位:毫秒。

1624589848000
Extensionobject

插件拓展字段。

string

插件拓展信息。

test001
Extensionobject

直播拓展字段。

string

直播拓展信息。

test001
AnchorNickstring

主播昵称。

User001
HlsUrlstring

原画HLS播放地址。

http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3
ArtcInfoobject

RTS低延迟播流信息。

ArtcUrlstring

RTS原码流地址,推荐移动端使用。

artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3
ArtcH5Urlstring

RTS转码流地址,推荐Web端使用。

artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3

示例

请求示例

http(s)://[Endpoint]/?Action=CreateLiveRoom
&AppId=7m***q
&Title=Title001
&Notice=Notice001
&CoverUrl=http://***.png
&Extension={"key":"test001"}
&AnchorId=as****hs
&AnchorNick=User001
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "AppId": "7m***q",
        "RoomId": "AE35-****-T95F",
        "LiveId": "b7f2****ebb3",
        "ChatId": "09***f8",
        "Title": "Title001",
        "Notice": "Notice001",
        "CoverUrl": "http://***.png",
        "AnchorId": "as****hs",
        "PlaybackUrl": "http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3",
        "PushUrl": "rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3",
        "LiveUrl": "http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3",
        "PluginInstanceInfoList": [
            {
                "PluginType": "live",
                "PluginId": "HASU-****-ASHD",
                "CreateTime": 1624589848000,
                "Extension": {
                    "key": "test001"
                }
            }
        ],
        "Extension": {
            "key": "test001"
        },
        "AnchorNick": "User001",
        "HlsUrl": "http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3",
        "ArtcInfo": {
            "ArtcUrl": "artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3",
            "ArtcH5Url": "artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3"
        }
    }
}

XML格式

<CreateLiveRoomResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <AppId>7m***q</AppId>
        <RoomId>AE35-****-T95F</RoomId>
        <LiveId>b7f2****ebb3</LiveId>
        <ChatId>09***f8</ChatId>
        <Title>Title001</Title>
        <Notice>Notice001</Notice>
        <CoverUrl>http://***.png</CoverUrl>
        <AnchorId>as****hs</AnchorId>
        <PlaybackUrl>http://demo-app-playback.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</PlaybackUrl>
        <PushUrl>rtmp://demo-app-push.com/live/e620****a8e3?auth_key=e620****a8e3</PushUrl>
        <LiveUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.flv?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</LiveUrl>
        <PluginInstanceInfoList>
            <PluginType>live</PluginType>
            <PluginId>HASU-****-ASHD</PluginId>
            <CreateTime>1624589848000</CreateTime>
            <Extension>
                <key>test001</key>
            </Extension>
        </PluginInstanceInfoList>
        <Extension>
            <key>test001</key>
        </Extension>
        <AnchorNick>User001</AnchorNick>
        <HlsUrl>http://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3.m3u8?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</HlsUrl>
        <ArtcInfo>
            <ArtcUrl>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcUrl>
            <ArtcH5Url>artc://demo-app-live.com/live/b7f29c02-****-40fd-****-e8d06a8aebb3_origin-RTS?auth_key=1627522726-0-0-******e620b363d4cf8a8e3</ArtcH5Url>
        </ArtcInfo>
    </Result>
</CreateLiveRoomResponse>

错误码

Http code错误码错误信息描述
400Invalid.Live.ConfigNotFoundThe live push domain and pull domain config not found.直播的推拉流未配置,请登录控制台应用配置页面完成配置。

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

阿里云首页 低代码音视频工厂 相关技术圈