Request For Service With Data 0x002D

SwitchKit Name

RFSWithData

Type

EXS API and SwitchKit API message

Description

This message is sent to the host when an incoming call is detected on the specified channel and the specified channel was previously configured to "report incoming call with digits."

For SS7, the system uses this message as a response to an IAM message from the network. By default, BT IUP parameters are reported to the host in a BT IUP parameters ICB. The host can modify this to have address data sent as BCD-encoded digits.

SIP endpoints report incoming calls from the SIP side using the Request for Service with Data message. The data type Universal Data (0x33) is for SIP calls. The UPDF parameters supported are the same as those supported in the Route Control message.

H.323 endpoints report incoming calls from the H.323 side using the Request for Service with Data message. A new address data type of Universal Data (0x33) has been added for H.323. The UPDF parameters supported are the same as those supported in the Route Control message.

Sent by

Excel platform

Resent

This message is resent once after five seconds. It includes a field to indicate it has been resent.

Example Message (Socket Log Output)

In the example message below, phone 333@10.10.65.37 is calling phone 666. Phone 333 is registered with the Excel platform, which is at IP address 10.10.65.20.

00 a3 00 2d 00 03 ff 00 01 0d 03 00 01 05 00 33

01 03 00 33 00 8f 00 0f 27 4e 00 02 00 05

27 7e 00 03 08 00 00 29 19 00 04 36 36 36 00

29 1b 00 0c 31 30 2e 31 30 2e 36 35 2e 32 30 00

29 23 00 04 33 33 33 00

29 25 00 0c 31 30 2e 31 30 2e 36 35 2e 32 30 00

27 18 00 07 02 00 00 00 03 33 30

27 17 00 05 02 00 03 66 60

27 94 00 04 0a 0a 41 25

27 95 00 04 00 00 4c dc

27 b0 00 02 00 02

27 b1 00 02 00 01 29 2d 00 04 33 33 33 00

29 2f 00 0c 31 30 2e 31 30 2e 36 35 2e 33 37 00

29 30 00 04 00 00 13 c4

SwitchKit Code

C Structure

typedef struct {

unsigned short Span;

UBYTE Channel;

UBYTE ResendFlag;

UBYTE AddressDataType;

UBYTE Data[221];

} XL_RFSWithData;

C++ Class

class XLC_RFSWithData : public XLC_OneChannelMessage {

public:

unsigned short getSpan() const;

void setSpan(unsigned short x);

UBYTE getChannel() const;

void setChannel(UBYTE x);

UBYTE getResendFlag() const;

void setResendFlag(UBYTE x);

UBYTE getAddressDataType() const;

void setAddressDataType(UBYTE x);

const UBYTE *getData() const;

UBYTE *getData();

void setData(UBYTE *x);

};

EXS API Hex Format

Data

0x01 BCD-Encoded Stages

Data[0] Stage Count (X)

Data[1] Stage 1 Status

Data[2] Stage 1 String Count

Data[3] Stage 1: String 1Digit Count

Data[4] Stage 1: String 1First BCD-Encoded digit pair

Data[5] :

Data[n] Stage 1: String 1 Last BCD-Encoded digit pair

Data[...] Stage 1: String 2 Digit Count

Data[...] Stage 1: String 2 First BCD-Encoded digit pair

Data[...] :

Data[...] Stage 1: String x Last BCD-Encoded digit pair

: :

Data[...] Stage X Status

Data[...] Stage X String Count

Data[...] Stage X: String 1Digit Count

Data[...] Stage X: String 1First BCD-Encoded digit pair

Data[...] :

Data[N+1] Stage X: String x Last BCD-Encoded digit pair

Stage Status

The system reports the stage status for each of the five stages. Timers can be configured.

Valid entries for this field are as follows:

0x10 Positive Acknowledgment – Digits received

0x80 Partial Dial Condition – Receive Inter-digit Duration timer expired

0x81 Permanent Signal Condition – Receive 1st Digit Detection Timer expired

0x91 Inpulse Stage Not Collected – Stage not collected; no further stage information will be reported.

0x92 Digit Complete Timeout

NOTES:

1 Each stage may contain up to two strings.

2 Valid responses to this message may also be Connect, Connect With Pad, Connect One-Way Forced, Connect With Data, Connect Wait, Connect To Conference, Connect One-Way To Conference, and Park Channel.

0x04 Q.931 Received Frame

This data is allowed for the ISDN interface only and will be the exact data received from the distant end (see ITU Q.931).

Data[0] Protocol Discriminator

Data[1] Call Reference Length

Data[2] :