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

Class Index

java.lang.Object

com.ringcentral.paths.restapi.account.telephony.sessions.parties.supervise.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)
PartySuperviseResponse	post(PartySuperviseRequest partySuperviseRequest)	Allows to monitor a call party in 'Listen' mode.

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 PartySuperviseResponse post(PartySuperviseRequest partySuperviseRequest)
                            throws RestException,
IOException

Allows to monitor a call party in 'Listen' mode. Input parameters are extension number of a monitored user and internal identifier of a supervisor's device. Call session and party identifiers should be specified in path. Please note that for this method dual channel audio flow is supported, which means that you need to make one more request for monitoring the second participant of a call. And as a result of each monitoring request the client receives SIP invite with the following header `p-rc-api-monitoring-ids` containing IDs of the monitored party and session. The flow is supported for calls with no more than 2 participants. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained. HTTP Method: post Endpoint: /restapi/{apiVersion}/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/supervise Rate Limit Group: Light App Permission: CallControl

Throws:

RestException

IOException