该接口支持根据信令房间名称或房间 ID 查询信令房间信息。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/signalling_room

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

请求头参数

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

查询参数

参数名称	类型	是否必选	示例	说明
channel_id	String	否	"ash1jw1kw"	信令房间 ID。channel_id 与 channel_name 至少填一个，否则报错。若两者都填，则优先取 channel_id 的值。
channel_name	String	否	"meeting_room_001"	信令房间名称。

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	业务状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
channel_id	String	信令房间 ID，服务器生成，唯一标识符。	是
channel_name	String	信令房间名称。	是
creator_account_id	String	信令房间创建者账号 ID。	是
channel_extension	String	信令房间相关自定义扩展字段。	否
channel_type	Integer	信令房间类型，1：音频；2：视频；3：自定义。	是
create_time	Long	信令房间创建时间。	是
expire_time	Long	信令房间过期时间。	是
- member_list	Array of Objects	信令房间中的成员列表。	是
account_id	String	成员账号 ID。	是
uid	Long	成员 uid。	是
device_id	String	成员设备 ID。	否
join_time	Long	成员进入信令房间的时间。	是
expire_time	Long	成员过期时间。	是

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
    "channel_name": "abc",
    "channel_id": "ash1jw1kw",
    "creator_account_id": "zhangsan",
    "type": 1,
    "create_time": 1232222,
    "expire_time": 2222222,
    "member_list": [
        {
            "account_id": "zhangsan",
            "uid": 123,
            "create_time": 1232222,
            "expire_time": 2222222,
            "device_id": "xasasa"
        }    
    ]
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考 错误码。

错误码	错误信息	说明	处理建议
200	请求成功	success	-
414	参数错误	Invalid parameter:channel_name	检查参数是否符合命名规范
118410	信令服务未开通	The signaling service is disabled. Please enable it first.	请提前开通信令服务
118404	信令房间不存在	The signaling room does not exist.	请先创建信令房间
500	服务器内部错误	internal server error	-