Programmable Voice

  1. Home
  2. Docs
  3. Programmable Voice
  4. DX CAP

DX CAP

The DX_CAP structure provides various parameters for Call Progress to tuned to your environment.

This information is derived from: Dialogic Voice API Library Reference (Approximately Page 523)

/// <summary>
/// # of rings before no answer. 
/// Number of Rings Before Detecting No Answer: The number of single or double rings to wait before returning a no answer. 
/// Default: 4. 
/// </summary>
[XmlElement("ca_nbrdna")]
public ushort ca_nbrdna;
/// <summary>
/// Delay after dialing before analysis.
/// Start Delay: The delay after dialing has been completed and before starting Frequency Detection. 
/// This parameter also determines the start of Cadence Detection and Positive Voice Detection. 
/// Default: 25 (10 ms units). Note that this can affect detection of the first element of an operator intercept tone. 
/// </summary>
[XmlElement("ca_stdely")]
public ushort ca_stdely;
/// <summary>
/// Duration of no signal time out delay.
/// Continuous No Signal. The maximum time of silence (no signal) allowed immediately after cadence detection begins. 
/// If exceeded, a “no ringback” is returned.
/// Default: 4000 Units: 10 msec
/// </summary>
[XmlElement("ca_cnosig")]
public ushort ca_cnosig;
/// <summary>
/// Delay after dial before lc drop connect
/// Loop Current Delay: The delay after dialing has been completed and before beginning Loop Current Detection.
/// To disable Loop Current Detection, set to -1. Default: 400 (10 ms units). 
/// </summary>
[XmlElement("ca_lcdly")]
public short ca_lcdly;
/// <summary>
/// Delay after lc drop con. before msg.
/// Loop Current Delay 1: The delay after Loop Current Detection detects a transient drop in loop current and 
/// before Call Analysis returns a connect to the application. 
/// Default: 10 (10 ms units). 
/// </summary>
[XmlElement("ca_lcdly1")]
public ushort ca_lcdly1;
/// <summary>
/// Edge of answer to send connect message.
/// Hello Edge: The point at which a connect will be returned to the application, either the rising edge 
/// (immediately when a connect is detected) or the falling edge (after the end of the salutation). 
/// 1 = rising edge. 2 = falling edge. 
/// Default: 2 (connect returned on falling edge of salutation). 
/// Try changing this if the called party has to say "Hello" twice to trigger the answer event. 
/// </summary>
[XmlElement("ca_hedge")]
public ushort ca_hedge;
/// <summary>
/// Initial continuous noise timeout delay.
/// Continuous Nonsilence: The maximum length of nonsilence allowed. If exceeded, a no ringback is returned. 
/// Default: 650 (in 10 ms units), or 6.5 seconds.
/// </summary>
[XmlElement("ca_cnosil")]
public ushort ca_cnosil;
/// <summary>
/// % acceptable pos. dev of public ushort low sig.
/// </summary>
[XmlElement("ca_lo1tola")]
public ushort ca_lo1tola;
/// <summary>
/// % acceptable neg. dev of public ushort low sig.
/// </summary>
[XmlElement("ca_lo1tolb")]
public ushort ca_lo1tolb;
/// <summary>
/// % acceptable pos. dev of long low sig.
/// </summary>
[XmlElement("ca_lo2tola")]
public ushort ca_lo2tola;
/// <summary>
/// % acceptable neg. dev of long low sig.
/// </summary>
[XmlElement("ca_lo2tolb")]
public ushort ca_lo2tolb;
/// <summary>
/// % acceptable pos. dev of high signal.
/// </summary>
[XmlElement("ca_hi1tola")]
public ushort ca_hi1tola;
/// <summary>
/// % acceptable neg. dev of high signal.
/// </summary>
[XmlElement("ca_hi1tolb")]
public ushort ca_hi1tolb;
/// <summary>
/// Maximum interval for shrt low for busy.
/// </summary>
[XmlElement("ca_lo1bmax")]
public ushort ca_lo1bmax;
/// <summary>
/// Maximum interval for long low for busy.
/// </summary>
[XmlElement("ca_lo2bmax")]
public ushort ca_lo2bmax;
/// <summary>
/// Maximum interval for 1st high for busy
/// </summary>
[XmlElement("ca_hi1bmax")]
public ushort ca_hi1bmax;
/// <summary>
/// Num. of highs after nbrdna busy check.
/// Nonsilence Busy: The number of nonsilence periods in addition to ca_nbrdna to wait before returning a busy. 
/// Default: 0. ca_nsbusy is added to ca_nbrdna to give the actual number of busy cadences at which to return busy.
/// Note that even though ca_nsbusy is declared as an unsigned variable, it can be a small negative number.
/// Do not allow ca_nbrdna + ca_nsbusy to equal 2. 
/// This is a foible of the 2's complement bit mapping of a small negative number to an unsigned variable. 
/// </summary>
[XmlElement("ca_nsbusy")]
public ushort ca_nsbusy;
/// <summary>
/// Silence deglitch duration.
/// Low Glitch: The maximum silence period to ignore. Used to help eliminate spurious silence intervals. 
/// Default: 15 (in 10 ms units). 
/// </summary>
[XmlElement("ca_logltch")]
public ushort ca_logltch;
/// <summary>
/// Non-silence deglitch duration.
/// High Glitch: The maximum nonsilence period to ignore. Used to help eliminate spurious nonsilence intervals. 
/// Default: 19 (in 10 ms units)
/// </summary>
[XmlElement("ca_higltch")]
public ushort ca_higltch;
/// <summary>
/// Max. public ushort low  dur. of double ring.
/// </summary>
[XmlElement("ca_lo1rmax")]
public ushort ca_lo1rmax;
/// <summary>
/// Min. long low  dur. of double ring.
/// </summary>
[XmlElement("ca_lo2rmin")]
public ushort ca_lo2rmin;
/// <summary>
/// Operator intercept mode.
/// Intercept Mode Flag. Enables or disables SIT frequency detection, positive voice detection
/// (PVD), and/or positive answering machine detection (PAMD), and selects the mode of
/// operation for SIT frequency detection.
/// • DX_OPTDIS – Disable SIT frequency detection, PAMD, and PVD.
/// This setting provides call progress without SIT frequency detection.
/// • DX_OPTNOCON – Enable SIT frequency detection and return an “intercept”
/// immediately after detecting a valid frequency.
/// This setting provides call progress with SIT frequency detection.
/// • DX_PVDENABLE – Enable PVD and fax tone detection.
/// This setting provides PVD call analysis only (no call progress).
/// • DX_PVDOPTNOCON – Enable PVD, DX_OPTNOCON, and fax tone detection.
/// This setting provides call progress with SIT frequency detection and PVD call analysis.
/// • DX_PAMDENABLE – Enable PAMD, PVD, and fax tone detection.
/// This setting provides PAMD and PVD call analysis only (no call progress).
/// • DX_PAMDOPTEN – Enable PAMD, PVD, DX_OPTNOCON, and fax tone detection.
/// This setting provides full call progress and call analysis.
/// Default: DX_OPTNOCON
/// </summary>
[XmlElement("ca_intflg")]
public ushort ca_intflg;
/// <summary>
/// Minimum signal to qualify freq. detect.
/// </summary>
[XmlElement("ca_intfltr")]
public ushort ca_intfltr;
/// <summary>
/// reserved for future use
/// </summary>
[XmlElement("rfu1")]
public ushort rfu1;
/// <summary>
/// reserved for future use
/// </summary>
[XmlElement("rfu2")]
public ushort rfu2;
/// <summary>
/// reserved for future use
/// </summary>
[XmlElement("rfu3")]
public ushort rfu3;
/// <summary>
/// reserved for future use
/// </summary>
[XmlElement("rfu4")]
public ushort rfu4;
/// <summary>
/// Used to determine which lowmax to use.
/// </summary>
[XmlElement("ca_hisiz")]
public ushort ca_hisiz;
/// <summary>
/// Max. low before con. if high GT hisize.
/// </summary>
[XmlElement("ca_alowmax")]
public ushort ca_alowmax;
/// <summary>
/// Max. low before con. if high LT hisize.
/// </summary>
[XmlElement("ca_blowmax")]
public ushort ca_blowmax;
/// <summary>
/// Number of rings before analysis begins.
/// </summary>
[XmlElement("ca_nbrbeg")]
public ushort ca_nbrbeg;
/// <summary>
/// Maximum 2nd high dur. for a retrain.
/// </summary>
[XmlElement("ca_hi1ceil")]
public ushort ca_hi1ceil;
/// <summary>
/// Maximum 1st low dur. for a retrain.
/// </summary>
[XmlElement("ca_lo1ceil")]
public ushort ca_lo1ceil;
/// <summary>
/// Lower allowable frequency in hz.
/// Lower Frequency: Lower bound for first tone in Hz. 
/// Default: 900.
/// </summary>
[XmlElement("ca_lowerfrq")]
public ushort ca_lowerfrq;
/// <summary>
/// Upper allowable frequency in hz.
/// Upper Frequency: Upper bound for first tone in Hz. 
/// Default: 1000. Adjust higher for additional operator intercept tones.
/// </summary>
[XmlElement("ca_upperfrq")]
public ushort ca_upperfrq;
/// <summary>
/// Total duration of good signal required.
/// Time Frequency: Minimum time for first tone to remain in bounds. 
/// The minimum amount of time required for the audio signal to remain within the frequency detection range for it to be detected. 
/// The audio signal must not be greater than ca_upperfrq or lower than ca_lowerfrq for at least the time interval specified in ca_timefrq. 
/// Default: 5 (10 ms units) 
/// </summary>
[XmlElement("ca_timefrq")]
public ushort ca_timefrq;
/// <summary>
/// Allowable % of bad signal.  (Not Used)
/// </summary>
[XmlElement("ca_rejctfrq")]
public ushort ca_rejctfrq;
/// <summary>
/// Maximum duration of answer.
/// Maximum Answer: The maximum allowable length of ansrsize. When ansrsize exceeds ca_maxansr, a connect is returned to the application. 
/// Default: 1000 (in 10 ms units), or 10 seconds. 
/// </summary>
[XmlElement("ca_maxansr")]
public ushort ca_maxansr;
/// <summary>
/// Silence deglitching value for answer.
/// Answer Deglitcher: The maximum silence period (in 10 ms units) allowed between words in a salutation.
/// This parameter should be enabled only when you are interested in measuring the length of the salutation. Default: -1 (disabled). 
/// </summary>
[XmlElement("ca_ansrdgl")]
public ushort ca_ansrdgl;
/// <summary>
/// max time for 1st freq to remain in bounds
/// Maximum Time Frequency: Maximum allowable time for first tone to be present. 
/// Default: 0 (10 ms units). 
/// </summary>
[XmlElement("ca_mxtimefrq")]
public ushort ca_mxtimefrq;
/// <summary>
/// Lower Bound for second Frequency: Lower bound for second tone in Hz. 
/// Default: 0 
/// </summary>
[XmlElement("ca_lower2frq")]
public ushort ca_lower2frq;
/// <summary>
/// Upper Bound for second Frequency: Upper bound for second tone in Hz. 
/// Default: 0. 
/// </summary>
[XmlElement("ca_upper2frq")]
public ushort ca_upper2frq;
/// <summary>
/// min time for 2nd freq to remains in bounds
/// Time for second Frequency: Minimum time for second tone to remain in bounds. 
/// Default: 0 (10 ms units). 
/// </summary>
[XmlElement("ca_time2frq")]
public ushort ca_time2frq;
/// <summary>
/// max time for 2nd freq to remain in bounds
/// Maximum Time for second Frequency: Maximum allowable time for second tone to be present. 
/// Default: 0 (10 ms units). 
/// </summary>
[XmlElement("ca_mxtime2frq")]
public ushort ca_mxtime2frq;
/// <summary>
/// Lower Bound for third Frequency: Lower bound for third tone in Hz. 
/// Default: 0.
/// </summary>
[XmlElement("ca_lower3frq")]
public ushort ca_lower3frq;
/// <summary>
/// Upper Bound for third Frequency: Upper bound for third tone in Hz. 
/// Default: 0. 
/// </summary>
[XmlElement("ca_upper3frq")]
public ushort ca_upper3frq;
/// <summary>
/// min time for 3rd freq to remains in bounds
/// Time for third Frequency: Minimum time for third tone to remain in bounds. 
/// Default: 0 (10 ms units). 
/// </summary>
[XmlElement("ca_time3frq")]
public ushort ca_time3frq;
/// <summary>
/// max time for 3rd freq to remain in bounds
/// Maximum Time for third Frequency: Maximum allowable time for third tone to be present. 
/// Default: 0 (10 ms units)
/// </summary>
[XmlElement("ca_mxtime3frq")]
public ushort ca_mxtime3frq;
/// <summary>
/// Length of a valid dial tone (def=1sec)
/// Dial Tone Present: The length of time that the dial tone must be continuously present (in 10 ms units).
/// If a dial tone is present for this amount of time, dialing of the dial string proceeds. 
/// Default value: 100 (one second). 
/// </summary>
[XmlElement("ca_dtn_pres")]
public ushort ca_dtn_pres;
/// <summary>
/// Max time to wait for dial tone (def=3sec)
/// Dial Tone Not Present: The length of time to wait before declaring the dial tone not present (in 10 ms units). 
/// If a dial tone of sufficient length (ca_dtn_pres) is not found within this period of time, 
/// Call Analysis terminates with the reason CR_NODIALTONE. 
/// The dial tone character (L, I, or X) for the missing dial tone can be obtained using ATDX_DTNFAIL( ). 
/// Default value: 300 (three seconds). 
/// </summary>
[XmlElement("ca_dtn_npres")]
public ushort ca_dtn_npres;
/// <summary>
/// The dialtone off debouncer (def=100ms)
/// Dial Tone Debounce: The maximum duration of a break in an otherwise continuous dial tone before it is considered invalid (in 10 ms units).
/// This parameter is used for ignoring short drops in dial tone.
/// If a drop longer than ca_dtn_deboff occurs, then dial tone is no longer considered present, 
/// and another dial tone must begin and be continuous for ca_dtn_pres. 
/// Default value: 10 (100 msec). 
/// </summary>
[XmlElement("ca_dtn_deboff")]
public ushort ca_dtn_deboff;
/// <summary>
/// Wait for AMD/PVD after cadence break(default=4sec)
/// PAMD Fail Time. Maximum time to wait for positive answering machine detection or positive voice detection after a cadence break.
/// Default: 400 Units: 10 msec
/// </summary>
[XmlElement("ca_pamd_failtime")]
public ushort ca_pamd_failtime;
/// <summary>
/// min allowable ring duration (def=1.9sec)
/// Minimum PAMD ring: Minimum allowable ring duration for Positive Answering Machine Detection. 
/// Default Value: 190 (in 10 ms units). 
/// </summary>
[XmlElement("ca_pamd_minring")]
public ushort ca_pamd_minring;
/// <summary>
/// Set to 2 selects quick decision (def=1)
/// PAMD Speed Value. Quick or full evaluation for PAMD detection
/// • PAMD_FULL – Full evaluation of response
/// • PAMD_QUICK – Quick look at connect circumstances
/// • PAMD_ACCU – Recommended setting. Does the most accurate evaluation detecting live
/// voice as accurately as PAMD_FULL but is more accurate than PAMD_FULL (although
/// slightly slower) in detecting an answering machine. Use PAMD_ACCU when accuracy is
/// more important than speed.
/// Default: PAMD_ACCU
/// </summary>
[XmlElement("ca_pamd_spdval")]
public char ca_pamd_spdval;
/// <summary>
/// The Qualification template to use for PAMD
/// PAMD Qualification Template: The algorithm to use in PAMD. 
/// At present there is only one template: PAMD_QUAL1TMP. This parameter must be set to this value. 
/// </summary>
[XmlElement("ca_pamd_qtemp")]
public char ca_pamd_qtemp;
/// <summary>
/// time before no answer after first ring (default=30sec)
/// No Answer. Length of time to wait after first ringback before deciding that the call is not answered.
/// Default: 3000 Units: 10 msec
/// </summary>
[XmlElement("ca_noanswer")]
public ushort ca_noanswer;
/// <summary>
/// Max inter ring delay before connect (8 sec)
/// Maximum Inter-ring: The maximum length of time to wait between consecutive ringback signals (in 10 ms units).
/// If this duration is exceeded, Call Analysis is terminated with the reason CR_CONN (connected). Default value: 800 (8 seconds). 
/// </summary>
[XmlElement("ca_maxintering")]
public ushort ca_maxintering;
Was this article helpful to you? Yes 15 No

How can we help?