|
VoiceResourceGetResponse Method |
Waits for a user response as Digit(s) or Speech using all current settings for the
Voice Resource, and therefore has no parameters.
Namespace:
VoiceElements.Client
Assembly:
VoiceElementsClient (in VoiceElementsClient.dll) Version: 8.6.1.1
Syntax public TerminationCode GetResponse()
Public Function GetResponse As TerminationCode
public:
TerminationCode GetResponse()
member GetResponse : unit -> TerminationCode
Return Value
Type:
TerminationCodeA
Termination Code indicating how the wait ended. Typically, you will use this to determine what to do next.
Remarks
This method does not set any of the required
Voice Resource properties for how long to wait, what response to expect, etc. Whatever has been set in the VR properties will be used to determine the behavior of your
waiting for a response using this overload. In the sample code below, these properties are specifically set before calling Get Response.
Voice Resource Properties and Overloads
This method has three additional overloads allowing you to set specific
Voice Resource properties to control behavior. Before choosing, you will want to review the
Three Parameter Get Response Overload, the
Four Parameter Get Response Overload
and the
Five Parameter Get Response Overload.
If you choose to use this method and not one of the overloads, keep in mind that you have set the Voice Resource properties before calling Get Response. The relevant properties you need to consider are:
- Maximum Digits Property - The maximum number of digits that will be accepted from the caller.
- Maximum Time Property -
The number of seconds to wait for the entire expected string of digits to be received.
- Termination Digit Property - This digit, like a pound sign (#) would stop the response from waiting for more digits in a string. Note that using the "@" wildcard can be done here to denote any digit.
- Inter-Digit Timeout Property - This is the number of seconds between digits in a string that will cause Get Response to terminate and consider the input of the string complete.
- Clear Digit Buffer Flag -
If set to true, digits in the buffer will be purged before the wait for response begins. Use this to clear any residual input you think might be in the buffer.
Getting Speech Recognition Responses
This method will also return a word or string of word from a
Speech Recognition Engine. What is returned can be retrieved using the
Returned Word Property. In addition, you will need to define grammars, and set
Speech Recognition Active property among other
settings to properly use speech. More information on speech can be found on our
Support Wiki.
Examples
The following sample code sets up a
Channel Resource,
Dials a Call, retrieves a
Voice Resource,
sets up the common properties for a
Voice Resource object and executes a Get Response at the end.
public void DialAndGetResponse()
{
TelephonyServer m_TelephonyServer = new TelephonyServer();
ChannelResource m_ChannelResource = m_TelephonyServer.GetChannel();
string phoneNumber = "2135551212";
m_ChannelResource.Dial(phoneNumber);
VoiceResource m_VoiceResource = m_ChannelResource.VoiceResource;
m_VoiceResource.ClearDigitBuffer = true;
m_VoiceResource.TerminationDigits = "@";
m_VoiceResource.MaximumDigits = 11;
m_VoiceResource.Codec = Codec.MULAW_8Khz_8Bit;
m_VoiceResource.DataFormat = DataFormat.Raw;
TerminationCode tc = TerminationCode.Normal;
tc = m_VoiceResource.Play(@"Introduction.wav");
m_VoiceResource.ClearDigitBuffer = false;
tc = m_VoiceResource.Play(@"InputOptions.wav");
m_VoiceResource.MaximumTime = 20;
m_VoiceResource.TerminationDigits = "#";
tc = m_VoiceResource.GetResponse();
}
Public Sub DialAndGetResponse()
Dim m_TelephonyServer As New TelephonyServer()
Dim m_ChannelResource As ChannelResource = m_TelephonyServer.GetChannel()
Dim phoneNumber As String = "2135551212"
m_ChannelResource.Dial(phoneNumber)
Dim m_VoiceResource As VoiceResource = m_ChannelResource.VoiceResource
m_VoiceResource.ClearDigitBuffer = True
m_VoiceResource.TerminationDigits = "@"
m_VoiceResource.MaximumDigits = 11
m_VoiceResource.Codec = Codec.MULAW_8Khz_8Bit
m_VoiceResource.DataFormat = DataFormat.Raw
Dim tc As TerminationCode = TerminationCode.Normal
tc = m_VoiceResource.Play("Introduction.wav")
m_VoiceResource.ClearDigitBuffer = False
tc = m_VoiceResource.Play("InputOptions.wav")
m_VoiceResource.MaximumTime = 20
m_VoiceResource.TerminationDigits = "#"
tc = m_VoiceResource.GetResponse()
End Sub
No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.
See Also