Events

Here you can find the list of call events are sent to servers (Webhook, SQS and SNS) and clients (WebSocket).

Event groups

Call events

Name	Description	Availability
`call.blocked_user`	This event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. If the user is the current user, the client should leave the call screen as well	client-side, server-side
`call.created`	This event is sent when a call is created. Clients receiving this event should check if the ringing field is set to true and if so, show the call screen	client-side, server-side
`call.deleted`	This event is sent when a call is deleted. Clients receiving this event should leave the call screen	client-side, server-side
`call.ended`	This event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen	client-side, server-side
`call.frame_recording_ready`	This event is sent when a frame is captured from a call	server-side
`call.member_added`	This event is sent when one or more members are added to a call	client-side, server-side
`call.member_removed`	This event is sent when one or more members are removed from a call	client-side, server-side
`call.member_updated`	This event is sent when one or more members are updated	client-side, server-side
`call.member_updated_permission`	This event is sent when one or more members get its role updated	client-side, server-side
`call.permission_request`	This event is sent when a user requests access to a feature on a call, clients receiving this event should display a permission request to the user	client-side, server-side
`call.permissions_updated`	This event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly	client-side, server-side
`call.reaction_new`	This event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen	client-side, server-side
`call.unblocked_user`	This event is sent when a user is unblocked on a call, this can be useful to notify the user that they can now join the call again	client-side, server-side
`call.updated`	This event is sent when a call is updated, clients should use this update the local state of the call. This event also contains the capabilities by role for the call, clients should update the own_capability for the current.	client-side, server-side
`call.user_muted`	This event is sent when a call member is muted	client-side, server-side

Session events

Name	Description	Availability
`call.session_ended`	This event is sent when a call session ends	client-side, server-side
`call.session_participant_joined`	This event is sent when a participant joins a call session	client-side, server-side
`call.session_participant_left`	This event is sent when a participant leaves a call session	client-side, server-side
`call.session_started`	This event is sent when a call session starts	client-side, server-side

Ring events

Name	Description	Availability
`call.accepted`	This event is sent when a user accepts a notification to join a call.	client-side, server-side
`call.missed`	This event is sent to call members who did not accept/reject/join the call to notify they missed the call	client-side, server-side
`call.notification`	This event is sent to all call members to notify they are getting called	client-side, server-side
`call.rejected`	This event is sent when a user rejects a notification to join a call.	client-side, server-side
`call.ring`	This event is sent to all call members to notify they are getting called	client-side, server-side

Streaming events

Name	Description	Availability
`call.hls_broadcasting_failed`	This event is sent when HLS broadcasting has failed	client-side, server-side
`call.hls_broadcasting_started`	This event is sent when HLS broadcasting has started	client-side, server-side
`call.hls_broadcasting_stopped`	This event is sent when HLS broadcasting has stopped	client-side, server-side
`call.live_started`	This event is sent when a call is started. Clients receiving this event should start the call.	client-side, server-side
`call.rtmp_broadcast_failed`	This event is sent when a call RTMP broadcast has failed	client-side, server-side
`call.rtmp_broadcast_started`	This event is sent when RTMP broadcast has started	client-side, server-side
`call.rtmp_broadcast_stopped`	This event is sent when RTMP broadcast has stopped	client-side, server-side

Recording events

Name	Description	Availability
`call.frame_recording_failed`	This event is sent when frame recording has failed	server-side
`call.frame_recording_started`	This event is sent when frame recording has started	server-side
`call.frame_recording_stopped`	This event is sent when frame recording has stopped	server-side
`call.recording_failed`	This event is sent when call recording has failed	client-side, server-side
`call.recording_ready`	This event is sent when call recording is ready	client-side, server-side
`call.recording_started`	This event is sent when call recording has started	client-side, server-side
`call.recording_stopped`	This event is sent when call recording has stopped	client-side, server-side

Transcription and closed caption events

Name	Description	Availability
`call.closed_caption`	This event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen	client-side, server-side
`call.closed_captions_failed`	This event is sent when call closed captions has failed	client-side, server-side
`call.closed_captions_started`	This event is sent when call closed caption has started	client-side, server-side
`call.closed_captions_stopped`	This event is sent when call closed captions has stopped	client-side, server-side
`call.transcription_failed`	This event is sent when call transcription has failed	client-side, server-side
`call.transcription_ready`	This event is sent when call transcription is ready	client-side, server-side
`call.transcription_started`	This event is sent when call transcription has started	client-side, server-side
`call.transcription_stopped`	This event is sent when call transcription has stopped	client-side, server-side

Other events

Name	Description	Availability
`custom`	A custom event, this event is used to send custom events to other participants in the call.	client-side, server-side

Event model defintions

BlockedUserEvent

Name	Type	Description	Constraints
`blocked_by_user`	`UserResponse`	The user that blocked the user, null if the user was blocked by server-side	-
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.blocked_user" in this case	Required
`user`	`UserResponse`	The user that was blocked	Required

CallAcceptedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	-	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.accepted" in this case	Required
`user`	`UserResponse`	The user who accepted the call	Required

CallClosedCaptionsFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.closed_captions_failed" in this case	Required

CallClosedCaptionsStartedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.closed_captions_started" in this case	Required

CallClosedCaptionsStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.transcription_stopped" in this case	Required

CallCreatedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	the members added to this call	Required
`type`	`string`	The type of event: "call.created" in this case	Required

CallDeletedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.deleted" in this case	Required

CallEndedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	-	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.ended" in this case	Required
`user`	`UserResponse`	The user who ended the call, null if the call was ended by the server	-

CallFrameRecordingFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.frame_recording_failed" in this case	Required

CallFrameRecordingFrameReadyEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`captured_at`	`string`	The time the frame was captured	Required
`created_at`	`string`	-	Required
`session_id`	`string`	Call session ID	Required
`track_type`	`string`	The type of the track frame was captured from (TRACK_TYPE_VIDEO\|TRACK_TYPE_SCREEN_SHARE)	Required
`type`	`string`	The type of event: "call.frame_recording_ready" in this case	Required
`url`	`string`	The URL of the frame	Required
`users`	`object`	The users in the frame	Required

CallFrameRecordingStartedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.frame_recording_started" in this case	Required

CallFrameRecordingStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.frame_recording_stopped" in this case	Required

CallHLSBroadcastingFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.hls_broadcasting_failed" in this case	Required

CallHLSBroadcastingStartedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	-	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`hls_playlist_url`	`string`	-	Required
`type`	`string`	The type of event: "call.hls_broadcasting_started" in this case	Required

CallHLSBroadcastingStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.hls_broadcasting_stopped" in this case	Required

CallLiveStartedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.live_started" in this case	Required

CallMemberAddedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	the members added to this call	Required
`type`	`string`	The type of event: "call.member_added" in this case	Required

CallMemberRemovedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`string[]`	the list of member IDs removed from the call	Required
`type`	`string`	The type of event: "call.member_removed" in this case	Required

CallMemberUpdatedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	The list of members that were updated	Required
`type`	`string`	The type of event: "call.member_updated" in this case	Required

CallMemberUpdatedPermissionEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`capabilities_by_role`	`object`	The capabilities by role for this call	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	The list of members that were updated	Required
`type`	`string`	The type of event: "call.member_added" in this case	Required

CallMissedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	List of members who missed the call	Required
`notify_user`	`boolean`	-	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.notification" in this case	Required
`user`	`UserResponse`	The caller from whom the call was missed	Required

CallNotificationEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	Call members	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.notification" in this case	Required
`user`	`UserResponse`	The user that sent the call notification	Required

CallReactionEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`reaction`	`ReactionResponse`	the reaction object sent by the user on the call	Required
`type`	`string`	The type of event: "call.reaction_new" in this case	Required

CallRecordingFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.recording_failed" in this case	Required

CallRecordingReadyEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`call_recording`	`CallRecording`	The call recording object	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.recording_ready" in this case	Required

CallRecordingStartedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.recording_started" in this case	Required

CallRecordingStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.recording_stopped" in this case	Required

CallRejectedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	-	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`reason`	`string`	-	-
`type`	`string`	The type of event: "call.rejected" in this case	Required
`user`	`UserResponse`	The user who rejected the call	Required

CallRingEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`members`	`MemberResponse[]`	Call members	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.notification" in this case	Required
`user`	`UserResponse`	The user that sent the call notification	Required
`video`	`boolean`	-	Required

CallRtmpBroadcastFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	The unique identifier for a call (<type>:<id>)	Required
`created_at`	`string`	Date/time of creation	Required
`name`	`string`	Name of the given RTMP broadcast	Required
`type`	`string`	The type of event: "call.rtmp_broadcast_failed" in this case	Required

CallRtmpBroadcastStartedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	The unique identifier for a call (<type>:<id>)	Required
`created_at`	`string`	Date/time of creation	Required
`name`	`string`	Name of the given RTMP broadcast	Required
`type`	`string`	The type of event: "call.rtmp_broadcast_started" in this case	Required

CallRtmpBroadcastStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	The unique identifier for a call (<type>:<id>)	Required
`created_at`	`string`	Date/time of creation	Required
`name`	`string`	Name of the given RTMP broadcast	Required
`type`	`string`	The type of event: "call.rtmp_broadcast_stopped" in this case	Required

CallSessionEndedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.session_ended" in this case	Required

CallSessionParticipantJoinedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`participant`	`CallParticipantResponse`	The participant that joined the session	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.session_participant_joined" in this case	Required

CallSessionParticipantLeftEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`duration_seconds`	`integer`	The duration participant was in the session in seconds	Required
`participant`	`CallParticipantResponse`	The participant that left the session	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.session_participant_left" in this case	Required

CallSessionStartedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`session_id`	`string`	Call session ID	Required
`type`	`string`	The type of event: "call.session_started" in this case	Required

CallTranscriptionFailedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.transcription_failed" in this case	Required

CallTranscriptionReadyEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`call_transcription`	`CallTranscription`	The call transcription object	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.transcription_ready" in this case	Required

CallTranscriptionStartedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.transcription_started" in this case	Required

CallTranscriptionStoppedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`egress_id`	`string`	-	Required
`type`	`string`	The type of event: "call.transcription_stopped" in this case	Required

CallUpdatedEvent

Name	Type	Description	Constraints
`call`	`CallResponse`	Call object	Required
`call_cid`	`string`	-	Required
`capabilities_by_role`	`object`	The capabilities by role for this call	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.ended" in this case	Required

CallUserMutedEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`from_user_id`	`string`	-	Required
`muted_user_ids`	`string[]`	-	Required
`type`	`string`	The type of event: "call.user_muted" in this case	Required

ClosedCaptionEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`closed_caption`	`CallClosedCaption`	The closed caption object	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.closed_caption" in this case	Required

CustomVideoEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`custom`	`object`	Custom data for this object	Required
`type`	`string`	The type of event, "custom" in this case	Required
`user`	`UserResponse`	-	Required

PermissionRequestEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`permissions`	`string[]`	The list of permissions requested by the user	Required
`type`	`string`	The type of event: "call.permission_request" in this case	Required
`user`	`UserResponse`	The user who sent the permission request	Required

UnblockedUserEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`type`	`string`	The type of event: "call.unblocked_user" in this case	Required
`user`	`UserResponse`	The user that was unblocked	Required

UpdatedCallPermissionsEvent

Name	Type	Description	Constraints
`call_cid`	`string`	-	Required
`created_at`	`string`	-	Required
`own_capabilities`	`OwnCapability[]`	The capabilities of the current user	Required
`type`	`string`	The type of event: "call.permissions_updated" in this case	Required
`user`	`UserResponse`	The user who received the new permissions	Required

AudioSettingsResponse

Name	Type	Description	Constraints
`access_request_enabled`	`boolean`	-	Required
`default_device`	`string (speaker, earpiece)`	-	Required
`mic_default_on`	`boolean`	-	Required
`noise_cancellation`	`NoiseCancellationSettings`	-	-
`opus_dtx_enabled`	`boolean`	-	Required
`redundant_coding_enabled`	`boolean`	-	Required
`speaker_default_on`	`boolean`	-	Required

BackstageSettingsResponse

Name	Type	Description	Constraints
`enabled`	`boolean`	-	Required
`join_ahead_time_seconds`	`integer`	-	-

BroadcastSettingsResponse

Name	Type	Description	Constraints
`enabled`	`boolean`	-	Required
`hls`	`HLSSettingsResponse`	-	Required
`rtmp`	`RTMPSettingsResponse`	-	Required

CallClosedCaption

Name	Type	Description	Constraints
`end_time`	`string`	-	Required
`speaker_id`	`string`	-	Required
`start_time`	`string`	-	Required
`text`	`string`	-	Required
`user`	`UserResponse`	-	Required

CallIngressResponse

Name	Type	Description	Constraints
`rtmp`	`RTMPIngress`	-	Required

CallParticipantResponse

Name	Type	Description	Constraints
`joined_at`	`string`	-	Required
`role`	`string`	-	Required
`user`	`UserResponse`	-	Required
`user_session_id`	`string`	-	Required

CallRecording

Name	Type	Description	Constraints
`end_time`	`string`	-	Required
`filename`	`string`	-	Required
`start_time`	`string`	-	Required
`url`	`string`	-	Required

CallResponse

Name	Type	Description	Constraints
`backstage`	`boolean`	-	Required
`blocked_user_ids`	`string[]`	-	Required
`captioning`	`boolean`	-	Required
`cid`	`string`	The unique identifier for a call (<type>:<id>)	Required
`created_at`	`string`	Date/time of creation	Required
`created_by`	`UserResponse`	The user that created the call	Required
`current_session_id`	`string`	-	Required
`custom`	`object`	Custom data for this object	Required
`egress`	`EgressResponse`	-	Required
`ended_at`	`string`	Date/time when the call ended	-
`id`	`string`	Call ID	Required
`ingress`	`CallIngressResponse`	-	Required
`join_ahead_time_seconds`	`integer`	-	-
`recording`	`boolean`	-	Required
`session`	`CallSessionResponse`	-	-
`settings`	`CallSettingsResponse`	-	Required
`starts_at`	`string`	Date/time when the call will start	-
`team`	`string`	-	-
`thumbnails`	`ThumbnailResponse`	-	-
`transcribing`	`boolean`	-	Required
`type`	`string`	The type of call	Required
`updated_at`	`string`	Date/time of the last update	Required

CallSessionResponse

Name	Type	Description	Constraints
`accepted_by`	`object`	-	Required
`anonymous_participant_count`	`integer`	-	Required
`ended_at`	`string`	-	-
`id`	`string`	-	Required
`live_ended_at`	`string`	-	-
`live_started_at`	`string`	-	-
`missed_by`	`object`	-	Required
`participants`	`CallParticipantResponse[]`	-	Required
`participants_count_by_role`	`object`	-	Required
`rejected_by`	`object`	-	Required
`started_at`	`string`	-	-
`timer_ends_at`	`string`	-	-

CallSettingsResponse

Name	Type	Description	Constraints
`audio`	`AudioSettingsResponse`	-	Required
`backstage`	`BackstageSettingsResponse`	-	Required
`broadcasting`	`BroadcastSettingsResponse`	-	Required
`frame_recording`	`FrameRecordingSettingsResponse`	-	Required
`geofencing`	`GeofenceSettingsResponse`	-	Required
`limits`	`LimitsSettingsResponse`	-	Required
`recording`	`RecordSettingsResponse`	-	Required
`ring`	`RingSettingsResponse`	-	Required
`screensharing`	`ScreensharingSettingsResponse`	-	Required
`session`	`SessionSettingsResponse`	-	Required
`thumbnails`	`ThumbnailsSettingsResponse`	-	Required
`transcription`	`TranscriptionSettingsResponse`	-	Required
`video`	`VideoSettingsResponse`	-	Required

CallTranscription

Name	Type	Description	Constraints
`end_time`	`string`	-	Required
`filename`	`string`	-	Required
`start_time`	`string`	-	Required
`url`	`string`	-	Required

DeviceResponse

Name	Type	Description	Constraints
`created_at`	`string`	Date/time of creation	Required
`disabled`	`boolean`	Whether device is disabled or not	-
`disabled_reason`	`string`	Reason explaining why device had been disabled	-
`id`	`string`	Device ID	Required
`push_provider`	`string`	Push provider	Required
`push_provider_name`	`string`	Push provider name	-
`user_id`	`string`	User ID	Required
`voip`	`boolean`	When true the token is for Apple VoIP push notifications	-

EgressHLSResponse

Name	Type	Description	Constraints
`playlist_url`	`string`	-	Required
`status`	`string`	-	Required

EgressResponse

Name	Type	Description	Constraints
`broadcasting`	`boolean`	-	Required
`hls`	`EgressHLSResponse`	-	-
`rtmps`	`EgressRTMPResponse[]`	-	Required

EgressRTMPResponse

Name	Type	Description	Constraints
`name`	`string`	-	Required
`started_at`	`string`	-	Required
`stream_key`	`string`	-	-
`stream_url`	`string`	-	-

FrameRecordingSettingsResponse

Name	Type	Description	Constraints
`capture_interval_in_seconds`	`integer`	-	Required, Minimum: 2, Maximum: 60
`mode`	`string (available, disabled, auto-on)`	-	Required
`quality`	`string`	-	-

GeofenceSettingsResponse

Name	Type	Description	Constraints
`names`	`string[]`	-	Required

HLSSettingsResponse

Name	Type	Description	Constraints
`auto_on`	`boolean`	-	Required
`enabled`	`boolean`	-	Required
`layout`	`LayoutSettingsResponse`	-	Required
`quality_tracks`	`string[]`	-	Required

LayoutSettingsResponse

Name	Type	Description	Constraints
`detect_orientation`	`boolean`	-	-
`external_app_url`	`string`	-	Required
`external_css_url`	`string`	-	Required
`name`	`string (spotlight, grid, single-participant, mobile, custom)`	-	Required
`options`	`object`	-	-

LimitsSettingsResponse

Name	Type	Description	Constraints
`max_duration_seconds`	`integer`	-	-
`max_participants`	`integer`	-	-

MemberResponse

Name	Type	Description	Constraints
`created_at`	`string`	Date/time of creation	Required
`custom`	`object`	Custom member response data	Required
`deleted_at`	`string`	Date/time of deletion	-
`role`	`string`	-	-
`updated_at`	`string`	Date/time of the last update	Required
`user`	`UserResponse`	-	Required
`user_id`	`string`	-	Required

NoiseCancellationSettings

Name	Type	Description	Constraints
`mode`	`string (available, disabled, auto-on)`	-	Required

PushNotificationSettingsResponse

Name	Type	Description	Constraints
`disabled`	`boolean`	-	-
`disabled_until`	`string`	-	-

ReactionResponse

Name	Type	Description	Constraints
`custom`	`object`	-	-
`emoji_code`	`string`	-	-
`type`	`string`	-	Required
`user`	`UserResponse`	-	Required

RecordSettingsResponse

Name	Type	Description	Constraints
`audio_only`	`boolean`	-	Required
`layout`	`LayoutSettingsResponse`	-	Required
`mode`	`string`	-	Required
`quality`	`string`	-	Required

RingSettingsResponse

Name	Type	Description	Constraints
`auto_cancel_timeout_ms`	`integer`	-	Required
`incoming_call_timeout_ms`	`integer`	-	Required
`missed_call_timeout_ms`	`integer`	-	Required

RTMPIngress

Name	Type	Description	Constraints
`address`	`string`	-	Required

RTMPSettingsResponse

Name	Type	Description	Constraints
`enabled`	`boolean`	-	Required
`layout`	`LayoutSettingsResponse`	-	Required
`quality`	`string`	-	Required

ScreensharingSettingsResponse

Name	Type	Description	Constraints
`access_request_enabled`	`boolean`	-	Required
`enabled`	`boolean`	-	Required
`target_resolution`	`TargetResolution`	-	-

SessionSettingsResponse

Name	Type	Description	Constraints
`inactivity_timeout_seconds`	`integer`	-	Required, Minimum: 5, Maximum: 900

TargetResolution

Name	Type	Description	Constraints
`bitrate`	`integer`	-	Maximum: 6000000
`height`	`integer`	-	Required, Minimum: 240, Maximum: 3840
`width`	`integer`	-	Required, Minimum: 240, Maximum: 3840

ThumbnailResponse

Name	Type	Description	Constraints
`image_url`	`string`	-	Required

ThumbnailsSettingsResponse

Name	Type	Description	Constraints
`enabled`	`boolean`	-	Required

TranscriptionSettingsResponse

Name	Type	Description	Constraints
`closed_caption_mode`	`string (available, disabled, auto-on)`	-	Required
`language`	`string (auto, en, fr, es, de, it, nl, pt, pl, ca, cs, da, el, fi, id, ja, ru, sv, ta, th, tr, hu, ro, zh, ar, tl, he, hi, hr, ko, ms, no, uk)`	-	Required
`mode`	`string (available, disabled, auto-on)`	-	Required

UserResponse

Name	Type	Description	Constraints
`ban_expires`	`string`	Date when ban expires	-
`blocked_user_ids`	`string[]`	-	Required
`created_at`	`string`	Date/time of creation	Required
`custom`	`object`	Custom data for this object	Required
`deactivated_at`	`string`	Date of deactivation	-
`deleted_at`	`string`	Date/time of deletion	-
`devices`	`DeviceResponse[]`	List of devices user is using	-
`id`	`string`	Unique user identifier	Required
`image`	`string`	-	-
`invisible`	`boolean`	-	Required
`language`	`string`	Preferred language of a user	Required
`last_active`	`string`	Date of last activity	-
`name`	`string`	Optional name of user	-
`privacy_settings`	`PrivacySettingsResponse`	User privacy settings	-
`push_notifications`	`PushNotificationSettingsResponse`	User push notification settings	-
`revoke_tokens_issued_before`	`string`	Revocation date for tokens	-
`role`	`string`	Determines the set of user permissions	Required
`shadow_banned`	`boolean`	Whether a user is shadow banned	Required
`teams`	`string[]`	List of teams user is a part of	Required
`updated_at`	`string`	Date/time of the last update	Required

VideoSettingsResponse

Name	Type	Description	Constraints
`access_request_enabled`	`boolean`	-	Required
`camera_default_on`	`boolean`	-	Required
`camera_facing`	`string (front, back, external)`	-	Required
`enabled`	`boolean`	-	Required
`target_resolution`	`TargetResolution`	-	Required

Overview

SQS and SNS

On this page:

Event groups
Event model defintions