API ReferenceRoomsCreate_quick_audio_room
Create quick audio room
Creates a quick audio room within your project. Requires HMAC SHA256 signature and `key` header.
Creates a quick audio room within your project. Requires HMAC SHA256 signature and `key` header.
In: header
HMAC SHA256 (Base64-encoded) signature of the request. Generate this using your API key and the request parameters (room_id). The server validates this signature to verify authenticity.
In: header
application/json
application/json
application/json
application/json
curl -X POST "https://v.cloudapi.vconnct.me/api/v4/rooms/create_quick_audio_room" \ -H "Content-Type: application/json" \ -d '{ "type": "object", "required": [ "project_id", "client_room_id" ], "properties": { "project_id": { "type": "string" }, "name": { "type": "string" }, "client_room_id": { "type": "string" }, "moderator_id": { "type": "string" }, "max_participants": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "empty_timeout": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "metadata": { "type": "object", "properties": { "room_title": { "type": "string" }, "welcome_message": { "type": "string" } } } }, "examples": [ { "project_id": "{{projectId}}", "name": "hisham", "client_room_id": "daszc1s333xsw", "moderator_id": "hisham", "max_participants": "20", "empty_timeout": "300", "metadata": { "room_title": "Test room", "welcome_message": "Welcome to room" } } ] }'{
"room_id": "room123",
"name": "hisham",
"client_room_id": "daszc1s333xsw",
"moderator_id": "hisham",
"max_participants": 20,
"empty_timeout": 300,
"metadata": {
"room_title": "Test room",
"welcome_message": "Welcome to room"
}
}{
"room_id": "573c6b4f-f14d-43b9-a15d-906cef04405f",
"final_link": "https://lk-vcloud-dev.dragonteam.dev/?token=<token>",
"status": true
}{
"message": "Client room ID already exists",
"status": false
}{
"error": "Invalid or missing api_key"
}curl -X POST "https://v.cloudapi.vconnct.me/api/v4/rooms/create_quick_audio_room" \
-H "Content-Type: application/json" \
-d '{
"type": "object",
"required": [
"project_id",
"client_room_id"
],
"properties": {
"project_id": {
"type": "string"
},
"name": {
"type": "string"
},
"client_room_id": {
"type": "string"
},
"moderator_id": {
"type": "string"
},
"max_participants": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"empty_timeout": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"metadata": {
"type": "object",
"properties": {
"room_title": {
"type": "string"
},
"welcome_message": {
"type": "string"
}
}
}
},
"examples": [
{
"project_id": "{{projectId}}",
"name": "hisham",
"client_room_id": "daszc1s333xsw",
"moderator_id": "hisham",
"max_participants": "20",
"empty_timeout": "300",
"metadata": {
"room_title": "Test room",
"welcome_message": "Welcome to room"
}
}
]
}'