Skip to main content
requestAccess({ access?, name }) Requests full access to a call when the participant is currently in the lobby. Causes the participant to appear in the meeting admins’ waitingParticipants() set, triggering a waiting-participant-added event for admins. Calling requestAccess() again with a new name updates the participant’s entry in waitingParticipants(), triggering waiting-participant-updated.
Currently, the only valid request is { level: 'full' }, and it can only be made from { level: 'lobby' }. If access is denied, the response will show { level: 'lobby' } but the participant will be immediately ejected with an error event.

Parameters

access
object
Optional. The access level to request. Currently must be { level: 'full' } if provided.
name
string
required
The participant’s display name shown to the meeting admins in the waiting room.

Return value

Returns Promise<{ access: DailyAccess, granted: boolean }>:
access
DailyAccess
The new access level: { level: 'none' | 'lobby' | 'full' }.
granted
boolean
Whether the access request was granted.

Example

const { granted } = await call.requestAccess({
  access: { level: 'full' },
  name: 'Jane Smith',
});

if (granted) {
  console.log('Access granted — joining call');
} else {
  console.log('Access denied');
}

See also