Constructor Detail

Method Detail

• acceptCall

  @POST(value = "/video/call/{type}/{id}/accept") abstract AcceptCallResponse acceptCall(@Path(value = "type") String type, @Path(value = "id") String id)

  Accept Call Sends events: - call.accepted Required permissions: - JoinCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  AcceptCallResponse

• blockUser

  @POST(value = "/video/call/{type}/{id}/block") 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. Sends events: - call.blocked_user Required permissions: - BlockUser Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  BlockUserResponse

• collectUserFeedback

  @POST(value = "/video/call/{type}/{id}/feedback/{session}") abstract CollectUserFeedbackResponse collectUserFeedback(@Path(value = "type") String type, @Path(value = "id") String id, @Path(value = "session") String session, @Body() CollectUserFeedbackRequest collectUserFeedbackRequest)

  Collect user feedback Required permissions: - JoinCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  CollectUserFeedbackResponse

• createDevice

  @POST(value = "/video/devices") 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 Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  Response

• createGuest

  @POST(value = "/video/guest") abstract CreateGuestResponse createGuest(@Body() CreateGuestRequest createGuestRequest)

  Create Guest

  Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  CreateGuestResponse

• deleteDevice

  @DELETE(value = "/video/devices") abstract Response deleteDevice(@Query(value = "id") String id, @Query(value = "user_id") String userId)

  Delete device Deletes one device Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  userId - (optional)

  Returns:

  Response

• deleteRecording

  @DELETE(value = "/video/call/{type}/{id}/{session}/recordings/{filename}") 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 Required permissions: - DeleteRecording Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  DeleteRecordingResponse

• deleteTranscription

  @DELETE(value = "/video/call/{type}/{id}/{session}/transcriptions/{filename}") 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 Required permissions: - DeleteTranscription Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  DeleteTranscriptionResponse

• endCall

  @POST(value = "/video/call/{type}/{id}/mark_ended") abstract EndCallResponse endCall(@Path(value = "type") String type, @Path(value = "id") String id)

  End call Sends events: - call.ended Required permissions: - EndCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  EndCallResponse

• getCall

  @GET(value = "/video/call/{type}/{id}") 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)

  Get Call Required permissions: - ReadCall Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  connectionId - (optional)

  membersLimit - (optional)

  ring - (optional)

  notify - (optional)

  Returns:

  GetCallResponse

• getCallStats

  @GET(value = "/video/call/{type}/{id}/stats/{session}") abstract GetCallStatsResponse getCallStats(@Path(value = "type") String type, @Path(value = "id") String id, @Path(value = "session") String session)

  Get Call Stats Required permissions: - ReadCallStats Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  GetCallStatsResponse

• getEdges

  @GET(value = "/video/edges") abstract GetEdgesResponse getEdges()

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

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  GetEdgesResponse

• getOrCreateCall

  @POST(value = "/video/call/{type}/{id}") abstract GetOrCreateCallResponse getOrCreateCall(@Path(value = "type") String type, @Path(value = "id") String id, @Body() GetOrCreateCallRequest getOrCreateCallRequest, @Query(value = "connection_id") String connectionId)

  Get or create a call Gets or creates a new call Sends events: - call.created - call.notification - call.ring Required permissions: - CreateCall - ReadCall - UpdateCallSettings Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  connectionId - (optional)

  Returns:

  GetOrCreateCallResponse

• goLive

  @POST(value = "/video/call/{type}/{id}/go_live") abstract GoLiveResponse goLive(@Path(value = "type") String type, @Path(value = "id") String id, @Body() GoLiveRequest goLiveRequest)

  Set call as live Sends events: - call.live_started Required permissions: - UpdateCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  GoLiveResponse

• joinCall

  @POST(value = "/video/call/{type}/{id}/join") abstract JoinCallResponse joinCall(@Path(value = "type") String type, @Path(value = "id") String id, @Body() JoinCallRequest joinCallRequest, @Query(value = "connection_id") String connectionId)

  Join call Request to join a call Required permissions: - CreateCall - JoinCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  connectionId - (optional)

  Returns:

  JoinCallResponse

• listDevices

  @GET(value = "/video/devices") abstract ListDevicesResponse listDevices(@Query(value = "user_id") String userId)

  List devices Returns all available devices Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  userId - (optional)

  Returns:

  ListDevicesResponse

• listRecordings

  @GET(value = "/video/call/{type}/{id}/recordings") abstract ListRecordingsResponse listRecordings(@Path(value = "type") String type, @Path(value = "id") String id)

  List recordings Lists recordings Required permissions: - ListRecordings Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  ListRecordingsResponse

• listTranscriptions

  @GET(value = "/video/call/{type}/{id}/transcriptions") abstract ListTranscriptionsResponse listTranscriptions(@Path(value = "type") String type, @Path(value = "id") String id)

  List transcriptions Lists transcriptions Required permissions: - ListTranscriptions Responses:

  • 200: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  ListTranscriptionsResponse

• muteUsers

  @POST(value = "/video/call/{type}/{id}/mute_users") abstract MuteUsersResponse muteUsers(@Path(value = "type") String type, @Path(value = "id") String id, @Body() MuteUsersRequest muteUsersRequest)

  Mute users Mutes users in a call Required permissions: - MuteUsers Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  MuteUsersResponse

• queryCallMembers

  @POST(value = "/video/call/members") abstract QueryCallMembersResponse queryCallMembers(@Body() QueryCallMembersRequest queryCallMembersRequest)

  Query call members Query call members with filter query Required permissions: - ReadCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  QueryCallMembersResponse

• queryCallStats

  @POST(value = "/video/call/stats") abstract QueryCallStatsResponse queryCallStats(@Body() QueryCallStatsRequest queryCallStatsRequest)

  Query Call Stats Required permissions: - ReadCallStats Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  QueryCallStatsResponse

• queryCalls

  @POST(value = "/video/calls") abstract QueryCallsResponse queryCalls(@Body() QueryCallsRequest queryCallsRequest, @Query(value = "connection_id") String connectionId)

  Query call Query calls with filter query Required permissions: - ReadCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Parameters:

  connectionId - (optional)

  Returns:

  QueryCallsResponse

• rejectCall

  @POST(value = "/video/call/{type}/{id}/reject") abstract RejectCallResponse rejectCall(@Path(value = "type") String type, @Path(value = "id") String id, @Body() RejectCallRequest rejectCallRequest)

  Reject Call Sends events: - call.rejected Required permissions: - JoinCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  RejectCallResponse

• requestPermission

  @POST(value = "/video/call/{type}/{id}/request_permission") abstract RequestPermissionResponse requestPermission(@Path(value = "type") String type, @Path(value = "id") String id, @Body() RequestPermissionRequest requestPermissionRequest)

  Request permission Request permission to perform an action Sends events: - call.permission_request Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  RequestPermissionResponse

• sendCallEvent

  @POST(value = "/video/call/{type}/{id}/event") 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 Sends events: - custom Required permissions: - SendEvent Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  SendCallEventResponse

• sendVideoReaction

  @POST(value = "/video/call/{type}/{id}/reaction") 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 Sends events: - call.reaction_new Required permissions: - CreateCallReaction Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  SendReactionResponse

• startHLSBroadcasting

  @POST(value = "/video/call/{type}/{id}/start_broadcasting") abstract StartHLSBroadcastingResponse startHLSBroadcasting(@Path(value = "type") String type, @Path(value = "id") String id)

  Start HLS broadcasting Starts HLS broadcasting Required permissions: - StartBroadcasting Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StartHLSBroadcastingResponse

• startRecording

  @POST(value = "/video/call/{type}/{id}/start_recording") abstract StartRecordingResponse startRecording(@Path(value = "type") String type, @Path(value = "id") String id, @Body() StartRecordingRequest startRecordingRequest)

  Start recording Starts recording Sends events: - call.recording_started Required permissions: - StartRecording Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StartRecordingResponse

• startTranscription

  @POST(value = "/video/call/{type}/{id}/start_transcription") abstract StartTranscriptionResponse startTranscription(@Path(value = "type") String type, @Path(value = "id") String id, @Body() StartTranscriptionRequest startTranscriptionRequest)

  Start transcription Starts transcription Required permissions: - StartTranscription Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StartTranscriptionResponse

• stopHLSBroadcasting

  @POST(value = "/video/call/{type}/{id}/stop_broadcasting") abstract StopHLSBroadcastingResponse stopHLSBroadcasting(@Path(value = "type") String type, @Path(value = "id") String id)

  Stop HLS broadcasting Stops HLS broadcasting Required permissions: - StopBroadcasting Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StopHLSBroadcastingResponse

• stopLive

  @POST(value = "/video/call/{type}/{id}/stop_live") abstract StopLiveResponse stopLive(@Path(value = "type") String type, @Path(value = "id") String id)

  Set call as not live Sends events: - call.updated Required permissions: - UpdateCall Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StopLiveResponse

• stopRecording

  @POST(value = "/video/call/{type}/{id}/stop_recording") abstract StopRecordingResponse stopRecording(@Path(value = "type") String type, @Path(value = "id") String id)

  Stop recording Stops recording Sends events: - call.recording_stopped Required permissions: - StopRecording Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StopRecordingResponse

• stopTranscription

  @POST(value = "/video/call/{type}/{id}/stop_transcription") abstract StopTranscriptionResponse stopTranscription(@Path(value = "type") String type, @Path(value = "id") String id)

  Stop transcription Stops transcription Sends events: - call.transcription_stopped Required permissions: - StopTranscription Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  StopTranscriptionResponse

• unblockUser

  @POST(value = "/video/call/{type}/{id}/unblock") 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. Sends events: - call.unblocked_user Required permissions: - BlockUser Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  UnblockUserResponse

• updateCall

  @PATCH(value = "/video/call/{type}/{id}") abstract UpdateCallResponse updateCall(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UpdateCallRequest updateCallRequest)

  Update Call Sends events: - call.updated Required permissions: - UpdateCall Responses:

  • 200: Call

  • 400: Bad request

  • 429: Too many requests

  Returns:

  UpdateCallResponse

• updateCallMembers

  @POST(value = "/video/call/{type}/{id}/members") abstract UpdateCallMembersResponse updateCallMembers(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UpdateCallMembersRequest updateCallMembersRequest)

  Update Call Member Sends events: - call.member_added - call.member_removed - call.member_updated Required permissions: - RemoveCallMember - UpdateCallMember - UpdateCallMemberRole Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  UpdateCallMembersResponse

• updateUserPermissions

  @POST(value = "/video/call/{type}/{id}/user_permissions") abstract UpdateUserPermissionsResponse updateUserPermissions(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UpdateUserPermissionsRequest updateUserPermissionsRequest)

  Update user permissions Updates user permissions Sends events: - call.permissions_updated Required permissions: - UpdateCallPermissions Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  UpdateUserPermissionsResponse

• videoConnect

  @GET(value = "/video/longpoll") abstract Unit videoConnect()

  Video Connect (WebSocket) Establishes WebSocket connection for user to video Sends events: - connection.ok - health.check Responses:

  • 400: Bad request

  • 429: Too many requests

  Returns:

  Unit

• videoPin

  @POST(value = "/video/call/{type}/{id}/pin") 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. Required permissions: - PinCallTrack Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  PinResponse

• videoUnpin

  @POST(value = "/video/call/{type}/{id}/unpin") 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. Required permissions: - PinCallTrack Responses:

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

  Returns:

  UnpinResponse