POST /sonolus/rooms/create
/sonolus/rooms/create
allows Sonolus app to create a room.
Query Parameters
None.
Request Headers
None.
Request Body
type CreateRoomRequest = {}
Response Code
Code | Description |
---|---|
200 OK | |
401 Unauthorized | Authentication required or expired. |
Response Headers
Header | Value | Description |
---|---|---|
Sonolus-Version | string | Optional, see Sonolus-Version . |
Response Body
type CreateRoomResponse = {
name: string
key: string
creates: ServerOptionsSection[]
}
name
Name of the room.
key
Server defined room key.
Examples
{
"name": "...",
"key": "...",
"creates": [
// ...
]
}
Remarks
Server should create the room immediately and reserve a spot for the room creator, or reserve the room until the room creator has finished creating.
When the room creator has finished creating, client joins the room with Sonolus-Room-Key
header containing the value of key
. Server can use the header to verify the client is the room creator, and create/configure the room based on query parameters.