API Reference
Rooms Management
Fetch Room Details

Room Management – Fetch Room Details

Retrieve complete information about a specific room including all settings and configuration.

Authentication

Include the token in the Authorization header:

Authorization: Bearer <YOUR_AUTH_TOKEN>

Endpoint

GEThttps://api.samvyo.com/api/roomSetting/:id

Replace :id with the actual room ID you want to fetch.

Required Headers

Content-Type: application/json
Authorization: Bearer <YOUR_AUTH_TOKEN>

Example Requests

JavaScript (fetch)

const roomId = '1234567890';
const res = await fetch(`https://api.samvyo.com/api/roomSetting/${roomId}`, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${authToken}`
  }
});
const data = await res.json();

cURL

curl -X GET \
  'https://api.samvyo.com/api/roomSetting/1234567890' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <YOUR_AUTH_TOKEN>'

Success Response

{
  "type": "get roomSetting by Id",
  "success": true,
  "roomSetting": {
    "room": "1234567890",
    "isStatic": true,
    "noOfModerators": 5,
    "noOfParticipants": 20,
    "noOfViewers": 0,
    "authenticationRequired": true,
    "name": "team-meeting-room",
    "roomType": "event",
    "roomPassword": "",
    "participantType": null,
    "videoStatus": "true",
    "audioStatus": "true",
    "roomStatus": "free",
    "roomOwnerId": "<USER_ID_1>,<USER_ID_2>,<USER_ID_3>",
    "createdAt": "2025-08-11T05:22:41.842Z",
    "updatedAt": "2025-08-11T05:22:41.842Z",
    "acceptIpCameras": false,
    "totalCallTime": "0",
    "enableChatOption": true,
    "enableScreenSharing": true,
    "enableLiveStreaming": false,
    "enableRecording": true,
    "enableTranscription": false,
    "recordModerator": true,
    "recordParticipant": false,
    "participantPrivacy": false,
    "recordingStrategy": "mergedAV",
    "participantVideoPrivacy": false,
    "roomAgenda": null,
    "scheduledDateTime": null,
    "enablePresenters": true,
    "noOfUpgradeRequests": 3,
    "enableRTMPStreaming": false,
    "liveStreamUrl": null,
    "liveStreamKey": null,
    "recordingFormat": "hls",
    "recordingResolutions": ["480p", "1080p", "2160p"],
    "roomPermalink": true
  }
}

Response Field Descriptions

Basic Information

  • room: Room ID (string)
  • name: Room name/identifier (string)
  • roomType: Type of room - "p2p", "conferencing", or "event" (string)
  • roomStatus: Current room status - "free", "busy", etc. (string)
  • roomPassword: Password for room access (string)

Participant Configuration

  • noOfModerators: Maximum number of moderators (number)
  • noOfParticipants: Maximum number of participants (number)
  • noOfViewers: Maximum number of viewers (number)
  • noOfUpgradeRequests: Number of upgrade requests allowed (number)
  • roomOwnerId: User ID(s) of room owner(s) (string, comma-separated)

Media Settings

  • videoStatus: Video enabled status (string)
  • audioStatus: Audio enabled status (string)
  • enableScreenSharing: Screen sharing enabled (boolean)
  • enableChatOption: Chat functionality enabled (boolean)

Recording & Advanced Features

  • enableRecording: Recording enabled (boolean)
  • recordingFormat: Recording format - "hls" or "mp4" (string)
  • recordModerator: Moderator recording enabled (boolean)
  • recordParticipant: Participant recording enabled (boolean)
  • recordingResolutions: Array of recording resolutions - ["480p", "1080p", "2160p"] (array)
  • recordingStrategy: Recording strategy - "mergedA", "mergedAV", "AmergedAV" (string)
    • mergedA: Merge audio only (without video)
    • mergedAV: Merge both audio and video
    • AmergedAV: Automatic start merged audio & video recording
  • enableTranscription: Transcription enabled (boolean)
  • enableLiveStreaming: Live streaming enabled (boolean)
  • liveStreamUrl: Live stream URL (string)
  • liveStreamKey: Live stream key (string)
  • enableRTMPStreaming: RTMP streaming enabled (boolean)

Security & Privacy

  • authenticationRequired: Authentication required to join (boolean)
  • participantPrivacy: Participant privacy enabled (boolean)
  • roomPermalink: Permanent room link enabled (boolean)

Meeting Management

  • enablePresenters: Multiple presenters allowed (boolean)
  • roomAgenda: Room agenda (string)
  • scheduledDateTime: Scheduled meeting time (string)

System Information

  • isStatic: Room persists after meetings (boolean)
  • createdAt: Room creation timestamp (string)
  • updatedAt: Last update timestamp (string)
  • totalCallTime: Total time spent in calls (string)

Notes

  • Room Status: The room status indicates whether the room is currently in use
  • Multiple Owners: roomOwnerId can contain multiple user IDs separated by commas
  • Timestamps: All timestamps are in ISO 8601 format
  • Null Values: Some fields may be null if not configured
  • Room Types:
    • "p2p": One-on-one meetings with direct peer-to-peer connections
    • "conferencing": Multi-participant meetings with centralized processing
    • "event": Large-scale events with enhanced features for broadcasting
  • Recording Strategies:
    • "mergedA": Merge audio only (without video)
    • "mergedAV": Merge both audio and video
    • "AmergedAV": Automatic start merged audio & video recording
  • Recording Resolutions: Available options include "480p", "1080p", "2160p" (4K)
Delete RoomFetch Rooms (Paginated)