文档

CreateRoom - 创建房间

更新时间:

调用CreateRoom创建一个房间,用户可以在房间内使用直播、白板、音视频通信等功能。

调试

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

调试

授权信息

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

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

请求参数

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

应用唯一标识,可以包含小写字母、数字,长度为6个字符。

7m***q
TemplateIdstring

模板ID。取值:

  • default:默认。

传空值,则默认为default

default
RoomIdstring

房间ID,最大长度36个字符,传空值,则随机生成一个房间ID。

AE35-****-T95F
Titlestring

房间标题,支持中英文和数字,最大长度32个字符。

RoomTitle001
Noticestring

房间公告,支持中英文和数字以及常用符号,最大长度256个字符。

RoomNotice001
RoomOwnerIdstring

房主ID,仅支持英文和数字,最大长度36个字符。

as****hs
Extensionobject

拓展字段,按需传递,需要额外记录的房间属性。所有字段键-值长度总和不超过2048字节。

string
test001

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求ID。

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

创建房间的返回结果。

RoomIdstring

房间ID。

AE35-****-T95F

示例

请求示例

http(s)://[Endpoint]/?Action=CreateRoom
&AppId=7m***q
&TemplateId=default
&RoomId=AE35-****-T95F
&Title=RoomTitle001
&Notice=RoomNotice001
&RoomOwnerId=as****hs
&Extension={"key":"test001"}
&公共请求参数

正常返回示例

JSON格式

{
    "RequestId": "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
    "Result": {
        "RoomId": "AE35-****-T95F"
    }
}

XML格式

<CreateRoomResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <Result>
        <RoomId>AE35-****-T95F</RoomId>
    </Result>
</CreateRoomResponse>

错误码

Http code错误码错误信息描述
400InvalidRoomId.Room.AlreadyExistRoom is already exist.房间已存在。

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

  • 本页导读 (1)
文档反馈