This API enables you to create a new live streaming room or voice chat room on the server side. When creating a room, you can pre-configure the interaction mode, including how audience members join as guests, the room’s UI layout, and audio/video mixing strategies.
Use Cases
Showroom Live: Create a single-host room with public chat interaction.
Guest Live: Create an interactive room where audience members can apply to join as guests.
Voice Salon: Create a pure audio interactive voice chat room.
Seminar: Create a seminar room that supports multiple guests and a large audience.
Note：
If you no longer need a room after creation, call the Dismiss Room API to destroy it. If you do not actively dismiss the room, it will remain active.
Sets the number of microphone slots in the room (the value range is limited by the maximum number of slots in the package). This only applies to voice chat rooms, i.e., when SeatTemplate is set to AudioSalon or karaoke.
IsMessageDisabled
Bool
Optional
Enable global mute.
Default is false, which allows the audience to send live comments.
IsPublicVisible
Bool
Optional
Controls whether the room appears in the Live Stream List. Default is true.
Unique request ID. Provide this RequestId for troubleshooting.
RoomId
String
Room ID.
Error Codes
For general error codes (60000 to 79999), see the Error Codes, The following are API-specific error codes:
Error Code
Description
100001
Internal server error. Please retry.
100002
Invalid request parameters. Check the error description and verify your request.
100003
Room ID already exists. Please choose a different Room ID.
100007
No payment information. You need to purchase a package in the Console.
100010
Room ID already exists and Owner_Account is the same. You can use it directly.
100011
Room ID is occupied by Chat. Please use a different Room ID.
100012
Room creation exceeds frequency limit. The same Room ID can only be created once per second.
100026
Room name or other information contains sensitive content.
Usage Examples
Scenario: High-Concurrency Showroom Live
Features
Supports large audiences and stream mixing.
Allows audience members to join as guests and enables guest seats.
Public stream, visible in the Live Stream List.
Layout: Uses the standard dynamic nine-grid layout. When only the host is present, the display is full screen. When guests join, the layout switches to a dynamic grid.
Live Effect
Request Example
{
"RoomInfo":{
"RoomId":"live_testA",
"RoomType":"Live",
"Owner_Account":"testA",// Set host
"TakeSeatMode":"ApplyToTake",// Audience must call takeSeat API to apply for guest seat
"SeatTemplate":"VideoDynamicGrid9Seats",// Set layout to dynamic nine-grid for live video
"IsPublicVisible":true,// Make this stream visible in the Live Stream List
"RoomName":"Happy new year",// Set stream name for display in the Live Stream List
"CoverURL":"cover url"// Set stream cover URL for display in the Live Stream List
}
}
Scenario: Voice Chat Room
Features
Pure audio, everyone can speak freely.
Stream mixing is not required (suitable for small groups).
Public stream, visible in the Live Stream List.
Audience can freely join as guests and speak.
Supports custom guest seat count (e.g., 8, 10).
Live Effect
Request Example
{
"RoomInfo":{
"RoomId":"voice_testA",
"RoomType":"Live",
"Owner_Account":"testA",// Set host
"TakeSeatMode":"FreeToTake",// Audience can freely join as guests
"MaxSeatCount":10,// Set guest seat count to 10 (max depends on your package)
"SeatTemplate":"AudioSalon",// Set streaming template to voice chat room
"IsPublicVisible":true,// Make this stream visible in the Live Stream List
"RoomName":"Happy new year",// Set stream name for display in the Live Stream List
"CoverURL":"cover url"// Set stream cover URL for display in the Live Stream List
