You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > DS0 Status Change 0x0042
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
This message informs the host of the current status of the channel specified. It is sent when the status of a channel has changed. All host applications must be designed to handle this message for out-of-service and in-service conditions.
Sent by
Excel platform
Resent
This message is resent once after five seconds.
SwitchKit Code
C Structure
typedef struct {
BaseFields Base;
UBYTE AddrInfo[30];
UBYTE ChannelStatus;
UBYTE PurgeStatus;
} XL_DS0StatusChange;
C++ Class
class XLC_DS0StatusChange : public XLC_InboundMessage {
public:
const UBYTE *getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
XBYTE getStartSpan() const;
void setStartSpan(XBYTE x);
UBYTE getStartChannel() const;
void setStartChannel(UBYTE x);
XBYTE getEndSpan() const;
void setEndSpan(XBYTE x);
UBYTE getEndChannel() const ;
void setEndChannel(UBYTE x);
XBYTE getSpan() const;
void setSpan(XBYTE x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getChannelStatus() const;
void setChannelStatus(UBYTE x);
UBYTE getPurgeStatus() const;
void setPurgeStatus(UBYTE x);
};
Tip for C Programmers
To extract the span and channel in the C version of the API, you need to use the following code:
CASE_DS0StatusChange(ds0) {
printf("DS0 Stat Change, Span:%d, Chan:%d, Purge:%X\n",
sk_getAIBSpan(ds0->AddrInfo),
sk_getAIBChannel(ds0->AddrInfo),
ds0->ChannelStatus,
ds0->PurgeStatus);
return OK;
}
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 (0x0005) |
3, 4 |
Message Type (0x0042) |
3, 4 |
Message Type (0x0042) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
: |
Address Method 0x00 - Individual AEs
or for Line Card Busy:
0x01 - Range of AEs |
8 |
Checksum |
Number of AEs to follow |
|||
AEs
or
0x0D Channel (Starting) 0x0D Channel (Ending) |
|||
: |
Channel Status 0x00 Purge 0x01 Out of Service 0x02 In Service 0x03 Reserved 0x04 Parked 0x05 Blocked 0x06 Unblocked 0x07 Out-of-Service Maintenance Loopback |
||
: |
Purge Reason (See table below) |
||
: |
Checksum |
Purge Reason
If the Channel Status is 0x00 (Purge), consult the table below for the Purge Reason and corrective action. Otherwise, this field is 0x00.
Value |
Description |
Comments |
Corrective User Action |
---|---|---|---|
0x01 |
Reserved |
|
|
0x02 |
Configuration Non-dormant |
Reserved |
Contact Excel Tech Support |
0x03 |
Reserved |
Reserved |
Contact Excel Tech Support |
0x04 |
Disabled While Non-dormant |
Reserved |
Contact Excel Tech Support |
0x05 |
Channel B did not respond to connect request from Channel A within 30 seconds. |
None—the Excel platform has no control over the remote channel. |
|
0x06 |
Internal Disconnect ACK Timeout |
Channel B did not respond to a disconnect request from Channel A within 6 seconds. |
None—the Excel platform has no control over the remote channel. |
0x07 |
Internal Connect ACK Timeout |
Reserved |
Contact Excel Tech Support |
0x0A |
Invalid RCM Stack |
The RCM stack is either full or in an incorrect state. |
Contact Excel Tech Support |
0x0B |
FEM Outseize ACK Timeout |
Layer 4 did not receive an Outseize Control ACK from Layer 3 within 29 seconds. |
If using PPL for L3, make sure the Outseize Control ACK is sent from Layer 3 to Layer 4; otherwise, contact Excel Technical Support. |
0x0C |
Internal Inconsistency |
The RCM stack is in a state inappropriate for the action being processed. |
Contact Excel Tech Support |
0x0D |
L3 Clear ACK Timeout |
Layer 3 did not respond to a clear request within 150 seconds. |
If using PPL for L3, make sure that a Clear ACK is sent from L3 to L4; otherwise, contact Excel Technical Support. |
0x0E |
L4 Hold ACK Wait Timeout |
Reserved |
Contact Excel Technical Support. |
0x0F |
L3 Answer Wait Timeout |
Layer 4 timed-out waiting for a L3 answer event. |
If using PPL for L3, make sure a CONNECT is sent from L3 to L4. Otherwise, contact Excel Technical Support. |
0x10 |
L4 Answer Wait Timeout |
Layer 4 timed-out while waiting for the other party involved in the connection to propagate an answer. |
Verify answer supervision mode. |
0x11 |
L4 Recall Wait Timeout |
Timed-out while trying to recall the remote RCM. |
Contact Excel Tech Support |
0x12 |
L3 Channel Out-of-Service |
Channel A did not respond to a Channel Release Request from Channel B. L4 purges in order to bring the purging timeslot into a known state. |
None, the Excel platform has no control over the remote channel. |
0x13 |
Implicated by L3 |
Reserved. |
Contact Excel Tech Support |
0x14 |
Implicated by L4 |
One of the terminating channels has detected an internal error and has been disabled. It also had its status changed to dead and has been reconfigured to some non-idle state or has been implicated in another purge. |
Contact Excel Tech Support. |
0x15 |
Implicated by LCM |
One of the terminating channels has detected an internal error and has been disabled. It also had its status changed to dead and has been reconfigured to some non-idle state, or has been implicated in another purge. |
Contact Excel Tech Support |
0x16 |
Unknown LSM State |
Reserved. |
Contact Excel Tech Support |
0x17 |
L3 Pre-Answer Disconnect Request |
Reserved. |
Contact Excel Tech Support |
0x18 |
L3 Not Idle at Switchover |
Layer 4 is idle and Layer 3 is not idle at switchover. This brings the channel into a known state. |
Make sure Layer 3 is idle before issuing a switchover. |
0x19 |
Outpulsed Digits Timeout |
L4 went out of service. |
Contact Excel Tech Support |
0x1A |
Channel bearer service modification request failed.
|
Two possible reasons:
The VDAC-ONE card/IP Network Interface Card is not responding to the modification request.
The network is not responding to the modification request.
|
Check if the end-point signaling with the Excel platform properly acknowledged the modification request. (For example, a RE-INVITE in SIP networks.)
Contact Excel Tech Support |
0x1B |
Channel bearer service modification request timed out. |
Layer 4 did not receive any response to modify channel bearer service request from Layer 3 within the allowed time. |
Check if the end-point signaling with the Excel platform properly acknowledged the modification request ((For example, a RE-INVITE in SIP networks.)
Contact Excel Tech Support |
0x1C |
Request to retrieve a physical span/channel resource denied by the internal router. |
The virtual span/channel’s request to retrieve a physical span/channel denied by the internal router. |
Check if the resource table configuration with internal router is proper.
Contact Excel Tech Support |
01D |
Request to retrieve a physical span/channel resource timed out. |
Virtual span/channel’s request to retrieve a physical span/channel timed out. No response from the internal router within the allowed time. |
Contact Excel Tech Support |
0x1E |
Idle Purge |
L4 went out of service. |
Contact Excel Tech Support |
0x1F |
BCC Wait Timeout |
A create broadcast message was sent to from L4 to BCC trying to create a conference and a timeout occurred waiting for an acknowledgment. |
Send a Release With Data message from the host; otherwise, contact Excel Technical Support. |
0x20 |
L5 Release Data Wait Timeout |
An ISDN Channel Release Request message was sent to the host and a timeout occurred while waiting for a Release With Data message. |
Send a Release With Data message from the host within 20 seconds. |
0x21 |
L3 Remotely Blocked |
Layer 4 (L4) purges because it is in a state not ready to receive an Out-of-Service blocked event from the associated Layer 3 channel. This results in bringing the channel into a known state. |
None—the Excel platform has no control over the remote channel. |
0x22 |
DSP Resource Wait Timeout |
Layer 4 purges because a timeout occurred while waiting for DSP resources. |
Make sure DSP resources are available. |
0x23 |
Outpulsing Digits Timeout |
Layer 4 purges because a timeout occurred while waiting for the completion of outpulsing digits. |
Make sure outpulsing digits are available. |
0x24 |
Ring Inaccessible |
The node cannot access the EXNET ring due to a local EXNET hardware problem. |
Rectify the hardware problem. |
0x25 |
Node Inaccessible |
The remote node cannot be accessed on the EXNET ring due to an EXNET hardware problem on the remote node. |
Rectify the hardware problem. |
0x26 |
MCC Response Timeout |
Channel purges because timer expires before MCC sends Layer 4 a response to the Connect to Conference or Connect One-Way to Conference message. Default timer: 12 seconds |
Contact Excel Tech Support |
0x27 |
Internal router look up failure |
Internal routing look up for a physical resource negatively acknowledged. Possibly due to lack of free physical resources. That is, demand for physical resources has exceeded the supply. |
Check for consistency between actual physical resources and the internal router database configuration. If no such inconsistency is found, add more physical resources. |
0x28 |
Internal router look up timed out |
Internal routing look up for a physical resource timed out. |
Contact Excel Tech Support |
0x38 |
Remote Conferencing Timeout |
|
|
0x71 |
Implicated in Error Detection |
Reserved |
Contact Excel Tech Support |
0x72 |
Configured, Non-Dormant |
Reserved |
Contact Excel Tech Support |
0x73 |
Span Receiving CGA Alarm |
Channel purged because span received Carrier Group Alarm (CGA). |
None—the Excel platform has no control over the remote channel. |
0x74 |
Disabled While Non-dormant |
Layer 3 purges because it is in a state not ready to bring a channel out-of-service. |
Do not take a channel out-of-service when it is involved in a connection. |
Sent to host whenever an E1 PPL channel is taken out-of-service with the Service State Configure message. |
No corrective action is necessary. |
||
0x75 |
Internal Outseize ACK Timeout |
Layer 3 purges because it did not receive a wink when attempting to busy out a channel. |
Verify outgoing start dial type. |
0x76 |
Internal Disconnect Clear Wait Timeout |
Layer 3 purges because a timeout occurred while waiting for Layer 4 to be cleared of a call. |
Contact Excel Tech Support |
0x77 |
Internal Connect Wait Timeout |
Layer 3 purges because a timeout occurred while waiting for the channel to be connected. |
None—the Excel platform has no control over the remote channel. |
0x78 |
Busy Out ACK Timeout |
Layer 3 purges because a time-out occurred while waiting for a busy out acknowledgment from Layer 4. |
Contact Excel Tech Support |
0x79 |
Internal Inconsistency |
Layer 3 purges with an unexpected internal error. |
Contact Excel Tech Support |
0x7A |
Layer 4-implicated Layer 3 Purge |
Layer 4 purge implication message based upon the current condition of the call stack as well as the associated Layer 3 timeslot. |
Contact Excel Tech Support |
0x7B |
CFG-implicated Layer 3 Purge |
A channel configuration has purged to allow a new configuration to be assigned. |
None—this is not an error. |
0x7D |
Null Outseize Control Instruction Encountered |
A null outseize instruction was encountered. |
Modify Outseize Control message. |
0x7E |
Null Outseize Instruction List Instruction Encountered |
A null outseize instruction list instruction was encountered. |
Modify outseize instruction list. |
0x7F |
Invalid Outseize Instruction Encountered |
An invalid outseize instruction was encountered. |
Modify Outseize Control message or programmed outseize instruction list. |
0x80 |
Invalid Outseize Instruction Data |
An invalid wink number has been specified in either: |
Modify ICB in Outseize Control message or instruction data byte 1 in the preprogrammed outseize instruction list. The wink number must be from 1 to 8. |
0x81 |
No Outseize Data Available |
An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data. |
Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions. |
0x82 |
No Outseize ACK Outstanding |
A Send Host ACK instruction was included in either an Outseize Control message or a programmed outseize instruction list and there are no outstanding outseize instructions. |
Make sure there is only one Send Host ACK instruction per Outseize Control or outseize instruction list. |
0x83 |
Unexpected Off-hook Detected |
Layer 3 is in a "Wait For Host State" where answer is not allowed. |
Modify the Outseize Control message or programmed outseize instruction list to use a Wait for Host Control with Answer Supervision ICB instead of a Wait For Host Control ICB. |
0x84 |
On-hook Host Control Wait Timeout |
Layer 3 purged waiting for host control within 120 seconds. |
Provide host control within 120 seconds. |
0x85 |
On-hook Host Data Wait Timeout |
An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data within the timer period. |
Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions. |
0x86 |
Failure to Receive Wink |
Layer 3 purges while waiting for wink from the distant end within the timer period. |
None—the Excel platform has no control over the remote channel. |
0x87 |
Wink Tolerance Exceeded |
Layer 3 received a wink that exceeded the maximum allowed wink duration. If this condition happens for the initial wink, glare is declared. |
If the maximum allowed wink duration is too short, increase it; otherwise, you cannot take action because the Excel platform does not have control over the remote channel. |
0x88 |
On-hook Outpulse Complete Timeout |
Layer 3 failed to get an outpulsing complete message from tone call within the Outpulse Complete Timer. |
Modify the Outseize Control message or programmed outseize instructions so that the correct number of digits is being outpulsed, or increase the outpulse complete time. |
0x89 |
Failure to Detect Off-hook |
Reserved. |
Contact Excel Tech Support |
0x8A |
Failure to Receive Call Progress Analysis Result |
Layer 3 failed to get a call progress analysis result within the timer period. |
Contact Excel Tech Support |
0x8B |
Failure to Detect Dialtone |
Layer 3 failed to get dialtone detection from call progress analysis within the timer period. |
Verify outgoing start dial type. |
0x8C |
Off-hook Host Control Wait Timeout |
Layer 3 purges when a timer expires in the off-hook host control wait state. The host failed to provide further action within the timer period. |
Provide host control within timer period. |
0x8D |
Off-hook Host Data Wait Timeout |
An Outpulse Stage N Address Data instruction has been included in either an Outseize Control message or preprogrammed outseize instructions without corresponding Stage N Address Data within the timer period. |
Include a Stage N Address Data ICB in the Outseize Control message or instruction data in the programmed instructions. |
0x8E |
Invalid Off-hook Outseize Instruction |
Layer 3 purged attempting to Scan For Wink or Scan For ANI Off-hook because the distant end was already off-hook. |
Verify the call flow. |
0x8F |
Off-hook Outpulse Complete Timeout |
Layer 3 failed to get an outpulsing complete message from tone control within the timer period. |
Modify the Outseize Control message or programmed outseize instructions so that the correct number of digits is being outpulsed, or increase the outpulse complete time. |
0x90 |
Invalid Inseize Instruction Encountered |
An invalid inseize instruction was encountered while processing an Inseize Control message or programmed inseize instructions. |
Modify the Inseize Control message or programmed inseize instruction list. |
0x91 |
Null Inseize Instruction Encountered |
A null inseize instruction was encountered while processing an Inseize Control message. |
Modify the Inseize Control message. |
0x92 |
Null Inseize Instruction List Encountered |
A Null inseize instruction was encountered while processing an inseize instruction list. |
Modify the inseize instruction list with the Inseize Instruction List Configure message. |
0x93 |
Initialized Inpulsing Stage Data |
A Receive Stage N Address Data instruction was included in either an Inseize Control message or programmed inseize instruction list with inpulsing parameters for stage not configured. |
Modify the Inseize Control message or inseize control list so that the correct stage number is specified; or configure the inpulsing parameters with the Inpulsing Parameters Configure message. |
0x94 |
Invalid Inseize Start Dial Signal |
Reserved. |
Contact Excel Tech Support |
0x95 |
Invalid Inseize Receive Stage Condition |
Reserved. |
Contact Excel Tech Support |
0x96 |
Invalid Inseize Receive Stage Parameters |
A Receive Stage N Address Data instruction was included in either an Inseize Control message or programmed inseize instruction list with inpulsing parameters for stage not configured. |
Modify the Inseize Control message or inseize control list so that the correct stage number is specified; or configure the inpulsing parameters with the Inpulsing Parameters Configure message. |
0x97 |
No Receiver Request Response |
A Receive Stage N Address Data instruction was included in either an Inseize Control message or programmed inseize instruction list and Layer 3 has failed to get a response from a digit receiver within the timer period. |
Verify digit receiver resources. |
0x98 |
No Digits Response |
Layer 3 sent a request for digit collection, but failed to get a response within the timer period. |
Make sure digit collection timers are set correctly (Inpulsing Parameters Configure message). |
0x99 |
Inseize Host Control Wait Timeout |
Layer 3 purges when a timer expires in the Inseize Host Control Wait state. The host failed to provide further action within the specified amount of time. |
Provide host control. |
0x9A |
No Inseize ACK Outstanding |
A Send Host ACK instruction has been included in either an Inseize Control message or programmed inseize instruction list but there are no unacknowledged inseize instructions. |
Make sure there is only one Send Host ACK instruction per Outseize Control or outseize instruction list. |
0x9B |
Function Type Not Supported |
Layer 3 requested DSP service but the function type requested is not available. |
Make sure a DSP is configured for the function type. |
0x9C |
Suspend Reject |
Reserved. |
Contact Excel Tech Support |
0x9D |
Resume Reject |
Reserved. |
Contact Excel Tech Support |
0x9E |
PPL Invoked For Invalid Trunk Type |
Reserved. |
Contact Excel Tech Support |
0x9F |
PPL Null State/Event List |
State/Event list is null. |
Check PPL and state/event table list. |
0xA0 |
PPL Invalid Event for Decision State |
PPL is in an internal state, waiting for some event to drive it out to a normal state. It receives an internal event while in the internal state. |
Check the PPL. |
0xA1 |
PPL Timer Expired in Internal State |
Reserved. |
Contact Excel Tech Support |
0xA2 |
PPL Negative Internal State Response |
A negative response was received in an internal state. Layer 3 was requesting a DSP service while the service was not available or supported. |
Make sure the MFDSP is configured for the function type. |
0xA3 |
PPL Not Internal Wait Event |
Reserved. |
Contact Excel Tech Support |
0xA4 |
PPL Exceeded Maximum Number of Iterations |
The maximum number of PPL iterations was exceeded. |
Contact Excel Tech Support |
0xA5 |
ISDN Host Call Proceeding Wait Timeout |
A time-out occurred while in the ins_pass through state. |
Contact Excel Tech Support |
0xA6 |
PPL Null Primitive |
A null primitive was encountered. There is no atomic function between two states. |
Check the PPL. Make sure there are atomic functions between two states. |
0xAC |
Invalid ISUP Data |
An API message such as Release with Data (0x0036) contains invalid ICB data. |
Correct the data in the ICB. |
0xAF |
Config Byte Max Offset Exceeded |
The config byte’s max offset has been exceeded. |
Contact Excel Tech Support |
0xB1 |
Timeout Waiting for Silence in Backward Reception Mode |
Reserved. |
Contact Excel Tech Support |
0xB2 |
Timeout Waiting to Receive a Forward Tone to Transmit from PPL in Backward Reception Mode |
Reserved. |
Contact Excel Tech Support |
0xB3 |
Timeout While Waiting to Receive a Tone in Backward Reception Mode |
Reserved. |
Contact Excel Tech Support |
0xB4 |
Timeout While Waiting for Silence in Forward Reception Mode |
Timeout occurred while waiting for the incoming forward tone to terminate after a backward signal has been sent in the forward reception state machine. |
Determine cause of sustained signal on external termination device. |
0xB5 |
Timeout Waiting to Receive a Forward Tone in Forward Reception Mode |
The termination device that initiated the call has failed to transmit a forward tone within the time allowed after transition to the wait for forward tone within the time allowed after a transitioning to the wait for forward tone state in the forward state machine. |
Determine cause of signal delay on external termination device. |
0xB6 |
Timeout Waiting to Receive a Backward Tone to Transmit from PPL in Forward Reception Mode |
The PPL has failed to transmit a backward signal within the timer period after transitioning to the Wait For Backward Signal To Transmit state in the forward reception state machine. |
Determine cause of failure of PPL to transmit backward signal. |
0xB7 |
Received Silence While Waiting for an Event to Transmit a Backward Tone in Backward Reception Mode |
Indicates that the termination device that initiated the call has dropped the forward signal prior to receiving a backward acknowledgment. |
Determine the cause of signal drop on external termination device. |
0xB8 |
Received an Incoming Forward Tone While Waiting to Transmit a Backward Tone in Forward Reception Mode. |
Indicates a violation of compelled signaling on an incoming call. The termination device is transmitting a forward signal prior to receiving a backward acknowledgment. |
Determine the cause of failure of external termination device to wait for backward acknowledgment signal. |
0xCB |
VDAC purges the channel because Layer 4 did not release it. |
VPPL L3 on the VDAC negatively acknowledges the Outseize Control message and times out waiting for Layer 4 to release the channel. Since Layer 4 did not release the channel, VDAC purges the channel. |
|
0xCC |
Layer 3 PPL Purge Error |
Varies by PPL protocol. |
|
0xCD |
Wait for Host Control Timeout |
Varies by PPL protocol. |
|
0xD4 |
Layer 4 Connect wait timeout |
Varies by PPL protocol. |
|
0xD5 |
Layer 4 Clear wait timeout |
Varies by PPL protocol. |
|
0xDA |
Layer 4 Busy out ACK wait timeout |
Varies by PPL protocol. |
|
0xDD |
SIP Internal Error |
Could be caused by any of the following:
Message size exceeds the maximum IMSG size .
NPDI data size exceeds the maximum.
Outgoing SIP message size exceeds 1500 Bytes. |
Check the incoming SIP message. |
0xDE |
VDAC rejected/timeout |
The message sent to the VDAC-ONE card was not acknowledged or timed out. |
Check the VDAC-ONE card and router configurations. |
0xDF |
Network error/timeout
SIP Socket Open Failure |
The remote SIP entity is not responding to messages.
The peer entity cannot accept any additional TCP socket connections. |
Check if the remote side is down. Check the network.
|
0xF7 |
Layer 4 Clear Request timeout |
|
|
0xFD |
Call Progress Analysis timeout |
|
|
0xFF |
R2 Cycle Complete timeout |
|
|
0xE0 |
Layer 4 response timeout |
SIP timed out waiting for a response from Layer 4. |
|
0xE1 |
Invalid SDP/NPDI data |
In call agent mode, the user puts invalid data (typically sdp) in the Connect With Data message |
|
0xE2 |
Invalid coupled channel state |
The physical span/channel identifier provided by the host application (typically for call gent mode coupling) is in non-idle state in the Excel platform. |
Resolve glare issues between the Excel platform and the host channel hunting and allocation algorithms. |