Dialog Event Field Listing

DIALOG.STARTED

Whenever a VoiceXML dialog has been successfully loaded and is ready for execution, this event will be thrown to indicate that the dialog has been started.

field name	data type	summary
`name`	string	dialog.started
`dialogid`	string	Defines the ID of the dialog
`dialog`	ECMAScript Object	An ECMAScript object reference to the dialog object identified by the 'dialogid' property of this event.
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.EXIT

This event is thrown when a dialog has been terminated either via programmatic means, (ie via the invocation of a <dialogterminate> element), or if the VoiceXML dialog exits when the form interpretation algorithm dictates that no further execution can be performed. Note that if both occur at once, then there will be no chance of this event being thrown twice.

field name	data type	summary
`name`	string	dialog.exit
`dialogid`	string	Defines the ID of the dialog
`dialog`	ECMAScript Object	An ECMAScript object reference to the dialog object identified by the 'dialogid' property of this event.
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`values.*`	ECMAScript Object	Contains the return values from the VoiceXML dialog, (the values of each of the objects listed in the `<exit>` element's 'namelist' attribute.
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.DISCONNECT

This event is indicative of a directive by a dialog to disconnect the conference, or connection, that is currently active. Note that such an event does not inherently imply that the connection will be broken; a handler for this event must manually disconnect the connection via programmatic means.

field name	data type	summary
`name`	string	dialog.disconnect
`dialog`	ECMAScript Object	Contains an ECMAScript object reference to the dialog object identified by the 'dialogid' property of the event.
`dialogid`	string	Defines the ID of the dialog
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`values.*`	ECMAScript Object	Contains the return values from the VoiceXML dialog, (the values of each of the objects listed in the `<exit>` element's 'namelist' attribute.
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.TRANSFER

The 'dialog.transfer' event will be thrown when the interpreter receives a request to transfer the conference or connection that it is currently associated with to a new destination. When this event is thrown, it does not imply that the connection or conference is automatically transferred; the action to take is determined via programmatic means. One must trap this event, and then initiate a <redirect>, <createcall>, to do anything useful, (or one could simply ignore the event altogether).

field name	data type	summary
`name`	string	dialog.transfer
`dialog`	ECMAScript Object	Contains an ECMAScript object reference to the dialog object identified by the 'dialogid' property of the event.
`dialogid`	string	Defines the ID of the dialog
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`URI`	valid URI	Contains the URI describing the destination to which the call is to be transferred to.
`values.*`	ECMAScript Object	Contains the return values from the VoiceXML dialog, (the values of each of the objects listed in the `<exit>` element's 'namelist' attribute.
`maxtime`	string	Contains a string in CSS2 format that specifies the maximum amount of time the transfer may stay connected. If the amount of time is to be unlimited, then the value will be defined as 0s.
`connecttimeout`	string	Contains a string in CSS2 format which specifies the maximum amount of time to spend when attempting to connect the call.
`aai`	string	Contains a string of application-to-application data to be passed to the destination party when establishing the transfer.
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.TERMINATETRANSFER

This event indicates that a request to terminate an ongoing transfer has been received from the VoiceXML dialog due to hotword recognition. When this event is thrown, it does not imply that the connection or conference is automatically terminated; the action to take is determined via programmatic means, such as returning the media stream of the original call to the dialog using the <join> element.

field name	data type	summary
`name`	string	dialog.terminatetransfer
`dialog`	ECMAScript Object	An ECMAScript object reference to the dialog object identified by the 'dialogid' property of this event.
`dialogid`	string	Defines the ID of the dialog
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`reason`	string	Contains a description of the reason that the dialog wants the transfer to terminate.
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.USER.*

This event is only thrown upon a user-defined dialog event being thrown to the CCXML interpreter, where '*' is the name of the user-defined event.

field name	data type	summary
`name`	string	dialog.user.* (where '*' is the user event name)
`dialog`	ECMAScript Object	An ECMAScript object reference to the dialog object identified by the 'dialogid' property of this event.
`dialogid`	string	Defines the ID of the dialog
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`values.*`	ECMAScript Object	Contains the return values from the VoiceXML dialog, (the values of each of the objects listed in the `<exit>` element's 'namelist' attribute.
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

DIALOG.PREPARED

When a <dialogprepare> directive is executed properly, this event will be thrown when thre CCXML 1.0 interpreter has determined that the VoiceXML dialog is ready for execution, (via a subsequent <dialogstart>, in most cases).

field name	data type	summary
`name`	string	dialog.prepared
`dialog`	ECMAScript Object	An ECMAScript object reference to the dialog object identified by the 'dialogid' property of this event.
`dialogid`	string	Defines the ID of the dialog
`connectionid`	string	Contains the identifier of the connection that the dialog connection is bridged to,(usually the connectionid that was specified in `dialogstart` or `dialogprepare`).
`conferenceid`	string	Contains the identifier of the conference that the dialog connection is bridged to, (usually the conferenceid that was specified in `dialogstart` or `dialogprepare`).
`eventid`	string	Defines the unique identifier for the event. If the event was generated via a `<send>` request, then this value will match the 'sendid' value.
`eventsource`	string	This value will contain the dialog I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event. Note that this will always be set to 'dialog'.

ANNOTATIONS: EXISTING POSTS

0 posts - click the button below to add a note to this page

Connection Event Field Listing

| TOC

| Miscellaneous Event Field Listing