Versions Compared

Old Version 2

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 3

changes.mady.by.user Ribbon Communications

Saved on

Key

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

REST API Method: GET /rest/routingtable/{identifier}/routingentry/{identifier}/historicalstatistics/{identifier}

routingentry - REST API Methods
Page Tree
rootResource - routingentry

This action retrieves the historical statistics for a given Call Routing Entry in the Sonus SBC 1000/2000 system. The collections are over 1 hour intervals for a period of 1 day, thus giving a maximum of 24 historical records.

Info

The current interval is always the resource with ID 1. There will be a maximum of 25 rows returned for a lookup, where the row with ID 1 is the current interval being collected and the rows with ID 2-25 are the historical collections.

Tip

If no ID is specified, a listing of all collections will be returned along with their associated IDs. These identifiers can be used to get the individual resource element values.

URL:

https://134.56.227.163/rest/routingtable/{identifier}/routingentry/{identifier}/historicalstatistics/{identifier}

HTTP Method

GET

Requires Authentication

true

Resource Schema

Statistics

Possible values:
Parameter Name Description Data Type Possible Values Description
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_QualityFailed
  • 0 - btFalse
  • 1 - btTrue
    • Displays 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

    Usage Example: (about cURL | requires a session token)

    Code Block
    languagebash
    curl --cookie PHPSESSID=ima0r3nkaeg8mo0suln67vg4m7 --cacert 134.56.227.163.crt 
-i https://134.56.227.163/rest/routingtable/1/routingentry/1/historicalstatistics/1

    Response:

    Code Block
    languagehtml/xml
    <?xml version="1.0"?>
<root>
 <status>
  <http_code>200</http_code>
</status>
 <routingentry id="1:1" href="https://134.56.72.218/rest/routingtable/1/routingentry/1">
  <CallForked>0</CallForked>
  <CallPriority>1</CallPriority>
  <CancelOthersUponForwarding>0</CancelOthersUponForwarding>
  <ConfigIEState>1</ConfigIEState>
  <DenyCauseCode>16</DenyCauseCode>
  <Description>REST entry</Description>
  <DestinationType>0</DestinationType>
  <MediaMode>0</MediaMode>
  <MediaSelection>0</MediaSelection>
  <MediaTranscoding>1</MediaTranscoding>
  <MessageTranslationTable>0</MessageTranslationTable>
  <QualityMaxJitterThreshold>3000</QualityMaxJitterThreshold>
  <QualityMaxRoundTripDelayThreshold>65535</QualityMaxRoundTripDelayThreshold>
  <QualityMetricCalls>10</QualityMetricCalls>
  <QualityMetricTime>10</QualityMetricTime>
  <QualityMinASRThreshold>0</QualityMinASRThreshold>
  <ReRouteTable>0</ReRouteTable>
  <RoutePriority>1</RoutePriority>
  <SignalingGroupList count="1">
    <entry href="https://134.56.72.218/sipsg/1">1</entry>
  </SignalingGroupList>
  <TransformationTable href="https://134.56.72.218/transformationtable/1">1</TransformationTable>
  <rt_ASR>0</rt_ASR>
  <rt_Jitter>3000</rt_Jitter>
  <rt_QualityFailed>0</rt_QualityFailed>
  <rt_RoundTripDelay>9999</rt_RoundTripDelay>
  <rt_RuleUsage>0</rt_RuleUsage>
 </routingentry>
</root>