You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Inpulsing Parameters Configure 0x0028

Inpulsing Parameters Configure 0x0028

SwitchKit Name

InpulsingParametersConfig

Type

EXS API and SwitchKit API message

Description

The Inpulsing Parameters Configure message allows the host to configure inpulse data collection parameters on specified channels. Use inpulse parameters when data is collected by means of an Inseize Control instruction.

Call setup inpulsing parameters define the address signaling type, number of digit strings, and collection method used during call setup.

The Excel platform supports four different inpulsing stages, and each stage is defined as either one or two digit strings. When instructing the Excel platform to collect address signaling information that is typically presented with in-band dual frequency tones, the host must specify a preprogrammed inpulsing stage that describes how to perform the digit collection.

Each channel has four inpulsing stages that can be preprogrammed. The inpulsing stage configuration options include: the address signaling type (DTMF, MFR1, MFR2), the number of strings (1 or 2), and the string collection method (fixed number digits, KP/ST framed, compelled).

Sent by

Host

Example Message (Socket Log Output for SwitchKit)

The following socket log output/example message shows data being sent from the host to the Excel platform to configure inpulse data collection parameters on span 0x00, channels 0x00 - 0x17. The stage number being configured is 0x01 and the number of digit strings in the stage is 0x01. The stage complete timeout is three seconds and the address signaling type is DTMF. This message collects seven digits.

 

00 1a 00 28 00 00 ff 01 02 0d 03 00 00 00 0d 03 00 00 17 01 01 01 2c 01 01 07 01 07

SwitchKit Code

Configuration

InpulsingParametersConfig (

Node = integer,

Range = StartSpan:StartChan - EndSpan:EndChan,

Stage = integer,

NumDigitStrings = integer,

StageCompleteTimeout = integer,

AddrSignallingType = integer,

String1Method = integer,

String1Data = integer,

String2Method = integer,

String2Data = integer);

C Structure

typedef struct {

unsigned short StartSpan;

UBYTE StartChannel;

unsigned short EndSpan;

UBYTE EndChannel;

UBYTE Stage;

UBYTE NumDigitStrings;

unsigned short StageCompleteTimeout;

UBYTE AddrSignallingType;

UBYTE String1Method;

UBYTE String1Data;

UBYTE String2Method;

UBYTE String2Data;

} XL_InpulsingParametersConfig;

C++ Class

class XLC_InpulsingParametersConfig : public XLC_ChanRangeMessage {

public:

unsigned short getStartSpan() const;

void setStartSpan(unsigned short x);

UBYTE getStartChannel() const;

void setStartChannel(UBYTE x);

unsigned short getEndSpan() const;

void setEndSpan(unsigned short x);

UBYTE getEndChannel() const;

void setEndChannel(UBYTE x);

UBYTE getStage() const;

void setStage(UBYTE x);

UBYTE getNumDigitStrings() const;

void setNumDigitStrings(UBYTE x);

unsigned short getStageCompleteTimeout() const;

void setStageCompleteTimeout(unsigned short x);

UBYTE getAddrSignallingType() const;

void setAddrSignallingType(UBYTE x);

UBYTE getString1Method() const;

void setString1Method(UBYTE x);

UBYTE getString1Data() const;

void setString1Data(UBYTE x);

UBYTE getString2Method() const;

void setString2Method(UBYTE x);

UBYTE getString2Data() const;

void setString2Data(UBYTE x);

};

 

EXS API Hex Format

MESSAGE (White)

RESPONSE (Gray)

Byte

Field Description

Byte

Field Description

0

Frame (0xFE)

0

Frame (0xFE)

1, 2

Length (0x00NN)

1, 2

Length (0x0007)

3, 4

Message Type (0x0028)

3, 4

Message Type (0x0028)

5

Reserved (0x00)

5

Reserved (0x00)

6

Sequence Number

6

Same Sequence Number

7

Logical Node ID

7

Logical Node ID

:

AIB

Address Method

0x01 - Range of AEs

8, 9

Status (MSB, LSB)

10

Checksum

Number of AEs to follow

AEs

0x0D Channel (Starting)

0x0D Channel (Ending)

:

Stage Number

Inpulsing Stage number to configure (1–4)

:

Number of Digit Strings

Number of digit strings in stage (1–2)

:

Stage Complete Time Out (MSB, LSB)

The maximum amount of time from the detection of the first digit until all digits have been
collected for the stage.The first digit must be detected or the receive first digit timer must
expire before this timer is active. See the "Timer Conversion Table"

 

Address Signaling Type

The address signaling type must be the same for both strings within a stage, but may differ
between stages.

0x01 DTMF

0x02 MFR1

0x03 MFR2

0x04 Reserved

0x05 Dial Pulse

 

String 1: Collection Method

0x01 Fixed Number of Digits

0x02 Use Termination Digit

0x03 Use KP/ST Signals; Do Not Send To Host

KP and ST signals (ST, STI, STII, STIII) are not included in the string sent to the host
in the Request For Service message. This method is only valid for MFR1 signaling.


0x04 Reserved

0x05 Compelled

This method is only valid for MFR2 signaling.


0x06 Use KP/ST Signals; Include in Digit String

KP and ST signals (ST, STI, STII, STIII) will be included in the string sent to the host
in the Request For Service message. This method is only valid for MFR1 signaling.


0x07 Compelled KP (MF-MDR1)

The KP and ST digits will not be included in the string that is reported to the host.


0x08 Fixed or Indefinite Number of Digits

If the first digit detected is zero, the Indefinite Number of Digits method is used and
the Completion Timer or Interdigit Timer is used (whichever expires first) to terminate
digit collection. If the first digit collected is not zero, the Fixed Number of Digits method
is used. This method is used to help facilitate collecting digit strings on channels that
process national and international calls.

 

 

String 1: Collection Data

Data is dependent on the value of the String Collection Method.


Fixed Number of Digits

Digit Count (0x00–0x64).
Set this value to 0xFF if you want the Excel platform to continue requesting Forward R2 signals
until no more are received. This option is valid for MFR2 only.


Use Termination Digit

Digit Value (0x00–0x0F)


Use KP_ST Signals

No data (0x00)


Compelled

Digit Count (0x00–0x64).
Set this value to 0xFF if you want the Excel platform to continue requesting Forward
R2 signals until no more are received. This option is valid for MFR2 only.

 

 

String 2: Collection Method

 

If only one string is being collected, enter 0x00 for this field.

 

String 2: Collection Data

 

If only one string is being collected, enter 0x00 for this field.

:

Checksum

 

Default Inpulse Parameters

The number of strings for each stage for each span listed below is 1.

T1 Spans

The information for each stage is identical.

Stages 1–4

Stage Complete Timer

12,000 ms

Address Signaling Type

MFR1

Collection Method

Use KP_ST, KP, and ST digits not reported to host.

E1 Spans

Stage 1

Stage Complete Timer

12,000 ms

Address Signaling Type

MFR2

Collection Method

Compelled

Collection Data

0x03 (Area Code)

Stage 2

Stage Complete Timer

12,000 ms

Address Signaling Type

MFR2

Collection Method

Compelled

Collection Data

0x0A (CLI, Calling Line ID)

Stage 3

Stage Complete Timer

12,000 ms

Address Signaling Type

MFR2

Collection Method

Compelled

Collection Data

0x07 (Called Party Address)

Stage 4

Stage Complete Timer

12,000 ms

Address Signaling Type

MFR2

Collection Method

Compelled

Collection Data

0x01 (Group 2 Category Digit)