You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Channel Released With Data 0x0069
Channel Released With Data 0x0069
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
This message indicates that the network has initiated a release with associated data. If no parameter data is associated with the call release, then a Channel Released (0x49) message is sent instead.
For a VoIP call, a Release TLV will appear in the message in the Extended ICB. For SS7 TUP, Release parameters are included in a BT IUP parameters ICB. When BT IUP is configured, then a BT IUP ICB with a release TLV may be present.
For SwitchKit Only
When an ICBType field is set to 0x03, use the following methods for extracting the data of the fields shown in the following table.
If the field is... |
then the method for extracting the data is... |
---|---|
ICBSubType |
sk_extractExtendedICBFromChannelReleasedWithData() |
ICBLength |
sk_extractExtendedICBFromChannelReleasedWithData() |
ICBData |
sk_extractExtendedICBFromChannelReleasedWithData() |
getICBSubType() |
getExtendedICBSubtype() |
getICBLength() |
getExtendedICBLength() |
getICBData() |
getExtendedICBData() |
Sent by
Excel platform
Resent in EXS API
This message is resent once after five seconds.
Example Message
(Log Output in SwitchKit)
The following socket log output/example message is an H.323 call, that the network has initiated a release with a Release TLV indicating Invalid Permission Chosen, Facility Call Deflection.
00 5d 00 69 00 2c 01 00 01 0d 03 00 00 04
02 02 1e 2a 00 05 01 04 00 04 00 00 00 00
01 05 00 04 00 00 00 00 01 11 00 04 00 00
00 00 01 10 00 04 00 00 00 00 01 12 00 04
00 00 00 00 03 00 33 00 1e 00 04 27 4e 00
02 00 10 27 92 00 04 c0 a8 00 1a 27 93 00
04 00 00 20 5c 27 e3 00 02 02 0c
SwitchKit Code
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
UBYTE ICBCount;
UBYTE ICBType;
UBYTE ICBSubtype;
UBYTE ICBLength;
UBYTE ICBData[219];
} XL_ChannelReleasedWithData;
DllExport bool
sk_extractExtendedICBFromChannelReleasedWithData(in
t* xtICBSubtype, int* xtICBLength, UBYTE** ICBData,
XL_ChannelReleasedWithData* crwd)
C++ Class
class XLC_ChannelReleasedWithData : public XLC_OneChannelMessage {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getICBCount() const;
void setICBCount(UBYTE x);
UBYTE getICBType() const;
void setICBType(UBYTE x);
UBYTE getICBSubtype() const;
void setICBSubtype(UBYTE x);
UBYTE getICBLength() const;
void setICBLength(UBYTE x);
const UBYTE *getICBData() const;
UBYTE *getICBData();
void setICBData(UBYTE *x);
XBYTE getExtendedICBSubtype() const;
XBYTE getExtendedICBLength() const;
const UBYTE *getExtendedICBData() const;
UBYTE *getExtendedICBData();
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0xNNNN) |
1, 2 |
Length (0x0005) |
3, 4 |
Message Type (0x0069) |
3, 4 |
Message Type (0x0069) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 |
Address Method 0x00 - Individual AEs |
8 |
Checksum |
Number of AEs to follow |
|||
AE |
|||
: |
Number of ICBs to follow (Ignore this field if no ICBs in message.) |
||
: |
ICB 0x1E Generic PPL in Channel Released with Data 0x1F SS7 Unformatted Raw Parameters |
||
|
Refer to Interworking TLVs if you have enabled interworking from the VoIP Protocol Configure 0x00EE message. |
||
: |
Checksum |
0x1E Generic PPL in Channel Released with Data
When an IP channel is released, the Excel platform sends a Channel Released with Data message to the host. The message contains the following data, providing IP statistics for the IP call:
ICB Type |
Data (0x02) |
ICB ID |
Generic PPL ICB (0x1E) |
Data Length |
0x2A |
Number of TLVs |
0x0005 |
Tag |
0x01 04 RTP Packets Lost |
Length |
0x0004 |
Value (4 Bytes) |
Data[0-3] Number of Packets |
Tag |
RTP Packets Received (0x0105) |
Length |
0x0004 |
Value (4 Bytes) |
Data[0-3] Number of Packets |
Tag |
RTP Packets Sent (0x0111) |
Length |
0x0004 |
Value (4 Bytes) |
Data[0-3] Number of Packets |
Tag |
RTP Octets Received (0x0110) |
Length |
0x0004 |
Value (4 Bytes) |
Data[0-3] Number of Octets |
Tag |
RTP Octets Sent (0x0112) |
Length |
0x0004 |
Value (4 Bytes) |
Data[0-3] Number of Octets |
0x0033 NPDI Universal ICB in Channel Released with Data
ICB Type |
Data (0x03) |
ICB ID |
NPDI (0x0033) |
Data Length |
Variable |
Number of TLVs |
0x0004 |
Tag |
RTP IP (0x2792) |
Length |
0x0004 |
Value (4 Bytes) |
Variable |
Tag |
RTP Port (0x2793) |
Length |
0x0004 |
Value (4 Bytes) |
Variable |
Tag |
NPDI Message Type (0x274E) |
Length |
0x0002 |
Value (2 Bytes) |
Variable |
Tag |
Release Cause Code (0x27E3) For H.323 |
Length |
0x0002 |
Value (2 Bytes) |
Variable |