Every VOX_CTI function has an output variable called rc which is used to
return the result of sending the VOX command and receiving the VOX response
(rather than the actual VOX.response result).
For example:
- A VOX command that failed to receive a VOX response would set rc to VOX_TIMED_OUT.
- A VOX command that received a VOX response of "Bad vduid" would
set rc to VOX_OK as the command was successfully sent and a VOX response successfully
received.
The rc variable can take one of the following values:
- 0 - VOX_OK
- The VOX command was successfully sent and a VOX response successfully
received.
- 1 - VOX_NO_VOX_SERVER
- The Blueworx Voice Response channel has no VOX Server registered, this can be due to several
things:
- There is no VOX Server configured for this particular channel.
- The VOX Server has stopped running.
- There is no "port" ini item for the VOX Server.
- 2 - VOX_UNKNOWN
- Something unknown went wrong. This return code should never be returned.
- 3 - VOX_NO_CHANNEL
- The CHP/state table no longer has access to the channel from a VOX Server
point of view. This can be due to several things:
- The VOX Server has stopped running and there is a pending VOX command.
- Another CHP/state table is currently using this channel. This can happen
if the original call drops and a new call arrives and is answered by another
state table. The second state table will automatically issue a Gone (see Gone
for more information.)
- The Newcall function has not been called.
- 4 - VOX_REQUEST_TOO_LONG
- The request is too long (more than 1024 characters). This will occur
if the outcome of the VOX command would be more than 1024 characters long.
- 5 - VOX_TIMED_OUT
- The VOX Server did not respond to the VOX command within the timeout
period specified in the ini file.
- 6 - VOX_BAD_RESPONSE
- The VOX response received by VOX_CTI was not understood. The response
will be stored in the error_msg variable.