You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > SS7 CIC Query 0x0067
Query API Messages
SwitchKit Name
SS7CICQuery
Type
EXS API and SwitchKit API message
Description
This message retrieves CIC configuration information.
Sent by
SwitchKit Code
C Structure
typedef struct {
UBYTE StackID;
int DPC;
unsigned short BaseCIC;
UBYTE NumCICs;
UBYTE CallControlUserPart;
} XL_SS7CICQuery;
C Structure Response
typedef struct {
unsigned short Status;
UBYTE StackID;
unsigned short BaseCICNumber;
unsigned short BaseCICSpan;
UBYTE BaseCICChannel;
UBYTE NumCICs;
int DPC;
UBYTE Data[217];
} XL_SS7CICQueryAck;
C++ Class
class XLC_SS7CICQuery : public XLC_OutboundMessage {
public:
UBYTE getStackID() const;
void setStackID(UBYTE x);
int getDPC() const;
void setDPC(int x);
unsigned short getBaseCIC() const;
void setBaseCIC(unsigned short x);
UBYTE getNumCICs() const;
void setNumCICs(UBYTE x);
UBYTE getCallControlUserPart() const;
void setCallControlUserPart(UBYTE x);
};
C++ Class Response
class XLC_SS7CICQueryAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
UBYTE getStackID() const;
void setStackID(UBYTE x);
unsigned short getBaseCICNumber() const;
void setBaseCICNumber(unsigned short x);
unsigned short getBaseCICSpan() const;
void setBaseCICSpan(unsigned short x);
UBYTE getBaseCICChannel() const;
void setBaseCICChannel(UBYTE x);
UBYTE getNumCICs() const;
void setNumCICs(UBYTE x);
int getDPC() const ;
void setDPC(int x);
const UBYTE *getData() const;
UBYTE *getData();
void setData(UBYTE *x);
};
EXS API Hex Format
NOTE: The five fields listed in the Response (Gray) starting with (CIC n Status and ending with CIC n PCM Encoding Format) are repeated for each CIC. The SS7 CIC Group address type contains the number of CICs.
|
MESSAGE (White) |
RESPONSE (Gray) |
||
|
Byte |
Field Description |
Byte |
Field Description |
|
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
|
1 |
Length (0xNNNN) |
1 |
Length (0xNNNN) |
|
3 |
Message Type (0x0067) |
3 |
Message Type (0x0067) |
|
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
|
6 |
Sequence Number |
6 |
Same Sequence Number |
|
7 |
Logical Node ID |
7 |
Logical Node ID |
|
8 : |
0x00 - Individual AEs or 0x01 - Range |
8, 9 |
|
|
Number of AEs to follow |
10 : |
AIB Address Method 0x00 - Individual AEs |
|
|
AEs Individual AEs or Range
|
Number of AEs to follow |
||
|
AE |
|||
|
: |
DPC (four bytes) The configured Destination Point Code value for the selected Destination ID.
Applies to 0x08 SS7 Stack AE only. |
: |
DPC (four bytes) for CIC Group 1 Base CIC for CIC Group 1 CIC counts for CIC Group 1 ... DPC (four bytes) for CIC Group N Base CIC for CIC Group N CIC counts for CIC Group N
|
|
: |
Base CIC Number MSB, LSB
Applies to 0x08 SS7 Stack AE only. |
||
|
: |
Number of CICs in Query The number of CICs cannot exceed the number of CICs defined for a CIC group. Only one CIC group can be queried at one time. |
||
|
: |
Call Control User Part This field indicates the Call Control User Part used for the CIC: 0x00 ISUP 0x01 TUP 0x02 ISUP/Japanese ISUP 0x31 SS7 VCIC |
||
|
: |
Checksum |
||
|
: |
Response continued below.
CIC n Status (MSB, LSB only if using TUP) This field is a bit mask. The length of this field depends on the value of the Call Control User Part field: If the value of the Call Control User Part field is 0x00 or 0x02 (ISUP), this field is 1 byte. If the value of the Call Control User Part field is 0x01 (TUP), the field is 2 bytes.
ISUP (1 Byte) Bit Status 0 Circuit Remote Hardware Block State (ITU only) 1 Circuit Local Hardware Block State (ITU only) 2 Circuit Remote Maintenance Block State 3 Circuit Local Maintenance Block State
4–5 CPC State
0 Idle 1 Incoming Busy 2 Outgoing Busy
6 Circuit Transient State 7 Circuit Locally Unequipped State
|
||
|
|
TUP (2 Bytes) Bit Status 0 Remote Maintenance Block Status
0 Not Blocked 1 Blocked
1 Local Maintenance Block Status
0 Not Blocked 1 Blocked
2 Remote Hardware Block Status
0 Not Blocked 1 Blocked
3 Local Hardware Block Status
0 Not Blocked 1 Blocked
4 Remote Software Block Status
0 Not Blocked 1 Blocked
5 Local Software Block Status
0 Not Blocked 1 Blocked
6–7 Reserved
8–10 Call Status
0 Unknown 1 Idle 2 Incoming Seized 3 Outgoing Seized 4 Incoming CC Active
11 Equipped Status
0 Not Equipped 1 Equipped
12–15 Reserved |
||
|
|
SSUTR2 (2 Bytes) Bit Status 0 Outgoing Maintenance Block Status
0 Not Blocked 1 Blocked
1 Incoming Maintenance Block Status
0 Not Blocked 1 Blocked
2 Outgoing Manual Block Status
0 Not Blocked 1 Blocked
3 Transmission Error Block Status
0 Not Blocked 1 Blocked
4 Internal System Error Block Status
0 Not Blocked 1 Blocked
5 Reset Active Status
0 Not Active 1 Active
6-7 Test Call Status
0 Idle 1 Outgoing Call 2 Incoming Call
8-9 Call Status
0 Idle 1 Outgoing Call 2 Incoming Call
|
||
|
: |
10 Incoming Community status
0 Not Active 1 Active
11 Outgoing Continuity Status
0 Not Active 1 Active
12 Equipped Status
0 Not equipped 1 Equipped
13-15 Reserved |
||
|
|
CIC n Local End Release Mode 0x01 Park 0x02 Release (Default) |
||
|
: |
CIC n Distant End Release Mode (not applicable for SS7 VCIC): 0x01 Park 0x02 Release (Default) |
||
|
: |
CIC n Answer Supervision (not applicable for SS7 VCIC): 0x00 Propagate Answer to the Distant End (Default) 0x01 Notify Host of Answer 0x02 Propagate Answer to the Distant End and Notify Host of Answer 0x03 No Answer Supervision (No propagation notification of Answer) |
||
|
: |
CIC n PCM Encoding Format (not applicable for SS7 VCIC): 0x01 µ-law Encoding (default for ANSI ISUP) 0x02 A-law Encoding (default for ITU ISUP) |
||
|
: |
Checksum |
||
CIC Status
SS7 Virtual CIC
0x01 Virtual CIC
0x00 Physical CIC