创建信令房间

更新时间: 2025/08/19 15:37:22

网易云信服务端支持创建信令频道房间。

  • 频道与房间一一对应,可直接视为同一含义。
  • 在服务器中,频道名称存在唯一性,即相同的频道名,在服务器同时只能存在一个。
  • 频道创建后,默认的有效时间为 2 小时。
  • 频道中的人数默认上限为 100。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求信息

请求 URL

httpsPOST https://api.yunxinapi.com/nimserver/signal/createRoom.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求头参数

请求 Header 的参数说明请参考 请求 Header

请求体参数

参数名称 类型 是否必选 描述
channelName String 频道名称,应用内唯一,如不传服务器会自动生成一个,长度最大为 128 字符。
type Integer 频道类型,1:音频;2:视频;3:自定义。
房间创建后与频道类型绑定。
from String 创建者账号 ID。
ext String 频道相关自定义扩展字段,长度最大为 4096 字符。
isRoute Integer 是否抄送,0(默认):不抄送;1:抄送。

请求示例

curlcurl -X POST -H "AppKey: go9dnk49***w0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb**cc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'type=0&from=user_abc123' 'https://api.yunxinapi.com/nimserver/signal/createRoom.action'

响应示例

响应头参数

响应 Header 的参数说明请参考 响应 Header

响应体参数

参数名称 类型 说明
code Integer 状态码,200 表示请求成功。
- data Object 频道房间信息。
channelName String 频道名称。
type String 频道类型,AUDIO:音频;VEDIO:视频;CUSTOM:自定义。
channelId String 频道 ID,服务器生成,确保唯一。
channelCreateTime Long 频道创建时间。
channelExpireTime Long 频道过期时间。
creator String 频道创建者账号。
- members Array of objects 频道成员列表。
accid String 成员账号 ID。
uid String 服务器生成的成员 ID。
deviceId String 成员设备 ID。
expireTime Long 成员过期时间。
createTime Long 成员加入时间。
ext String 扩展字段。

响应体示例

JSON{
  "code": 200,
  "data": {
    "channelName": "room-123",
    "type": "VIDEO",
    "channelId": "ch_87654321",
    "channelCreateTime": 1685432800000,
    "channelExpireTime": 1685439000000,
    "creator": "user_abc123",
    "ext": "ext",
    "members": [
      {
        "accid": "user_abc123",
        "uid": "uid_98765",
        "deviceId": "device_24680",
        "expireTime": 1685439000000,
        "createTime": 1685432800000
      },
      {
        "accid": "user_def456",
        "uid": "uid_12345",
        "deviceId": "device_13579",
        "expireTime": 1685439000000,
        "createTime": 1685432800000
      }
    ]
  }
}

错误码

完整错误码请参考 错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 请求体参数
  • 请求示例
  • 响应示例
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码