You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Release Request 0x012D

Resource Release Request 0x012D

SwitchKit Name

ResourceReleaseRequest

Type

EXS and SwitchKit API message

Description

Resource Release Request 0x012D

Use this message to connect to a resource.

Connecting to a different resource types

Use this generic message to specify different Resource Types. When used for Frequency Shift Keying (FSK), the mandatory Resource Type TLV 0x0602 will be set to either Send SMS (0x010C) or Receive SMS (0x010D) and sent from the Host to the switch to release the Data Link Layer connection in a SMS call.

Sent by

Host application

Related API Messages

Resource Create (0x0124)

Resource Modify (0x125)

Resource Delete (0x126)

SwitchKit Code

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[221];

} XL_ResourceReleaseRequest;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE DataType;

UBYTE TLVCount;

UBYTE Data[219];

} XL_ResourceReleaseRequest Ack;

C++ Class

class XLC_ResourceReleaseRequest: public XLC_OutboundMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

XBYTE getSpan() const ;

void setSpan(XBYTE x);

UBYTE getChannel() const ;

void setChannel(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(UBYTE x) ;

const UBYTE *getData() const ;

UBYTE *getData();

void setData(UBYTE *x) ;

};

C++ Class Response

class XLC_ResourceReleaseRequestAck : public

XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

XBYTE getParentConferenceID() const;

void setParentConferenceID(XBYTE x);

XBYTE getChildConferenceID() const;

void setChildConferenceID(XBYTE x);

XBYTE getSpan() const ;

void setSpan(XBYTE x);

UBYTE getChannel() const ;

void setChannel(UBYTE x);

UBYTE getDataType() const;

void setDataType(UBYTE x);

UBYTE getTLVCount() const ;

void setTLVCount(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 (0x0127) | 3, 4 | Message Type (0x0127)
5 | Reserved (0x00) | 5 | Reserved (0x00)
6 | Sequence Number | 6 | Same Sequence Number
7 | Logical Node ID | 7 | Logical Node ID
8, 9 | Status (MSB, LSB)
8 : | AIB Address Method 0x00 - Individual AEs | 10 . . . | AIB (same as message)
Number of AEs to follow | : | Data Type 0x00 TLVs
AEs When using this message for conferencing: Resource A 0x0D Channel | : | Number of TLVs to Follow
: | Data Type 0x00 TLVs | : | Mandatory Return TLVs 0x0602 Resource Type
: | Number of TLVs to Follow | : | Checksum
| Mandatory TLV 0x0602 Resource Type (This is the A Resource Type) If the Resource Type is set to Send SMS (0x010A) or Receive SMS (0x010B) 0x0694 Short Message Service (SMS) Data Optional TLV for Send SMS (0x010A) or Receive SMS (0x010B) 0x0695 FSK Modem Type
: | Checksum

Frequency Shift Keying
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.
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.