This page describes the response that is expected by the Call Interactive service. |
Call Interactive expects to receive responses in the following format:
<?xml version="1.0" encoding="UTF-8"?> <Response> Verb </Response> |
Where Verb
is one the following known parameters.
Hangs up the call immediately.
<Response> <Hangup/> </Response> |
Pauses the call for a given number of seconds. If no interval is supplied, default value is 10.
<Response> <Pause length="15" /> </Response> |
Sets a variable on the IVR.
<Response> <SetVar name="SubscriptionCode">09897987</SetVar> </Response> |
Plays the sound from a given folder in a given language; if the folder is not supplied, it is considered empty:
view="system"
the service will get a system sound, while for view="client"
it will get a personal sound;where
parameter;loop
attribute controls for how many times the sound is played;The verb has the following format:
<PlaySound language="" loop="" view="system/client" folder="name of folder" where="foreground/background" digitvar="MYVAR"> nameofthesound </PlaySound> |
<Response> <PlaySound language="fr" view="system" folder="/custom" where="background" digitvar="contact"> Choose-contact-method </PlaySound> </Response> |
Performs a jump to an IVR context at a given option. The jump can be performed directly to a priority where the IVR should have registered an action.
<Response> <Jump context="StartSupport" option="1" priority="3"> </Response> |
Sets a CallerID Number and a CallerID Name on the IVR environment. These can be retrieved later by other applications. If any of the name
or number
attributes is missing, the XML response parsing is aborted.
<Response> <SetCaller name="callerName" number="92992"/> </Response> |
Plays a text using a specific voice. The volume is optional and its default value is 150. This verb requires a TTS license installed and TTS activated on the VoipNow 3 infrastructure.
<Response> <PlayTTS voice="Alice-8KHz" volume="100"> </Response> |