聊天室创建后，可以通过获取到的聊天室地址进入聊天室。

该接口用于请求获取聊天室地址。

客户端 SDK 接口也可以获取聊天室地址，但推荐通过服务端 API 获取。

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/address

Header

请求 Header 的参数说明请参见请求 Header。

路径参数

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

查询参数

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

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

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

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "items": [
            "imtest-jd.netease.im: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