创建房间

POST

https://zim-api.zego.im/

开发者可以调用此接口创建房间，创建房间时支持设置自定义的房间属性。一个房间最多可设置 20 个房间属性，如果需要增加房间属性数量上限，请联系 ZEGO 技术支持。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [CreateRoom]

接口原型参数

https://zim-api.zego.im/?Action=CreateRoom

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

操作者，需要是已注册状态，该用户不会自动加入房间。仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'，'，'

RoomId string必填

可选值: <= 32 characters

房间 ID 。仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，'-'，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'，'，'

RoomName string

可选值: <= 64 characters

房间名称。最大长度不超过 64 字节的字符串。

DestroyDelayTime number

可选值: <= 10800

房间人数为 0 时，房间延迟销毁时间，单位为秒。最长房间延迟销毁时间默认为 10800 秒。当房间延迟销毁时，房间属性和房间用户属性默认不保留。如果需要保留，请联系 ZEGO 技术支持。

Attributes object[]

要添加的属性信息。

Array[

Key string必填

房间属性 key。

Value string必填

房间属性 value。

AutoDelete number

可选值: [0, 1]

用户退出时，是否自动删除， 0 ：不自动删除， 1 ：自动删除。创建房间时不会把 FromUserId 加入到房间，只会在其先进入房间，然后再退出时触发删除操作。

]

Responses

application/json

数据结构
按数据结构生成的示例

Schema

Code int32

返回状态码（0 表示成功）。

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	解决方案
660000002	参数错误。	请检查参数。
660300005	频率限制。	请稍后再尝试。
660300014	房间已存在。	检查房间是否已经创建。
660300015	房间数超出上限。	检查房间数是否超出上限，或者联系技术支持扩容。

Message string

返回状态信息。

RequestId string

请求唯一标识。

AttributeSeq int32

记录房间内所有属性（创建、修改、删除）的总变更次数，用于校准属性和计算属性变更顺序，每有一个属性发生变化时 AttributeSeq 值 + 1。

注意：当一次有多个属性变更时，AttributeSeq 值会增加多次。例如，一次修改了 3 个属性，则 AttributeSeq 值会增加 3。

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 2
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "req-123456789",
  "AttributeSeq": 2
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。