在线调试

获取聊天室地址

更新时间: 2025/11/28 10:24:27

聊天室创建后,可以通过获取到的聊天室地址进入聊天室。该接口用于请求获取聊天室地址。

如果您使用的是 10.9.20+ 的安卓和 iOS NIM SDK,可以在 登录聊天室 时自动获取最优服务器地址。其他客户端 NIM SDK 接口也可以获取聊天室地址,但推荐通过服务端 API 获取。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/chatrooms/{room_id}/actions/address

请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

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

路径参数

参数名称 类型 是否必选 描述
room_id Long 需要获取地址的聊天室 ID,聊天室创建成功后,网易云信会返回聊天室 ID。

查询参数

参数名称 类型 是否必选 描述
account_id String 进入聊天室的用户账号 ID。
client_type Integer 进入聊天室的用户的客户端类型。
  • 1(默认):weblink(客户端为 Web/uni-app/HarmonyOS 端时使用)
  • 2:commonlink(客户端为非 Web/uni-app/HarmonyOS 端时使用)
  • 3:wechatlink(微信小程序使用)
client_ip String 进入聊天室的用户的客户端 IP。
网易云信服务器会根据用户 IP 的所在地区,返回合适的地址。
ip_type Integer 支持的 IP 协议类型。0(默认):IPv4;1:IPv6;2:全部支持。

响应信息

响应头参数

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

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
items Array of strings 返回的聊天室地址列表。

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "items": [
            "testchat.yunxinapi.com:8090"
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
102404 用户不存在 account not exist
113410 聊天室服务未开通 chatroom service disabled
113404 聊天室不存在 chatroom not exist
113406 聊天室已关闭 chatroom closed
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 路径参数
  • 查询参数
  • 响应信息
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码