openvidu/backend/openapi/components/responses/success-get-room.yaml

54 lines
2.1 KiB
YAML

description: Success response for retrieving a room
content:
application/json:
schema:
$ref: '../schemas/meet-room.yaml'
examples:
complete_room_details:
summary: Full room details response
value:
roomId: 'room-123'
roomName: 'room'
creationDate: 1620000000000
autoDeletionDate: 1900000000000
autoDeletionPolicy:
withMeeting: when_meeting_ends
withRecordings: close
config:
chat:
enabled: true
recording:
enabled: false
virtualBackground:
enabled: true
moderatorUrl: 'http://localhost:6080/room/room-123?secret=123456'
speakerUrl: 'http://localhost:6080/room/room-123?secret=654321'
status: open
meetingEndAction: none
fields=roomId:
summary: Response with only the roomId
value:
roomId: 'room-123'
fields=roomId,roomName,creationDate,autoDeletionDate,config:
summary: Room details with roomId, roomName, creationDate, autoDeletionDate, and config
value:
roomId: 'room-123'
roomName: 'room'
creationDate: 1620000000000
autoDeletionDate: 1900000000000
config:
chat:
enabled: true
recording:
enabled: false
virtualBackground:
enabled: true
fields=moderatorUrl,speakerUrl:
summary: Response containing only moderator and speaker URLs
value:
moderatorUrl: 'http://localhost:6080/room/room-123?secret=123456'
speakerUrl: 'http://localhost:6080/room/room-123?secret=654321'