文档中心
实时音视频
服务端 API
房间信令接口
删除房间流

删除房间流

更新时间：2024-04-01 17:40

1 描述

调用本接口删除某个房间的指定流，与踢出房间用户不同的是，这路流对应的用户是仍在房间内的。可通过本接口强制“下麦”某个用户，或者在“一起看”场景里删掉增加的 CDN 直播流。

本接口仅用于抛出房间内流删除的相关通知，不会执行实际的停止推流操作。开发者需要从自己的客户端，调用 stopPublishingStream 接口停止推流，才会停止向流媒体传输音视频数据；相应的拉流端，需要调用客户端 stopPlayingStream 接口停止拉流，才会停止从流媒体接收音视频数据。

客户端接收房间内流减少的通知使用 ZEGO SDK 回调接口：

	ZegoExpress SDK	LiveRoom SDK
iOS/macOS	onRoomStreamUpdate	onStreamUpdated
Android	onRoomStreamUpdate	onStreamUpdated
Windows	onRoomStreamUpdate	OnStreamUpdated
Web	roomStreamUpdate	onStreamUpdated

2 接口原型

请求方法：GET
请求地址：https://rtc-api.zego.im/?Action=DeleteStream
传输协议：HTTPS
调用频率限制（同一个 AppID 下所有房间）：10 次/秒（测试环境：1 次/秒）

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
RoomId	String	是	房间 ID。
UserId	String	是	用户 ID。
UserName	String	否	用户名。
StreamId	String	是	流 ID。

调用本服务端接口时：

不建议使用与房间内实际用户相同的 UserId，避免与客户端 SDK 的流删除行为产生冲突。可以使用特定的名称标识为服务端行为，例如：userId = “Server-Administrator”。
如果使用了与房间内实际用户相同的 UserId（不建议）时，相应操作人 UserId 的客户端不会收到本服务端接口触发的流删除回调，房间内的其他用户会收到流删除回调。

4 请求示例

https://rtc-api.zego.im/?Action=DeleteStream
&RoomId=room1
&UserId=user1
&UserName=userName
&StreamId=streamId1    
&<公共请求参数>

5 响应参数

参数	类型	描述
Code	Int32	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID。

6 响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"5885338326725063742"
}

7 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
124	删除流信息失败。	请重试，或联系 ZEGO 技术支持处理。
138	流信息不存在。	请重试，或联系 ZEGO 技术支持处理。