Section II – Functional Modules > Voice Interaction Interface > Events         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements

Events

The event namespace convention is voice.xxxx.

The following are the Voice action result events:

Event

Attributes

Description

voice.createcall.done

 

This event indicates the success of the request and that the interaction has been created.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.createcall

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invaliddestination
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.hold.done

 

This event indicates the success of the request and that the specified resource's device is going on hold for the call.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.hold

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.retrieve.done

 

This event indicates the success of the request and that the specified resource's device is going to be retrieved from hold for the call.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.retrieve

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.consultation.done

 

This event indicates the success of the request and that the specified resource's device is going to put an existing call on hold and create a new call.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.consultation

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invaliddestination
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.alternate.done

 

This event indicates the success of the request and that the specified resource's devices are going to alternate between calls.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.alternate

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.reconnect.done

 

This event indicates the success of the request and that the specified resource's devices are going to drop the active call and retrieve the held call.

requestid

This is the ID associated with the request.

interactionid

This is the interaction id associated with the interaction that was created.

error.voice.reconnect

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.conference.done

 

This event indicates the success of the request and that the specified resource's devices are going to conference two calls.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.conference

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.transfer.done

 

This event indicates the success of the request and that the specified resource's devices are going to transfer a call.

requestid

This is the ID associated with the request.

interactionid

This is the interaction ID associated with the interaction that was created.

error.voice.transfer

 

This indicates that an abnormal condition occurred while trying to perform the request. This event will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that might have been created in conjunction with this request, but has failed.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown

description

This is a more detailed description of the error.

voice.privateservice.done

 

This event is sent when the request has been accepted by the underlying functional module and that it is able to send it. It is not an indication that the T-Server has handled or accepted the event.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that was passed to the <privateservice> action.

error.voice.privateservice

 

This indicates that an abnormal condition occurred while trying to perform the request. This event may be seen as a result of failing to send the message or may occur after the target T-Server has received and attempted to process the event. In the case of failing to send the request it will be sent as a result of a timeout of the request as well as due to problems with the request or interaction itself as described in the error and the description.

If this occurs as a result of an error in the processing of the request by the T-Server the error property will be set to indicate tserver, with a generic description and more details available within the properties.

requestid

This is the ID associated with the request.

interactionid

This is the ID associated with the interaction that was passed to the <privateservice> action.

error

This is the type of error that occurred:

  • timeout
  • invalidsource
  • invalidinteraction
  • invalidserver
  • unknown tserver

description

This is a more detailed description of the error.

properties

This is an ECMAScript object that represents the various properties of the TServer EventError structure. It will only be present if the request has been successfully transmitted and received by the T-Server. If present, the error property will be set to tserver to signify this was an error generated by the T-Server handling the request.




Section II – Functional Modules > Voice Interaction Interface > Events         Top of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements