You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Connect With Data 0x0005

Connect With Data 0x0005

SwitchKit Name

ConnectWithData

Type

EXS API and SwitchKit API message

Description

Connect With Data 0x0005

This message instructs the CSP to connect two channels.

This message also supports canceling digit collection, playing of call progress tones, voice path connect functionality, and dynamic configuration of release modes.

ISDN

If the terminating channel is not in an idle state, after seizure the alerting and connect indications will get propagated to the incoming side and the data specified in this message will get sent to the incoming ISDN channel.

SS7

You can use this message to pass parameter data for the ACM, ANM, or CON (ITU-TS only) in a connection between an incoming SS7 call (A Party) and another channel.

SIP (Call Agent)

The message carries the B side SDP (Session Description Protocol) information to the CSP in an NPDI Universal ICB and Generic PPL ICB. In a Generic PPL ICB, the Channel Service TLV indicates whether a bearer-switched or bearer-free connection is requested. For a bearer-free connection, the B side connection information is passed in the NPDI Universal ICB from the host.

Sent by

Host

Example Message for EXS API

The following example message uses the Release Mode Configure ICB in a Connect With Data message to park Channel A (Span 0, Channel 0) and release Channel B (Span 0, Channel 1).

00 0D 00 05 00 00 FF 01 02 0D 03 00 00 00 0D 03 00 00 01 01 01 01 02 02 01 02

SwitchKit Code

C Structure

typedef struct {

unsigned short SpanA;

UBYTE ChannelA;

unsigned short SpanB;

UBYTE ChannelB;

UBYTE ConnectDataType;

UBYTE Data[222];

} XL_ConnectWithData;

C++ Class

class XLC_ConnectWithData : public XLC_OutboundMessage {

public:

unsigned short getSpanA() const;

void setSpanA(unsigned short x);

UBYTE getChannelA() const;

void setChannelA(UBYTE x);

unsigned short getSpanB() const;

void setSpanB(unsigned short x);

UBYTE getChannelB() const;

void setChannelB(UBYTE x);

UBYTE getConnectDataType() const;

void setConnectDataType(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 (MSB, LSB) 0x00NN | 1, 2 | Length (0x0007)
3, 4 | Message Type (0x0005) | 3, 4 | Message Type (0x0005)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
: | AIB Address Method 0x00 - Individual AEs | 8, 9 | Status (MSB, LSB) 0x0001 Invalid TLV Data Software cannot find the TLV Data Buffer. This can also occur if the Data for a TLV is out of range. 0x0004 Invalid TLV Length The TLV length is different from what is expected. 0x0006 Invalid TLV Unknown TLV Also see Common Response Status Values in the API Reference.
10, 11 | State (MSB, LSB) If the MSB of the preceding Status field is 0x18 (Invalid Channel B State) or 0x1D (Invalid Channel A State), then this field indicates the component state. If the State value is greater than 0xFF (255), then it is truncated to 0xFF. If the MSB of the preceding Status field is neither 0x18 nor 0x1D, then the value in this field is 0x0000. If the preceding Status field is a positive acknowledgement, this field does not apply.
12 | Checksum
Number of AEs to follow 0x02
AEs 0x0D Channel A 0x0D Channel B
: | Connect Data Type 0x01 Use ICBs 0x02 Reserved
: | Number of ICBs to follow (Ignore this field if no ICBs in message.)
: | Data (presented in an ICB) 0x01 Action ICBs 0x01 Free System Resources 0x02 Release Mode Configure 0x02 Data ICBs 0x12 SS7 Parameters 0x17 ISDN Formatted IEs With Event 0x18 ISDN Raw IEs with Event 0x1C SS7 TUP Formatted Fields 0x26 Channel Pad Value 0x03 Extended Data 0x001E Generic PPL 0x0026 Channel Pad Value 0x0033 NPDI Universal ICB
: | Checksum

See Integrated Services Digital Network.
See Signaling System Number Seven.
International Telecommunications Union (UN)
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.
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.
See Information Control Block.
See Programmable Protocol Language.
Tag-Length-Value block. A standardized block that allows data to inserted in a standard way into API messages.
A computer, attached to the Excel platform through an RS-232 or Ethernet link, from which you run the telecommunications application that controls the Excel platform.
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.
Most Significant Bit
Least Significant Bit
See Address Information Block.
The condition of a component at a given instant. The current "context" of a PPL object, such as Idle, Seizing, Answered. In PPL files, a State is represented by a circle.