RIringcentral
Call Control

Get Call Party Status

Returns a call party status by ID.

get/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}

Request

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

partyIdstring required

Internal identifier of a call party

Response

Success

idstring

Internal identifier of a party

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

direction'Inbound' | 'Outbound'

Direction of a call

conferenceRole'Host' | 'Participant'

A party's role in the conference scenarios. For calls of 'Conference' type only

ringOutRole'Initiator' | 'Target'

A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only

ringMeRole'Initiator' | 'Target'

A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only

Changes

No recorded changes to this operation across all 1 revision of this API.