/tones

The tones API is used to configure custom tone detection templates.

A tone template may define either a single tone or dual tones, which may be either continuous or cadenced. Dual tones with frequency components closer than approximately 63Hz cannot be detected, for these cases a single tone definition should be used. A maximum of 20 tone templates may be defined.

Parameters

freq1, frequency 1 in Hz (300Hz to 3.5kHz).
fq1dev, frequency 1 deviation in Hz.
freq2, frequency 2 in Hz (300Hz to 3.5kHz). Set to 0 to define a single tone.
fq2dev, frequency 2 deviation in Hz. Dual tone only.
ontime, tone-on time in milliseconds (minimum 40ms). Set to 0 to define a continuous tone.
ontdev, tone-on time deviation in milliseconds. Cadenced only.
offtime, tone-off time in milliseconds (minimum 40ms). Cadenced only.
offtdev, tone-off time deviation in milliseconds. Cadenced only.

Resource URI

/tones

HTTP GET

Retrieves all tone templates.

GET /tones

Method

Response Payload

JSON

{
  "tones" : [
    {
      "1kHz" : {
          "freq1" : 1000,
          "fq1dev" : 20,
          "freq2" : 0,
          "fq2dev" : 0,
          "ontime" : 0,
          "ontdev" : 0,
          "offtime" : 0,
          "offtdev" : 0
      }
    },
    {
      "busy" : {
           "freq1" : 480,
           "fq1dev" : 40,
           "freq2" : 620,
           "fq2dev" : 40,
           "ontime" : 500,
           "ontdev" : 50,
           "offtime" : 500,
           "offtdev" : 50
     }
    }
  ],
  "cpa_tones": [
    {
      "busy1": {
        "freq1": 480,
        "fq1dev": 30,
        "freq2": 620,
        "fq2dev": 30,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 500,
        "ontdev": 150,
        "offtime": 500,
        "offtdev": 150,
        "repcnt": 2
      }
    },
    {
      "busy2": {
        "freq1": 480,
        "fq1dev": 30,
        "freq2": 620,
        "fq2dev": 30,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 250,
        "ontdev": 150,
        "offtime": 250,
        "offtdev": 150,
        "repcnt": 2
      }
    },
    {
      "dialtone_international": {
        "freq1": 340,
        "fq1dev": 40,
        "freq2": 440,
        "fq2dev": 40,
        "twinfreq": 390,
        "twindev": 90,
        "ontime": 1000,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "dialtone_local": {
        "freq1": 340,
        "fq1dev": 40,
        "freq2": 440,
        "fq2dev": 40,
        "twinfreq": 390,
        "twindev": 90,
        "ontime": 100,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "fax1": {
        "freq1": 1100,
        "fq1dev": 50,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 350,
        "ontdev": 250,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "fax2": {
        "freq1": 2150,
        "fq1dev": 150,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 100,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "ringback1": {
        "freq1": 440,
        "fq1dev": 50,
        "freq2": 480,
        "fq2dev": 50,
        "twinfreq": 450,
        "twindev": 100,
        "ontime": 2000,
        "ontdev": 200,
        "offtime": 4000,
        "offtdev": 200,
        "repcnt": 1
      }
    },
    {
      "ringback2:seg1": {
        "freq1": 450,
        "fq1dev": 100,
        "freq2": 450,
        "fq2dev": 100,
        "twinfreq": 450,
        "twindev": 100,
        "ontime": 600,
        "ontdev": 400,
        "offtime": 600,
        "offtdev": 400,
        "repcnt": 0
      }
    },
    {
      "ringback2:seg2": {
        "freq1": 450,
        "fq1dev": 100,
        "freq2": 450,
        "fq2dev": 100,
        "twinfreq": 450,
        "twindev": 100,
        "ontime": 600,
        "ontdev": 400,
        "offtime": 3500,
        "offtdev": 2500,
        "repcnt": 1
      }
    },
    {
      "sit_no_circuit:seg1": {
        "freq1": 985,
        "fq1dev": 35,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 385,
        "ontdev": 65,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_no_circuit:seg2": {
        "freq1": 1425,
        "fq1dev": 25,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 385,
        "ontdev": 65,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_no_circuit:seg3": {
        "freq1": 1795,
        "fq1dev": 55,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 0,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "sit_operator_intercept:seg1": {
        "freq1": 915,
        "fq1dev": 40,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 225,
        "ontdev": 75,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_operator_intercept:seg2": {
        "freq1": 1370,
        "fq1dev": 60,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 225,
        "ontdev": 75,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_operator_intercept:seg3": {
        "freq1": 1795,
        "fq1dev": 55,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 0,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "sit_reorder:seg1": {
        "freq1": 915,
        "fq1dev": 40,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 225,
        "ontdev": 75,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_reorder:seg2": {
        "freq1": 1425,
        "fq1dev": 25,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 385,
        "ontdev": 65,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_reorder:seg3": {
        "freq1": 1795,
        "fq1dev": 55,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 0,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    },
    {
      "sit_vacant_circuit:seg1": {
        "freq1": 985,
        "fq1dev": 35,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 385,
        "ontdev": 65,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_vacant_circuit:seg2": {
        "freq1": 1370,
        "fq1dev": 60,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 225,
        "ontdev": 75,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 0
      }
    },
    {
      "sit_vacant_circuit:seg3": {
        "freq1": 1795,
        "fq1dev": 55,
        "freq2": 0,
        "fq2dev": 0,
        "twinfreq": 0,
        "twindev": 0,
        "ontime": 0,
        "ontdev": 0,
        "offtime": 0,
        "offtdev": 0,
        "repcnt": 1
      }
    }
  ]
}

HTTP PUT

Updates all tone templates.

PUT /tones

Method	Request Payload	Response Payload
JSON	{ "tones" : [ { "1kHz" : { "freq1" : 1000, "fq1dev" : 20, "freq2" : 0, "fq2dev" : 0, "ontime" : 0, "ontdev" : 0, "offtime" : 0, "offtdev" : 0 } }, { "busy" : { "freq1" : 480, "fq1dev" : 40, "freq2" : 620, "fq2dev" : 40, "ontime" : 500, "ontdev" : 50, "offtime" : 500, "offtdev" : 50 } }, { "congestion" : { "freq1" : 480, "fq1dev" : 40, "freq2" : 620, "fq2dev" : 40, "ontime" : 200, "ontdev" : 50, "offtime" : 300, "offtdev" : 50 } } ] }	{ "tones" : [ { "1kHz" : { "freq1" : 1000, "fq1dev" : 20, "freq2" : 0, "fq2dev" : 0, "ontime" : 0, "ontdev" : 0, "offtime" : 0, "offtdev" : 0 } }, { "busy" : { "freq1" : 480, "fq1dev" : 40, "freq2" : 620, "fq2dev" : 40, "ontime" : 500, "ontdev" : 50, "offtime" : 500, "offtdev" : 50 } }, { "congestion" : { "freq1" : 480, "fq1dev" : 40, "freq2" : 620, "fq2dev" : 40, "ontime" : 200, "ontdev" : 50, "offtime" : 300, "offtdev" : 50 } } ] }