Server APIs v2

Delete a stream from a room

Update Time:2021-10-25 17:41

1 Description

Deletes a specified stream from a room. The user who published the stream remains in the room.

On the client side, the ZEGO Express SDK will trigger the following callback to notify the client of the event:

Platform ZEGO Express SDK callback
iOS/macOS onRoomStreamUpdate
Android onRoomStreamUpdate
Windows onRoomStreamUpdate
Web roomStreamUpdate

2 Request method and endpoint

  • Request method: GET
  • Request endpoint: https://rtc-api.zego.im/?Action=DeleteStream
  • Transmission protocol: HTTPS
  • Rate limit (Rooms with the same AppID): 10 requests/second (Testing environment: 1 requests/second)

3 Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Server APIs public request parameters.

Parameter Type Required Description
RoomId String Yes Room ID.
UserId String Yes User ID of the user who performs this operation.
UserName String No User name of the user who performs this operation.
StreamId String Yes Stream ID of the stream to be deleted.

4 Request example

https://rtc-api.zego.im/?Action=DeleteStream
&RoomId=123
&UserId=2323
&UserName=df
&StreamId=852
&<Public Request Parameters>

5 Response parameters

Parameter Type Description
Code Number Return code.
Message String Description of the request execution result.
RequestId String Request ID.

6 Response example

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

7 Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return code Description
50001 Room does not exist.
  • When there are no users in a room, the room will be automatically destroyed by the SDK.
  • When there is only one user in a room and the user exits or is kicked out of the room, the room will be automatically destroyed by the SDK.
  • When a room's heartbeat request times out by 100 seconds, the room will be destroyed by the SDK.
50002 User ID does not exist.
50003 Failed to get online user count.
50004 Failed to get user information.
50011 The number of recipients of the custom message has exceeded the limit.
50012 The length of the custom message has exceeded the limit.
50013 Failed to send custom message.