Method Detail

• queryCallMembers

   abstract QueryCallMembersResponse queryCallMembers(@Body() QueryCallMembersRequest queryCallMembersRequest)

  Query call members Query call members with filter query

• queryCallStats

   abstract QueryCallStatsResponse queryCallStats(@Body() QueryCallStatsRequest queryCallStatsRequest)

  Query Call Stats

• queryCallStats

   abstract QueryCallStatsResponse queryCallStats()

  Query Call Stats

• getCall

   abstract GetCallResponse getCall(@Path(value = type) String type, @Path(value = id) String id, @Query(value = connection_id) String connectionId, @Query(value = members_limit) Integer membersLimit, @Query(value = ring) Boolean ring, @Query(value = notify) Boolean notify, @Query(value = video) Boolean video)

  Get Call

• updateCall

   abstract UpdateCallResponse updateCall(@Path(value = type) String type, @Path(value = id) String id, @Body() UpdateCallRequest updateCallRequest)

  Update Call

• updateCall

   abstract UpdateCallResponse updateCall(@Path(value = type) String type, @Path(value = id) String id)

  Update Call

• getOrCreateCall

   abstract GetOrCreateCallResponse getOrCreateCall(@Path(value = type) String type, @Path(value = id) String id, @Query(value = connection_id) String connectionId, @Body() GetOrCreateCallRequest getOrCreateCallRequest)

  Get or create a call Gets or creates a new call

• getOrCreateCall

   abstract GetOrCreateCallResponse getOrCreateCall(@Path(value = type) String type, @Path(value = id) String id, @Query(value = connection_id) String connectionId)

  Get or create a call Gets or creates a new call

• acceptCall

   abstract AcceptCallResponse acceptCall(@Path(value = type) String type, @Path(value = id) String id)

  Accept Call

• blockUser

   abstract BlockUserResponse blockUser(@Path(value = type) String type, @Path(value = id) String id, @Body() BlockUserRequest blockUserRequest)

  Block user on a call Block a user, preventing them from joining the call until they are unblocked.

• deleteCall

   abstract DeleteCallResponse deleteCall(@Path(value = type) String type, @Path(value = id) String id, @Body() DeleteCallRequest deleteCallRequest)

  Delete Call

• deleteCall

   abstract DeleteCallResponse deleteCall(@Path(value = type) String type, @Path(value = id) String id)

  Delete Call

• sendCallEvent

   abstract SendCallEventResponse sendCallEvent(@Path(value = type) String type, @Path(value = id) String id, @Body() SendCallEventRequest sendCallEventRequest)

  Send custom event Sends custom event to the call

• sendCallEvent

   abstract SendCallEventResponse sendCallEvent(@Path(value = type) String type, @Path(value = id) String id)

  Send custom event Sends custom event to the call

• collectUserFeedback

   abstract CollectUserFeedbackResponse collectUserFeedback(@Path(value = type) String type, @Path(value = id) String id, @Body() CollectUserFeedbackRequest collectUserFeedbackRequest)

  Collect user feedback

• goLive

   abstract GoLiveResponse goLive(@Path(value = type) String type, @Path(value = id) String id, @Body() GoLiveRequest goLiveRequest)

  Set call as live

• goLive

   abstract GoLiveResponse goLive(@Path(value = type) String type, @Path(value = id) String id)

  Set call as live

• joinCall

   abstract JoinCallResponse joinCall(@Path(value = type) String type, @Path(value = id) String id, @Query(value = connection_id) String connectionId, @Body() JoinCallRequest joinCallRequest)

  Join call Request to join a call

• kickUser

   abstract KickUserResponse kickUser(@Path(value = type) String type, @Path(value = id) String id, @Body() KickUserRequest kickUserRequest)

  Kick user from a call Kicks a user from the call. Optionally block the user from rejoining by setting block=true.

• endCall

   abstract EndCallResponse endCall(@Path(value = type) String type, @Path(value = id) String id)

  End call

• updateCallMembers

   abstract UpdateCallMembersResponse updateCallMembers(@Path(value = type) String type, @Path(value = id) String id, @Body() UpdateCallMembersRequest updateCallMembersRequest)

  Update Call Member

• updateCallMembers

   abstract UpdateCallMembersResponse updateCallMembers(@Path(value = type) String type, @Path(value = id) String id)

  Update Call Member

• muteUsers

   abstract MuteUsersResponse muteUsers(@Path(value = type) String type, @Path(value = id) String id, @Body() MuteUsersRequest muteUsersRequest)

  Mute users Mutes users in a call

• muteUsers

   abstract MuteUsersResponse muteUsers(@Path(value = type) String type, @Path(value = id) String id)

  Mute users Mutes users in a call

• queryCallParticipants

   abstract QueryCallParticipantsResponse queryCallParticipants(@Path(value = id) String id, @Path(value = type) String type, @Query(value = limit) Integer limit, @Body() QueryCallParticipantsRequest queryCallParticipantsRequest)

  Query call participants Returns a list of participants connected to the call

• queryCallParticipants

   abstract QueryCallParticipantsResponse queryCallParticipants(@Path(value = id) String id, @Path(value = type) String type, @Query(value = limit) Integer limit)

  Query call participants Returns a list of participants connected to the call

• videoPin

   abstract PinResponse videoPin(@Path(value = type) String type, @Path(value = id) String id, @Body() PinRequest pinRequest)

  Pin Pins a track for all users in the call.

• sendVideoReaction

   abstract SendReactionResponse sendVideoReaction(@Path(value = type) String type, @Path(value = id) String id, @Body() SendReactionRequest sendReactionRequest)

  Send reaction to the call Sends reaction to the call

• listRecordings

   abstract ListRecordingsResponse listRecordings(@Path(value = type) String type, @Path(value = id) String id)

  List recordings Lists recordings

• startRecording

   abstract StartRecordingResponse startRecording(@Path(value = type) String type, @Path(value = id) String id, @Path(value = recording_type) String recordingType, @Body() StartRecordingRequest startRecordingRequest)

  Start recording Starts recording

• startRecording

   abstract StartRecordingResponse startRecording(@Path(value = type) String type, @Path(value = id) String id, @Path(value = recording_type) String recordingType)

  Start recording Starts recording

• stopRecording

   abstract StopRecordingResponse stopRecording(@Path(value = type) String type, @Path(value = id) String id, @Path(value = recording_type) String recordingType)

  Stop recording Stops recording

• rejectCall

   abstract RejectCallResponse rejectCall(@Path(value = type) String type, @Path(value = id) String id, @Body() RejectCallRequest rejectCallRequest)

  Reject Call

• rejectCall

   abstract RejectCallResponse rejectCall(@Path(value = type) String type, @Path(value = id) String id)

  Reject Call

• getCallReport

   abstract GetCallReportResponse getCallReport(@Path(value = type) String type, @Path(value = id) String id, @Query(value = session_id) String sessionId)

  Get call report

• requestPermission

   abstract RequestPermissionResponse requestPermission(@Path(value = type) String type, @Path(value = id) String id, @Body() RequestPermissionRequest requestPermissionRequest)

  Request permission Request permission to perform an action

• ringCall

   abstract RingCallResponse ringCall(@Path(value = type) String type, @Path(value = id) String id, @Body() RingCallRequest ringCallRequest)

  Ring Call Users Sends a ring notification to the provided users who are not already in the call. All users should be members of the call

• ringCall

   abstract RingCallResponse ringCall(@Path(value = type) String type, @Path(value = id) String id)

  Ring Call Users Sends a ring notification to the provided users who are not already in the call. All users should be members of the call

• getCallRingState

   abstract GetCallRingStateResponse getCallRingState(@Path(value = type) String type, @Path(value = id) String id, @Query(value = call_session_id) String callSessionId)

  Get Call Ring State Returns who accepted, rejected, or missed the ring for a call session. Safe to poll: it performs no writes and emits no events. Use it to reconcile after a dropped call.accepted, call.rejected, or call.missed websocket event. call_session_id identifies the session, so the state stays readable after the call has ended.

• startRTMPBroadcasts

   abstract StartRTMPBroadcastsResponse startRTMPBroadcasts(@Path(value = type) String type, @Path(value = id) String id, @Body() StartRTMPBroadcastsRequest startRTMPBroadcastsRequest)

  Start RTMP broadcasts Starts RTMP broadcasts for the provided RTMP destinations

• stopAllRTMPBroadcasts

   abstract StopAllRTMPBroadcastsResponse stopAllRTMPBroadcasts(@Path(value = type) String type, @Path(value = id) String id)

  Stop all RTMP broadcasts for a call Stop all RTMP broadcasts for the provided call

• getCallParticipantSessionMetrics

   abstract GetCallParticipantSessionMetricsResponse getCallParticipantSessionMetrics(@Path(value = type) String type, @Path(value = id) String id, @Path(value = session) String session, @Path(value = user) String user, @Path(value = user_session) String userSession, @Query(value = since) OffsetDateTime since, @Query(value = until) OffsetDateTime until)

  Get call participant session metrics

• queryCallParticipantSessions

   abstract QueryCallParticipantSessionsResponse queryCallParticipantSessions(@Path(value = type) String type, @Path(value = id) String id, @Path(value = session) String session, @Query(value = limit) Integer limit, @Query(value = prev) String prev, @Query(value = next) String next, @Query(value = filter_conditions) Map<String, Object> filterConditions)

  Query call participant sessions

• startHLSBroadcasting

   abstract StartHLSBroadcastingResponse startHLSBroadcasting(@Path(value = type) String type, @Path(value = id) String id)

  Start HLS broadcasting Starts HLS broadcasting

• startClosedCaptions

   abstract StartClosedCaptionsResponse startClosedCaptions(@Path(value = type) String type, @Path(value = id) String id, @Body() StartClosedCaptionsRequest startClosedCaptionsRequest)

  Start closed captions Starts closed captions

• startClosedCaptions

   abstract StartClosedCaptionsResponse startClosedCaptions(@Path(value = type) String type, @Path(value = id) String id)

  Start closed captions Starts closed captions

• startFrameRecording

   abstract StartFrameRecordingResponse startFrameRecording(@Path(value = type) String type, @Path(value = id) String id, @Body() StartFrameRecordingRequest startFrameRecordingRequest)

  Start frame recording Starts frame by frame recording

• startFrameRecording

   abstract StartFrameRecordingResponse startFrameRecording(@Path(value = type) String type, @Path(value = id) String id)

  Start frame recording Starts frame by frame recording

• startTranscription

   abstract StartTranscriptionResponse startTranscription(@Path(value = type) String type, @Path(value = id) String id, @Body() StartTranscriptionRequest startTranscriptionRequest)

  Start transcription Starts transcription

• startTranscription

   abstract StartTranscriptionResponse startTranscription(@Path(value = type) String type, @Path(value = id) String id)

  Start transcription Starts transcription

• stopHLSBroadcasting

   abstract StopHLSBroadcastingResponse stopHLSBroadcasting(@Path(value = type) String type, @Path(value = id) String id)

  Stop HLS broadcasting Stops HLS broadcasting

• stopClosedCaptions

   abstract StopClosedCaptionsResponse stopClosedCaptions(@Path(value = type) String type, @Path(value = id) String id, @Body() StopClosedCaptionsRequest stopClosedCaptionsRequest)

  Stop closed captions Stops closed captions

• stopClosedCaptions

   abstract StopClosedCaptionsResponse stopClosedCaptions(@Path(value = type) String type, @Path(value = id) String id)

  Stop closed captions Stops closed captions

• stopFrameRecording

   abstract StopFrameRecordingResponse stopFrameRecording(@Path(value = type) String type, @Path(value = id) String id)

  Stop frame recording Stops frame recording

• stopLive

   abstract StopLiveResponse stopLive(@Path(value = type) String type, @Path(value = id) String id, @Body() StopLiveRequest stopLiveRequest)

  Set call as not live

• stopLive

   abstract StopLiveResponse stopLive(@Path(value = type) String type, @Path(value = id) String id)

  Set call as not live

• stopTranscription

   abstract StopTranscriptionResponse stopTranscription(@Path(value = type) String type, @Path(value = id) String id, @Body() StopTranscriptionRequest stopTranscriptionRequest)

  Stop transcription Stops transcription

• stopTranscription

   abstract StopTranscriptionResponse stopTranscription(@Path(value = type) String type, @Path(value = id) String id)

  Stop transcription Stops transcription

• listTranscriptions

   abstract ListTranscriptionsResponse listTranscriptions(@Path(value = type) String type, @Path(value = id) String id)

  List transcriptions Lists transcriptions

• unblockUser

   abstract UnblockUserResponse unblockUser(@Path(value = type) String type, @Path(value = id) String id, @Body() UnblockUserRequest unblockUserRequest)

  Unblocks user on a call Removes the block for a user on a call. The user will be able to join the call again.

• videoUnpin

   abstract UnpinResponse videoUnpin(@Path(value = type) String type, @Path(value = id) String id, @Body() UnpinRequest unpinRequest)

  Unpin Unpins a track for all users in the call.

• updateUserPermissions

   abstract UpdateUserPermissionsResponse updateUserPermissions(@Path(value = type) String type, @Path(value = id) String id, @Body() UpdateUserPermissionsRequest updateUserPermissionsRequest)

  Update user permissions Updates user permissions

• deleteRecording

   abstract DeleteRecordingResponse deleteRecording(@Path(value = type) String type, @Path(value = id) String id, @Path(value = session) String session, @Path(value = filename) String filename)

  Delete recording Deletes recording

• deleteTranscription

   abstract DeleteTranscriptionResponse deleteTranscription(@Path(value = type) String type, @Path(value = id) String id, @Path(value = session) String session, @Path(value = filename) String filename)

  Delete transcription Deletes transcription

• reportClientCallEvent

   abstract ReportClientEventResponse reportClientCallEvent(@Body() ReportClientEventRequest reportClientEventRequest)

  Report client-side events Reports a batch of client-side telemetry events. Events are processed independently; one invalid event does not block the rest of the batch.

• queryCallSessionStats

   abstract QueryCallSessionStatsResponse queryCallSessionStats(@Body() QueryCallSessionStatsRequest queryCallSessionStatsRequest)

  Query call session stats

• queryCallSessionStats

   abstract QueryCallSessionStatsResponse queryCallSessionStats()

  Query call session stats

• getCallStatsMap

   abstract QueryCallStatsMapResponse getCallStatsMap(@Path(value = call_type) String callType, @Path(value = call_id) String callId, @Path(value = session) String session, @Query(value = start_time) OffsetDateTime startTime, @Query(value = end_time) OffsetDateTime endTime, @Query(value = exclude_publishers) Boolean excludePublishers, @Query(value = exclude_subscribers) Boolean excludeSubscribers, @Query(value = exclude_sfus) Boolean excludeSfus)

  Map call participants by location

• getCallSessionParticipantStatsDetails

   abstract GetCallSessionParticipantStatsDetailsResponse getCallSessionParticipantStatsDetails(@Path(value = call_type) String callType, @Path(value = call_id) String callId, @Path(value = session) String session, @Path(value = user) String user, @Path(value = user_session) String userSession, @Query(value = since) String since, @Query(value = until) String until, @Query(value = max_points) Integer maxPoints)

  Get call session participant stats details

• queryCallSessionParticipantStats

   abstract QueryCallSessionParticipantStatsResponse queryCallSessionParticipantStats(@Path(value = call_type) String callType, @Path(value = call_id) String callId, @Path(value = session) String session, @Query(value = limit) Integer limit, @Query(value = prev) String prev, @Query(value = next) String next, @Query(value = sort) List<SortParamRequest> sort, @Query(value = filter_conditions) Map<String, Object> filterConditions)

  Query call participant statistics

• getCallSessionParticipantStatsTimeline

   abstract QueryCallSessionParticipantStatsTimelineResponse getCallSessionParticipantStatsTimeline(@Path(value = call_type) String callType, @Path(value = call_id) String callId, @Path(value = session) String session, @Path(value = user) String user, @Path(value = user_session) String userSession, @Query(value = start_time) String startTime, @Query(value = end_time) String endTime, @Query(value = severity) List<String> severity)

  Get participant timeline events

• queryCalls

   abstract QueryCallsResponse queryCalls(@Query(value = connection_id) String connectionId, @Body() QueryCallsRequest queryCallsRequest)

  Query call Query calls with filter query

• queryCalls

   abstract QueryCallsResponse queryCalls(@Query(value = connection_id) String connectionId)

  Query call Query calls with filter query

• deleteDevice

   abstract Response deleteDevice(@Query(value = id) String id)

  Delete device Deletes one device

• listDevices

   abstract ListDevicesResponse listDevices()

  List devices Returns all available devices

• createDevice

   abstract Response createDevice(@Body() CreateDeviceRequest createDeviceRequest)

  Create device Adds a new device to a user, if the same device already exists the call will have no effect

• getEdges

   abstract GetEdgesResponse getEdges()

  Get Edges Returns the list of all edges available for video calls.

• createGuest

   abstract CreateGuestResponse createGuest(@Body() CreateGuestRequest createGuestRequest)

  Create Guest

• videoConnect

   abstract Unit videoConnect()

  Video Connect (WebSocket) Establishes WebSocket connection for user to video

• resolveSipAuth

   abstract ResolveSipAuthResponse resolveSipAuth(@Body() ResolveSipAuthRequest resolveSipAuthRequest)

  Resolve SIP Auth Determine authentication requirements for an inbound SIP call before sending a digest challenge

• resolveSipInbound

   abstract ResolveSipInboundResponse resolveSipInbound(@Body() ResolveSipInboundRequest resolveSipInboundRequest)

  Resolve SIP Inbound Routing Resolve SIP inbound routing based on trunk number, caller number, and challenge authentication

• queryAggregateCallStats

   abstract QueryAggregateCallStatsResponse queryAggregateCallStats(@Body() QueryAggregateCallStatsRequest queryAggregateCallStatsRequest)

  Query Aggregate call Stats

• queryAggregateCallStats

   abstract QueryAggregateCallStatsResponse queryAggregateCallStats()

  Query Aggregate call Stats