Package com.sinch.sdk.domains.voice
Interface ConferencesService
public interface ConferencesService
Using the Conferences endpoint, you can perform tasks like retrieving information about an
on-going conference, muting or unmuting participants, or removing participants from a conference.
- Since:
- 1.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncall
(CalloutRequestParametersConference parameters) Calls a phone number or a user to join a conference.Returns information about a conference that matches the provided conference ID.void
Removes all participants from a conferencevoid
kickParticipant
(String conferenceId, String callId) Remove a specified conference participant from a specified conferencevoid
manageParticipant
(String conferenceId, String callId, ConferenceManageParticipantRequestParameters parameters) Manages conference participant in a specified conference:
-
Method Details
-
call
Calls a phone number or a user to join a conference. When the call is answered, it's connected to a conference room.- Parameters:
parameters
- Conference parameters- Returns:
- The returned call identifier (callId)
- Since:
- 1.0
-
get
Returns information about a conference that matches the provided conference ID.- Parameters:
conferenceId
- The unique identifier of the conference. The user sets this value.- Returns:
- The list of participants joined the conference
- Since:
- 1.0
-
kickAll
Removes all participants from a conference- Parameters:
conferenceId
- The unique identifier of the conference. The user sets this value.- Since:
- 1.0
-
kickParticipant
Remove a specified conference participant from a specified conference- Parameters:
conferenceId
- The unique identifier of the conference. The user sets this value.callId
- The unique identifier of the call. This value is generated by the system- Since:
- 1.0
-
manageParticipant
void manageParticipant(String conferenceId, String callId, ConferenceManageParticipantRequestParameters parameters) Manages conference participant in a specified conference:- Parameters:
conferenceId
- The unique identifier of the conference. The user sets this value.callId
- The unique identifier of the call. This value is generated by the systemparameters
- Parameters to manage participant
-