PlcmActiveCallV3

PlcmActiveCallV3

Information about an active call present in system. Content-Type: application/vnd.plcm.plcm-active-call-v3+xml All attributes are used in ETag calculation except for entity-tag and atom-link.


PlcmActiveCallV3 Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmServiceClassV2 PlcmServiceClassV2See Definition of PlcmServiceClassV2
callIdentifierCallIdentifier Call identifier. Mandatory
signalingTypeSignalingType Call signaling type
requestedBitratelong The originally requested bit rate.
currentBitratelong The most recently reported bit rate.
originalDialStringstring The original (unmodified) dial string received from the initiating device.
resolvedDialStringstring The final, possibly transformed, dial string used to initiate the call.
sourceCallLegSourceCallLeg Call detail information for the device which initiated the call.
destinationCallLegDestinationCallLeg Call detail information for the device being called.
passbackPassback User defined value for that is opaque to the system
passthruPassthru User defined value that that is opaque to the system provided by the rest/conferences/conference-id/participants passthru value. Note: this value is available after the call is terminated in the userDataC field of the calls CDR.
clustersArray of string List of servers associated with the call.
callTypeCallType Type of the call such as external, dialout, dialin.
originatorstring Origin user of the call.
mediaEncryptionAlgorithmstring The encryption algorithm used for the media or emtpy if the media is not encrypted.
sharedLicenseboolean Whether the call is consuming a license shared from another licensed call server
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.
startTimedateTime

DestinationCallLeg Fields

NameTypeDescriptionAttributes
plcmCallLegV2 PlcmCallLegV2See Definition of PlcmCallLegV2Mandatory

SourceCallLeg Fields

NameTypeDescriptionAttributes
plcmCallLegV2 PlcmCallLegV2See Definition of PlcmCallLegV2Mandatory


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
CallTypestring
Value must be one of:
  • EXTERNAL_CALL_TYPE
  • MCU_DIALOUT_CALL_TYPE
  • MCU_DIALIN_CALL_TYPE
  • DMA_DIALOUT_CALL_TYPE
Passthrustring
Length of value must be >=1
Length of value must be <=512
Passbackstring
Length of value must be >=1
Length of value must be <=512
SignalingTypestring
Value must be one of:
  • H323
  • SIP
  • WEBRTC
  • UNKNOWN
  • POLY_EVO
CallIdentifierstring
Length of value must be >=1
Length of value must be <=36