v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Call Control

Supervise Call Session

Allows monitoring a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained.

post/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

telephonySessionIdstring required

Internal identifier of a call session

Request body

mode'Listen' required

Supervising mode

supervisorDeviceIdstring required

Internal identifier of a supervisor's device which will be used for call session monitoring

agentExtensionIdstring

Extension identifier of the user that will be monitored

autoAnswerboolean

Specifies if auto-answer SIP header should be sent. If auto-answer is set to true, the call is automatically answered by the supervising party, if set to false - then the supervising party has to accept or decline the monitored call

mediaSDP'sendOnly' | 'sendRecv'

Specifies session description protocol setting

Example request

{
  "mode": "Listen",
  "supervisorDeviceId": "191888004",
  "agentExtensionId": "400378008008"
}

Response

Created

direction'Outbound' | 'Inbound'

Direction of a call

idstring

Internal identifier of a party that monitors a call

accountIdstring

Internal identifier of an account that monitors a call

extensionIdstring

Internal identifier of an extension that monitors a call

mutedboolean

Specifies if a call participant is muted or not. Note: If a call is also controlled via Hard phone or RingCentral App (not only through the API by calling call control methods) then it cannot be fully muted/unmuted via API only, in this case the action should be duplicated via Hard phone/RC App interfaces

standAloneboolean

If true then the party is not connected to a session voice conference, false means the party is connected to other parties in a session