You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Request For Service With Data 0x002D

Request For Service With Data 0x002D

SwitchKit Name

RFSWithData

Type

EXS API and SwitchKit API message

Description

Request For Service With Data 0x002D

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. The data type Universal Data (0x33) is for H.323 calls. The UPDF parameters supported are the same as those supported in the Route Control message.

Sent by

CSP

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 CSP, 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

MESSAGE (White) | RESPONSE (Gray)
Byte | Field Description | Byte | Field Description
0 | Frame (0xFE) | 0 | Frame (0xFE)
1, 2 | Length (0x00NN) | 1, 2 | Length (0x00NN)
3, 4 | Message Type (0x002D) | 3, 4 | Message Type (0x002D)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8 : | AIB Address Method 0x00 - Individual AEs | 8 | AIB Same as message.
: | Checksum
Number of AEs to follow |
AEs 0x0D Channel
: | Resend Flag 0x00 Request for Service With Data is not a resend 0x01 Request for Service With Data is a resend
: | Address Data Type 0x01 BCD-Encoded Stages (not an ICB: see BCD Encoded Stages data below table) 0x03 ISDN ICB 0x04 Q.931 Received Frame 0x05 SS7 ICB 0x06 DASS2/DPNSS 0x07 BT IUP 0x33 NPDI Universal ICB
: | Number of ICBs (or BCD Stages) to follow.
| ICBs For Address Data Type 0x03, the following ICBs can be used: 0x10 ISDN Formatted IEs 0x11 ISDN Raw IEs 0x25 ISDN Segmented Message For Address Data Type 0x05, the following ICBs can be used: 0x12 SS7 Parameters 0x1C SS7 TUP Formatted Fields 0x66 SS7 Address Information For Address Data Type 0x06, the following ICB can be used: 0x15 DASS2/DPNSS Raw Data For Address Data Type 0x07, the following ICB can be used: 0x23 BT IUP Parameters For Address Data Type 0x33, the following ICB can be used: 0x0033 NPDI Universal ICB
: | Data[0] (See information below table)
| Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message.
: | Checksum

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] :

RFS. A Status Message indicating that some entity is requesting service from the Excel platform.
See Signaling System Number Seven.
See Information Control Block.
Session-Initiation Protocol. A signaling protocol used for establishing sessions in an IP network. A session could be a simple, two-way telephone call, or it could be a collaborative multi-media conference session.
See Universal Protocol Data Format.
ITU-T standard defines a set of call control, channel setup, and codec specifications for transmitting real-time voice and video over networks that do not offer guaranteed service or quality of service.
Internet Protocol. Part of the TCP/IP family of protocols used to route messages and tracks the addresses of nodes.
Range of channels provided by T1 or E1 transmission service. A physical span is a group of channels taking up a single physical wire. A logical span is a group of channels taking up less than a single logical wire, or carried over more than one physical wire.
A group of data bits in a specific format, with a flag at each end to indicate the beginning and the end of the frame.
See Address Information Block.
Message delimiter (SS7 bit pattern - 01111110)
See Integrated Services Digital Network.
Call signaling protocol for setup and termination of calls.
Network Protocol Data Intelligence. Also called “Interworking,” it is a software product that operates within Excel’s Call Control (Layer 4) and Services (Layer 5) call processing layers. NPDI is meant to enhance Excel’s call processing product offering by allowing call processing layers (specifically Layers 4 and 5) to perform advanced analysis, generation, and conversion of Network Signaling (NS) Layer 3 information.
Notation that describes line card redundancy, where N is the number of installed line cards of a single card type and 1 is an additional line card of that type designated as a standby card. For example, if you have three T-ONE cards and one additional standby T-ONE card installed, the system provides redundancy by activating the standby card if any of the three active T-ONE cards fail.
International Telecommunications Union (UN)