WebRTC session - Operata Developer Hub

The webRTCSession object describes the WebRTC (Web Real-Time Communication) session for one NICE CXOne Interaction handled by the MAX WebRTC softphone. It covers the signalling endpoint, event timers, inbound and outbound media metrics, media endpoint, and per-stage failure flags. For the Amazon Connect equivalent, see WebRTC session.

Schema

"webRTCSession": {
  "signallingEndpoint": {
    "fqdn": "wss://sydacwrtc01.niceincontact.com"
  },
  "eventTimer": {
    "initializationTimeMillis": 49,
    "preTalkingTimeMillis": 324,
    "handshakingTimeMillis": 268,
    "signallingConnectTimeMillis": 2,
    "gumTimeMillis": 36,
    "cleanupTimeMillis": 5,
    "iceCollectionTimeMillis": 103
  },
  "metrics": {
    "mos": { "min": 4.39, "max": 4.43, "avg": 4.41 },
    "rtt": { "max": 121, "avg": 74 },
    "jitter": { "max": 6, "avg": 2 },
    "inbound": {
      "packetsReceived": 2336,
      "packetsLost": 0,
      "packetsLostPercentage": 0,
      "bytesReceived": 169788,
      "audioLevel": { "max": 10, "avg": 3.71 },
      "jitterBufferMils": { "min": 0, "max": 1, "avg": 0.31 }
    },
    "outbound": {
      "packetsSent": 2470,
      "packetsLost": 0,
      "packetsLostPercentage": 0,
      "bytesSent": 202087,
      "audioLevel": { "max": 2449, "avg": 392.79 },
      "jitterBufferMils": { "min": 0, "max": 5, "avg": 1.76 }
    }
  },
  "mediaEndpoint": {
    "fqdn": "",
    "destinationPort": "3478",
    "sourcePort": "63921",
    "transport": "",
    "privateIp": "10.4.3.213"
  },
  "eventFailure": {
    "iceCollectionFailure": false,
    "setLocalDescriptionFailure": false,
    "signallingConnectionFailure": false,
    "gumTimeoutFailure": false,
    "createOfferFailure": false,
    "noRemoteIceCandidateFailure": false,
    "setRemoteDescriptionFailure": false,
    "gumOtherFailure": false,
    "userBusyFailure": false,
    "handshakingFailure": false,
    "invalidRemoteSDPFailure": false
  }
}

Fields

Name	Type	Required	Description	Example
`signallingEndpoint.fqdn`	string	yes	NICE CXOne WebRTC signalling endpoint FQDN.	`wss://sydacwrtc01.niceincontact.com`
`eventTimer.initializationTimeMillis`	integer	yes	WebRTC initialization duration in milliseconds.	`49`
`eventTimer.preTalkingTimeMillis`	integer	yes	Time from session start to first audio in milliseconds.	`324`
`eventTimer.handshakingTimeMillis`	integer	yes	DTLS handshake duration in milliseconds.	`268`
`eventTimer.signallingConnectTimeMillis`	integer	yes	Signalling connection duration in milliseconds.	`2`
`eventTimer.gumTimeMillis`	integer	yes	`getUserMedia` call duration in milliseconds.	`36`
`eventTimer.cleanupTimeMillis`	integer	yes	Session teardown duration in milliseconds.	`5`
`eventTimer.iceCollectionTimeMillis`	integer	yes	ICE candidate collection duration in milliseconds.	`103`
`metrics.mos`	object	yes	Estimated Mean Opinion Score — `min`, `max`, `avg`. Range 1 (worst) to 5 (best).	`{ "min": 4.39, "max": 4.43, "avg": 4.41 }`
`metrics.rtt`	object	yes	Round-trip time in milliseconds — `max` and `avg`.	`{ "max": 121, "avg": 74 }`
`metrics.jitter`	object	yes	Jitter in milliseconds — `max` and `avg`.	`{ "max": 6, "avg": 2 }`
`metrics.inbound.packetsReceived`	integer	yes	Total RTP packets received from NICE CXOne during the Interaction.	`2336`
`metrics.inbound.packetsLost`	integer	yes	Total inbound RTP packets lost.	`0`
`metrics.inbound.packetsLostPercentage`	number	yes	Inbound packet loss as a percentage.	`0`
`metrics.inbound.bytesReceived`	integer	yes	Total inbound bytes received.	`169788`
`metrics.inbound.audioLevel`	object	yes	Inbound audio level range — `max` and `avg`.	—
`metrics.inbound.jitterBufferMils`	object	yes	Inbound jitter-buffer delay in milliseconds — `min`, `max`, `avg`.	—
`metrics.outbound.packetsSent`	integer	yes	Total RTP packets sent to NICE CXOne during the Interaction.	`2470`
`metrics.outbound.packetsLost`	integer	yes	Total outbound RTP packets lost.	`0`
`metrics.outbound.packetsLostPercentage`	number	yes	Outbound packet loss as a percentage.	`0`
`metrics.outbound.bytesSent`	integer	yes	Total outbound bytes sent.	`202087`
`metrics.outbound.audioLevel`	object	yes	Outbound audio level range — `max` and `avg`.	—
`metrics.outbound.jitterBufferMils`	object	yes	Outbound jitter-buffer delay in milliseconds — `min`, `max`, `avg`.	—
`mediaEndpoint.fqdn`	string	no	NICE CXOne TURN service FQDN. Empty when the media endpoint is referenced only by IP.	`""`
`mediaEndpoint.destinationPort`	string	yes	Destination port on the NICE CXOne TURN service.	`3478`
`mediaEndpoint.sourcePort`	string	yes	Source port used on the agent endpoint.	`63921`
`mediaEndpoint.transport`	string	no	Transport protocol. One of `udp`, `tcp`, `tls`. Empty when CXOne does not report a value.	`""`
`mediaEndpoint.privateIp`	string (IPv4)	yes	Private IP the agent endpoint used for media.	`10.4.3.213`
`eventFailure`	object	yes	Per-stage WebRTC failure flags. Each property is a boolean; `true` means the named failure occurred during session setup or teardown.	—

​Schema

​Fields

Schema

Fields