Hangup
Ends the call immediately.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Hangup/>
</Response>
Pause
Pauses the call for the number of seconds specified by the length attribute of the Pause tag. If the value is not specified, the default is 10.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Pause length="15" />
</Response>
SetVar
Sets the value of the variable for the IVR. The variable name must be contained in the name attribute of the SetVar tag, and the value must be the content of this tag.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<SetVar name="transferDestination">09897987</SetVar>
</Response>
Jump
Jumps to the specified option of the specified IVR context. The context ID and option are set by the context and option attributes of the Jump tag.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Jump context="3" option="start"/>
</Response>
SetCallerId
Specifies the caller number and caller name in the IVR environment. The number and name are set by the name and number attributes of the SetCaller tag.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<SetCaller name="callerName" number="92992"/>
</Response>
PlaySound
Plays a sound whose file name is set by the content of the PlaySound tag. The file name can be obtained from the API as the filename parameter the “Sound files (/sound/)” resource. The where attribute of the PlaySound tag specifies the type of audio playback: foreground or background. When playing the background type, you can enter numbers in a variable whose name is specified in the digitvar attribute of the PlaySound tag.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<PlaySound where="background" digitvar="transferDestination">ae3d969ccc49e1a7746e0b1ce36ee4176190040c.wav</PlaySound>
</Response>
SimpleTransfer
Calling through the simple transfer forwarding rule ignores the internal number settings and the internal number forwarding rules. The answer is similar to the pre-defined simple transfer rule. It is possible to specify both one and several numbers (NUM1, NUM2) separated by commas, spaces should not be present. The default rule is final (final='yes'), including if final is not specified, except if final="no" is specified.
The timeout parameter sets the call response time in seconds. If the timeout is specified incorrectly or this parameter is omitted, the system timeout will be used. Also, if necessary, you can add the parameter early_media="True" (in this format), in which case early media will not be ignored.
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<SimpleTransfer final="no" timeout="20">NUM1,NUM2</SimpleTransfer>
</Response>
TTS — Text to speech
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<TTS lang="ru-RU" voice="alena" speed="2.0" play_now="true" save_to_var="false" >voice text</TTS>
</Response>
The lang parameter is the text reading language. If the language is not specified, the default language will be used – Russian (ru-RU). Options are also available:
en-US – English;
tr-TR – Turkish.
If the language is specified, the voice parameter is checked by the condition of matching the voice in the list below. If the language is not specified or is not listed, the default language will be used.
ru_voices = {'voices': ['oksana', 'jane', 'omazh', 'zahar', 'ermil', 'alena', 'filipp'], 'def': 'oksana'}
en_voices = {'voices': ['alyss', 'nick'], 'def': 'alyss'}
tr_voices = {'voices': ['silaerkan', 'erkanyavas'], 'def': 'silaerkan'}
The speed parameter is the speed of reading the text. Only available from the following range:
[0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 1.7, 1.8, 1.9, 2.0, 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 2.8, 2.9, 3.0]
The play_now parameter can take the values "true" or "false". Informs you whether to play the synthesized greeting immediately. You can postpone the playing of the greeting by using the additional parameter save_to_var= "true".
Playing a greeting from a variable is available in the play_sound, quality_rate, and voice_helper voice menu rules.
Possible combinations:
play_now= "true", save_to_var= "false" - the greeting will be played immediately;
play_now= "true", save_to_var= "true" - the greeting will be played immediately, and it can also be used further in the IVR logic;
play_now= "false", save_to_var= "true" - the greeting will not be played, but it can be used further in the IVR logic;
play_now= "false", save_to_var= "false" – nothing will be played, such a response to Call Interactive will be ignored.