Interface ConferencesService


public interface ConferencesService
Conferences Service
  • Method Details

    • get

      GetConferenceInfoResponse get(String conferenceId) throws ApiException
      Get Conference Info

      Returns information about a conference that matches the provided conference ID.

      Parameters:
      conferenceId - The unique identifier of the conference. The user sets this value. (required)
      Returns:
      GetConferenceInfoResponse
      Throws:
      ApiException - if fails to make API call
    • kickAll

      void kickAll(String conferenceId) throws ApiException
      Kick Conference All

      Removes all participants from a conference.

      Parameters:
      conferenceId - The unique identifier of the conference. The user sets this value. (required)
      Throws:
      ApiException - if fails to make API call
    • kickParticipant

      void kickParticipant(String conferenceId, String callId) throws ApiException
      Kick Conference Participant

      Remove a specified conference participant from a specified conference.

      Parameters:
      conferenceId - The unique identifier of the conference. The user sets this value. (required)
      callId - The unique identifier of the call. This value is generated by the system. (required)
      Throws:
      ApiException - if fails to make API call
    • manageParticipant

      void manageParticipant(String conferenceId, String callId, ManageConferenceParticipantRequest manageConferenceParticipantRequest) throws ApiException
      Manage Conference Participant

      Manages conference participant in a specified conference: * mute / unmute * put on hold / resume.

      Parameters:
      conferenceId - The unique identifier of the conference. The user sets this value. (required)
      callId - The unique identifier of the call. This value is generated by the system. (required)
      manageConferenceParticipantRequest - (optional)
      Throws:
      ApiException - if fails to make API call
    • call

      String call(CalloutRequestConference parameters)