关闭信令频道
更新时间: 2025/08/19 14:21:51
该接口支持关闭信令房间。
如果信令房间内的用户都没有主动关闭信令房间,那么服务器默认在会 2 小时后销毁该信令房间(2 小时内没有新用户加入房间,如有,从加入后再开始计算)。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
DELETE https://{endpoint}/im/v2/signalling_room
请求 URL 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
查询参数
| 参数名称 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
channel_id |
String | 是 | "ash1jw1kw" | 信令房间 ID。 |
operator_account_id |
String | 是 | "zhangsan" | 操作者,必须为信令房间的创建者或者信令房间成员。 |
server_extension |
String | 否 | {"k":"v"} | 关闭通知的扩展字段,长度最大为 4096 个字符。 |
route_enabled |
Boolean | 否 | false | 是否抄送,false(默认):不抄送;true:抄送。 |
offline_enabled |
Boolean | 否 | false | 关闭通知是否存离线,false(默认):不存;true:存离线。 |
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
code |
Integer | 业务状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考 错误码。
| 错误码 | 错误信息 | 说明 | 处理建议 |
|---|---|---|---|
| 200 | 请求成功 | success | - |
| 414 | 参数错误 | Invalid parameter:channel_id | 检查参数是否符合命名规范 |
| 118410 | 信令服务未开通 | The signaling service is disabled. Please enable it first. | 请提前开通信令服务 |
| 118404 | 信令房间不存在 | The signaling room does not exist. | 请先创建信令房间 |
| 500 | 服务器内部错误 | internal server error | - |
此文档是否对你有帮助?




