About this Resource

Modified: for 6.0.0

Defines a SIP Voice Quality Server.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
VQReportingYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Indicates if Voice Quality reporting is enabled.
VQServerHostYesNostringnone256 - Max Length If 'Voice Quality Reporting' is true, this represents the IP address or FQDN of the Voice quality Monitoring Agent.
VQServerPortYesNoint5061Possible values:
  • 1024 - Minimum
  • 65535 - Maximum
If 'Voice Quality Reporting' is true, this represents the port of the QoE Monitoring within the range 1024 through 65535.
VQServerProtocolYesNoEnum4Possible values:
  • 0 - eTrNone
  • 1 - eTrUDP
  • 2 - eTrTCP
  • 3 - eTrTCP_UDP
  • 4 - eTrTLS
  • 5 - eTrTLS_UDP
  • 6 - eTrTLS_TCP
  • 7 - eTrTLS_TCP_UDP
  • 8 - eTrCount
  • 9 - eTrSCTP
 Specifies the protocol to use for sending Voice Quality reports
  • UDP - Send messages using UDP.
  • TCP - Send message using TCP.
  • TLS - Send message using TLS.
VQTLSProfileIDNoNoint1Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 If protocol is TLS, this is the ID of TLS profile in use.
IntervalYesNoint300Possible values:
  • 30 - Minimum
  • 3600 - Maximum
Specifies the reporting interval.
MOSValueYesNoint30Possible values:
  • 10 - Minimum
  • 40 - Maximum
Specifies the Impairment Threshold (Falling) MOS value for calls, in tenths (e.g.: "2.5" is configured as "25").
SipSGListNoNostring140 - Max Length Specifies the SIP Signaling Groups for which Voice quality reporting is enabled as a comma-separated string of the Signaling Group IDs.

Statistics

Parameter Name Description Data Type Possible Values
rt_SentVQReports Number of successful VQ reports sent. int
rt_FailedVQReports Number of failed VQ reports. int