plcm-active-call-v3.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-active-call-v3  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.


Complex Types

PlcmActiveCallV3 Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcm-service-class-v2 plcm-service-class-v2See Definition of plcm-service-class-v2
call-identifierCallIdentifier Call identifier. Mandatory
signaling-typeSignalingType Call signaling type
requested-bitratexs:long The originally requested bit rate.
current-bitratexs:long The most recently reported bit rate.
original-dial-stringxs:string The original (unmodified) dial string received from the initiating device.
resolved-dial-stringxs:string The final, possibly transformed, dial string used to initiate the call.
source-call-legSourceCallLeg Call detail information for the device which initiated the call.
destination-call-legDestinationCallLeg 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.
clustersList of xs:string List of servers associated with the call.
call-typeCallType Type of the call such as external, dialout, dialin.
originatorxs:string Origin user of the call.
media-encryption-algorithmxs:string The encryption algorithm used for the media or emtpy if the media is not encrypted.
shared-licensexs:boolean Whether the call is consuming a license shared from another licensed call server
entity-tagEntityTag 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.
start-timexs:dateTime

DestinationCallLeg Fields

NameTypeDescriptionAttributes
plcm-call-leg-v2 plcm-call-leg-v2See Definition of plcm-call-leg-v2Mandatory

SourceCallLeg Fields

NameTypeDescriptionAttributes
plcm-call-leg-v2 plcm-call-leg-v2See Definition of plcm-call-leg-v2Mandatory


Simple Types


NameTypeRestrictions
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
CallTypexs:string
Value must be one of:
  • EXTERNAL_CALL_TYPE
  • MCU_DIALOUT_CALL_TYPE
  • MCU_DIALIN_CALL_TYPE
  • DMA_DIALOUT_CALL_TYPE
Passthruxs:string
Length of value must be >=1
Length of value must be <=512
Passbackxs:string
Length of value must be >=1
Length of value must be <=512
SignalingTypexs:string
Value must be one of:
  • H323
  • SIP
  • WEBRTC
  • UNKNOWN
  • POLY_EVO
CallIdentifierxs:string
Length of value must be >=1
Length of value must be <=36