Skip to main content

ForwardCallPartyResponse

Information on a party of a call session

Properties

NameTypeRequiredDescription
id_strInternal identifier of a party
statusCallStatusInfoStatus data of a call session
mutedboolSpecifies 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
stand_aloneboolIf true then the party is not connected to a session voice conference, false means the party is connected to other parties in a session
parkParkInfoCall park information
from_PartyInfo
toPartyInfo
ownerOwnerInfoDeprecated. Information on a call owner
directionForwardCallPartyResponseDirectionDirection of a call
conference_roleForwardCallPartyResponseConferenceRoleA party's role in the conference scenarios. For calls of 'Conference' type only
ring_out_roleForwardCallPartyResponseRingOutRoleA party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only
ring_me_roleForwardCallPartyResponseRingMeRoleA party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only
recordingsList[RecordingInfo]Active recordings list

ForwardCallPartyResponseDirection

Direction of a call

Properties

NameTypeRequiredDescription
INBOUNDstr"Inbound"
OUTBOUNDstr"Outbound"

ForwardCallPartyResponseConferenceRole

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

Properties

NameTypeRequiredDescription
HOSTstr"Host"
PARTICIPANTstr"Participant"

ForwardCallPartyResponseRingOutRole

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

Properties

NameTypeRequiredDescription
INITIATORstr"Initiator"
TARGETstr"Target"

ForwardCallPartyResponseRingMeRole

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

Properties

NameTypeRequiredDescription
INITIATORstr"Initiator"
TARGETstr"Target"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →