Versions Compared

Old Version 4

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 5

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

Availability: Since 1.3.0

Excerpt

Defines a telephony Routing Entry resource to describe a given Routing Table.

REST API Methods for this Resource

Resource Schema

Configuration

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
TransformationTableYesNoint1Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Sets the Transformation table to use for this call route.
RoutePriorityYesNoint1Possible values:
  • 1 - Minimum
  • 10 - Maximum
Priority of the route, 1 is the highest, 10 the lowest. Higher priority routes are matched against before lower priority routes regardless of the order of the routes in the table.
CallPriorityYesNoEnum1Possible values:
  • 0 - e_CALL_PRIORITY_NON_URGENT
  • 1 - e_CALL_PRIORITY_NORMAL
  • 2 - e_CALL_PRIORITY_URGENT
  • 3 - e_CALL_PRIORITY_EMERGENCY
Priority of the call. Used for emergency call identification by dial plan in routing table
QualityMetricCallsYesNoint10Possible values:
  • 1 - Minimum
  • 100 - Maximum
Specifies the number of calls over which the quality metrics are calculated.
QualityMetricTimeYesNoint10Possible values:
  • 1 - Minimum
  • 60 - Maximum
Specifies the time in minutes after which a route is tried again after failing quality metrics.
QualityMinASRThresholdYesNoint0Possible values:
  • 0 - Minimum
  • 100 - Maximum
Specifies the minimum answer/seizure ratio for this rule to be considered for use.
QualityMaxRoundTripDelayThresholdNoNoint65535Possible values:
  • 0 - Minimum
  • 65535 - Maximum
Specifies the maximum average round trip (R/T) delay for this rule to be considered for use.
QualityMaxJitterThresholdNoNoint3000Possible values:
  • 0 - Minimum
  • 3000 - Maximum
Specifies the maximum average jitter for this rule to be considered for use.
DestinationTypeYesNoEnum0Possible values:
  • 0 - dtOther
  • 1 - dtRegistrarTable
  • 2 - dtDeny
  • 3 - dtTrunkGroup
Specifies the type of destination for calls.
DenyCauseCodeNoNoint16Possible values:
  • 0 - Minimum
  • 127 - Maximum
Specifies the cause code to use for Deny type destionations.
MediaSelectionNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
Specifies the Media List Profile to use for this Call Route.
MediaModeYesNoEnum0Possible values:
  • 0 - mmodetamodet_RtpDSP
  • 1 - mmodetamodet_RtpProxy
  • 2 - mmodetamodet_RtpProxyPreferred
  • 3 - mmodet_RtpUnknownamodet_RtpDSPPreferred
  • 4 - amodet_RtpNone
Determines Audio media mode for SIP calls.
VideoMediaModeYesNoEnum0Possible values:
  • 0 - vmodet_RtpNone
  • 1 - vmodet_RtpProxy
Determines Video media mode for to SIP calls.
MediaTranscodingYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 Controls whether or not to use Media Transcoding.
Warning

Transcoding requires a specific Transcoding License. Do not enable Media Transcoding unless your calling configuration requires it and Sonus SBC 1000/2000 is licensed for the transcoding feature. If this option is enabled without a trancoding license, a Critical Alarm will be generated even if the calls being routed don't need to be transcoded.

CancelOthersUponForwardingYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Controls whether forked calls should clear when one of the forked calls is forwarded.
CallForkedYesNoEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
Controls whether to fork a call if this route is selected.
ReRouteTableNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 Specifies which Cause Code Reroute Table to use. None means no cause code rerouting is used.
MessageTranslationTableNoNoint0Possible values:
  • 0 - Minimum
  • 65534 - Maximum
 Specifies which Message Translation Table to use. None means no message translation is used.
SignalingGroupListYesNostring140 - Max LengthSpecifies the Signaling Groups used as the destination of calls provided as a comma-separated string of the Signaling Group IDs. Not applicable when the Destination Type is Deny or Trunk Group.
DescriptionNoNostringnone64 - Max LengthDescribes the Call Route Table Entry so that it is easily identifiable when re-sequencing Entries.

Runtime

Parameter Name Description Data Type Possible Values
rt_RuleUsageDisplays the number of times this call route has been selected for a call.int
rt_ASRDisplays the Answer-Seizure Ratio for this call route.
Info

ASR is calculated by dividing the number of call attempts answered by the number of call attempts.

int
rt_RoundTripDelayDisplays the average round trip delay for this call route.int
rt_JitterDisplays the average jitter for this call route.int
rt_QualityFailedDisplays if this call route is currently passing or failing the associated quality metrics. If true then the rule is failing, if false then it is passing.EnumPossible values:
  • 0 - btFalse
  • 1 - btTrue