PlayRingbackTone

Purpose

Use PlayRingbackTone to force play a busy, ringback, or fast ringback tone on a line (usually a DID line) to indicate the line state.

Description

PlayRingbackTone starts playing the tone and immediately returns the Succeeded result. The action continues to play the tone until a predefined number of repetitions are completed. When the next action is TerminateCall or CloseEverything, the application waits until the ringback tone is completed or the caller hangs up before executing the next action.

For the PlayRingbackTone action to succeed, the voice channel must already be connectedthis is achieved through the successful completion of either an AnswerCall or a Makecall action. For an incoming call, the voice channel can also be connected prior to an AnswerCall action, if the system parameter Connect Voice Channel Before Answer is enabled (this parameter is only available if you are logged on as field).

PlayRingbackTone plays only standard U.S. tones. You cannot configure these tones for a specific switch or region/country.

PlayRingbackTone can be used with background music. If you don't want background music playing at the same time as the tones, precede this action with a ControlMusic action and set the fade time to 100.

All input is flushed before this action starts, that is, any queued DTMF, voice interrupt detection or fax tones will be lost.

Parameters

The parameters for PlayRingbackTone define how many times to play a Busy, Ringback, or Fast Ringback tone.

• Repetitions. Specifies the number of times to repeat the tone. Both 0 and 1 specify that the action only plays the tone once.

Possible results

PlayRingbackTone can have one of the following results:

Succeeded

The tone was played.

Caller Hung Up

The caller has hung up.

ASCII syntax

When using an ASCII editor, code this action with these parameters in the following order:

1. "BUSY"
   • or "RINGBACK"
   • or "FAST_RINGBACK"
2. Repetitions

For example:

label: "Check Edges"
        PlayRingbackTone("BUSY", 5)
          edge EDGE_RT_COMPLETED:                 completed
          edge EDGE_HUP:                                   hup
        ;
        PlayRingbackTone("RINGBACK", 5);
        PlayRingbackTone("FAST_RINGBACK", 5);

The parameters and edges are described above under "Parameters" and "Possible results". For more information, see Testing a state table using the debugger.