You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Connect Tone Pattern 0x002F
SwitchKit Name
Type
EXS API and SwitchKit API message
Description
This message instructs the Excel platform to transmit a call progress pattern ID to the specified channel. The channel must be in any state other than: idle, out of service, or busied out.
If you want to be notified with a Call Processing Event message (0x21 - Tone Complete) when tone transmission has stopped, set the Generate Event Flag.
Sent by
SwitchKit Code
C Structure
typedef struct {
unsigned short Span;
UBYTE Channel;
UBYTE reserved20[27];
UBYTE CallProgressPatternID;
unsigned short NumCycles;
UBYTE Flag;
UBYTE reserved51[219];
} XL_ConnectTonePattern;
C++ Class
class XLC_ConnectTonePattern : public XLC_OneChannelOutbound {
public:
unsigned short getSpan() const;
void setSpan(unsigned short x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getCallProgressPatternID() const;
void setCallProgressPatternID(UBYTE x);
unsigned short getNumCycles() const;
void setNumCycles(unsigned short x);
UBYTE getFlag() const;
void setFlag(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 (0x0007) |
3, 4 |
Message Type (0x002F) |
3, 4 |
Message Type (0x002F) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8 |
AIB (Individual AEs) |
8, 9 |
|
10 |
Checksum |
||
: |
Transmit Call Progress Pattern ID NOTE: These are not the same pattern IDs as those used for call progress analysis.
0x02 Ringback 0x03 Busy 0x04 Reorder 0x05 Warning 0x06 Call Waiting 0x07 ONI Call (Zip Tone) 0x08 ANI Failure (Zip Tone) 0x09 Confirmation Tone 0x0A Recall Dial Tone 0x0B Class of Service, Tone 2 0x0C Class of Service, Tone 3 0x0D Intercept 0x0E Vacant Code 0x0F Reorder-LEC 0x10 No Circuit-LEC 0x11 Reorder-Carrier 0x12 No Circuit-Carrier 0x13 Three second, 400 Hz continuos tone 0x14 Specialized tone to wait 500 ms then play 480Hz for 800 ms 0x15 Bong Tone (Calling Card Service Prompt Tone) 0x16-3F User-defined Patterns |
||
: |
Number of Cycles to Transmit, MSB, LSB The value in this field does not apply for the Dial Tone (0x01), Recall Dial Tone (0x0A), and Bong Tone (0x15), as they have no cycles. Dial Tone and Recall Dial Tone play continuously and Bong Tone plays once. 0x0000–0xFFFE Valid numbers of cycles |
||
: |
Generate Event Flag 0x00 Do not inform the host when the outpulsing of the tone is complete. 0x01 Inform the host with a Call Processing Event message that the outpulsing
The Excel platform stops playing the tone only if:
A Connect Tone Pattern message does not cancel the outpulsing of call progress tones. However, a Connect With Data message with an action ICB of Free System Resources does cancel outpulsing. For more information, refer to the Connect With Data message. |
||
: |
Checksum |