java.lang.Object
com.ringcentral.paths.restapi.account.telephony.sessions.parties.Index

public class Index extends Object
  • Field Details

  • Constructor Details

  • Method Details

    • path

      public String path(Boolean withParameter)
    • path

      public String path()
    • get

      public CallParty get() throws RestException, IOException
      Returns a call party status by ID. HTTP Method: get Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId} Rate Limit Group: Light App Permission: CallControl
      Throws:
      RestException
      IOException
    • delete

      public String delete() throws RestException, IOException
      Deletes a party from a call session by ID. A party can be deleted only if supervised or parked. It is possible to delete only one conference participant per request. HTTP Method: delete Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId} Rate Limit Group: Light App Permission: CallControl
      Throws:
      RestException
      IOException
    • patch

      public CallParty patch(PartyUpdateRequest partyUpdateRequest) throws RestException, IOException
      Modifies a call party by ID. There is a known limitation for Mute scenario - mute via REST API doesn't work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app you need to unmute both endpoints to bring the media back. HTTP Method: patch Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId} Rate Limit Group: Light App Permission: CallControl
      Throws:
      RestException
      IOException
    • hold

      public Index hold()
    • flip

      public Index flip()
    • park

      public Index park()
    • reply

      public Index reply()
    • unhold

      public Index unhold()
    • reject

      public Index reject()
    • ignore

      public Index ignore()
    • bridge

      public Index bridge()
    • answer

      public Index answer()
    • pickup

      public Index pickup()
    • forward

      public Index forward()
    • transfer

      public Index transfer()
    • bringIn

      public Index bringIn()
    • supervise

      public Index supervise()
    • recordings

      public Index recordings()
    • recordings

      public Index recordings(String recordingId)