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

• 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

• 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)

• 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

• 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)

• goLive

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

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

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

• 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)

• 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)

• queryMembers

  @POST(value = "/video/call/members") abstract QueryMembersResponse queryMembers(@Body() QueryMembersRequest queryMembersRequest)

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

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

• rejectCall

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

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

  • 201: Successful response

  • 400: Bad request

  • 429: Too many requests

• 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

• 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

• 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

• 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

• 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