Package io.github.ma1uta.matrix.client.api

Interface VoipApi

  • @Path("/_matrix/client/r0/voip")
@Produces("application/json")
public interface VoipApi
    The homeserver MAY provide a TURN server which clients can use to contact the remote party. The following HTTP API endpoints will be used by clients in order to get information about the TURN server.

    • Method Summary

      Modifier and Type Method Description
      void turnServer​(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      This API provides credentials for the client to use when initiating calls.

    • Method Detail

      • turnServer

        @GET
@Path("/turnServer")
void turnServer​(@Context
                javax.ws.rs.core.UriInfo uriInfo,
                @Context
                javax.ws.rs.core.HttpHeaders httpHeaders,
                @Suspended
                javax.ws.rs.container.AsyncResponse asyncResponse,
                @Context
                javax.ws.rs.core.SecurityContext securityContext)
        This API provides credentials for the client to use when initiating calls.
        Rate-limited: Yes.
        Requires auth: Yes.
        Return: VoipResponse.

        Status code 200: The TURN server credentials.

        Status code 429: This request was rate-limited.

        Parameters:
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.