Package com.ringcentral.paths.restapi.account.telephony.sessions.parties.hold

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.telephony.sessions.parties.hold.Index

public class Index
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
Index	parent
RestClient	rc

Constructor Summary

Constructors

Constructor	Description
Index(Index parent)

Method Summary

Modifier and Type	Method	Description
String	path()
String	path(Boolean withParameter)
CallParty	post(HoldCallPartyRequest holdCallPartyRequest)	Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

rc

public RestClient rc

parent

public Index parent

Constructor Details

Index

public Index(Index parent)

Method Details

path

public String path()

path

public String path(Boolean withParameter)

post

public CallParty post(HoldCallPartyRequest holdCallPartyRequest)
               throws RestException,
IOException

Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold Rate Limit Group: Light App Permission: CallControl

Throws:

RestException

IOException