CCXML 1.0-W3C Development Guide

| TOC

Error Event Field Listing

Conference Errors

ERROR.CONFERENCE.CREATE

This error event will be thrown when a problem occurs when a conference creation has failed, thereby implying that the Conference Object was not created.

field name	data type	summary
`name`	string	error.conference.create
`conferenceid`	string	Contains the ID of the conference that has encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CONFERENCE.DESTROY

This event is indicative of a <destroyconference> action that failed to process. There are several reasons why this could occur, and additional details can be found on a per-case basis by referencing the 'reason' method detailed below.

field name	data type	summary
`name`	string	error.conference.destroy
`conferenceid`	string	Contains the ID of the conference that has encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CONFERENCE.JOIN

This error event getting generated is a result of a failed <join> operation. The cause of the error can be determined by accessing the 'reason' property, listed below.

field name	data type	summary
`name`	string	error.conference.join
`conferenceid`	string	Contains the ID of the conference that has encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CONFERENCE.UNJOIN

This error event will occur when an <unjoin> operation fails for any reason. The root cause of the failure is available by accessing the 'reason' property within the handler.

field name	data type	summary
`name`	string	error.conference.unjoin
`conferenceid`	string	Contains the ID of the conference that has encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CONFERENCE

This error event will occur when an error occurs on a conference that a session is linked to, and indicates the end of a conference. Note that this event precludes the need for the developer to manually kill the conference via the <destroyconference> element.

field name	data type	summary
`name`	string	error.conference
`conferenceid`	string	Contains the ID of the conference that has encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

Connection Errors

ERROR.CONNECTION

This event can occur due to a number of reasons, and at it's most basic, this event signifies an element cannot be executed due to the current call state is invalid for a given element. For instance, attempting to execute an <accept> directive on a call that is already in the 'connected' state is quite obviously improper, and would result in a ‘error.connection.wrongstate’ event being thrown. When a 'error.connection' event occurs, no further events, including events for any requests that are pending, will be thrown in the execution context, as the call state has rendered the connection unusable.

field name	data type	summary
`name`	string	error.connection
`connectionid`	string	Denotes the ID of the connection that is associated with the event.
`protocol`	string	Contains the platform protocol ID of the Connection protocol.
`reason`	string	Contains descriptive text explaining why the error occurred.
`info`	ECMAScript Object	Contains the object which provides additional data on the connection error.
`connection`	ECMAScript Object	Contains an ECMAScript object reference to the Connection object that is identified by the 'connectionid' property of the event.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CONNECTION.WRONGSTATE

The 'error.connection.wrongstate' event is only generated when, well, when the developer messed up his or her CCXML 1.0 logic. This signifies that an element has been specified that is not allowed to execute due to the current state of the Connection Object, such as when we attempt to <accept> a call that is already in the 'connected' state. Developer should take note of the fact that the Connection Object state is only as current as the event currently being processed, and might not neccessarily reflect events that are in queue, or even other events that occur before the request generated by an element has processed. As a direct result, bear in mind that not all failures caused by the state of the actual connection will result in an 'error.connection.wrongstate' event.

field name	data type	summary
`name`	string	error.connection.wrongstate
`connectionid`	string	Contains the ID of the connection associated with the event.
`protocol`	string	Contains the platform protocol ID of the Connection protocol.
`reason`	string	Contains descriptive text explaining why the error occurred.
`info`	ECMAScript Object	Contains the object which provides additional data on the connection error.
`connection`	ECMAScript Object	Contains an ECMAScript object reference to the Connection object that is identified by the 'connectionid' property of the event.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.
`tagname`	string	This property is set to the ECMAScript string value of the name of the element that produced the error.

Dialog Errors

ERROR.DIALOG

The 'error.dialog' event will only be thrown when an unspecified error occurs within the invoked dialog. As a result of this event being thrown, the CCXML 1.0 platform will destroy exsiting conference bridges to the dialog, and will then throw a 'conference.unjoined' event to the interpreter.

field name	data type	summary
`name`	string	error.dialog
`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`).
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.DIALOG.NOTSTARTED

In the event that a dialog resource cannot be loaded, this event will be thrown to notify the CCXML 1.0 application that a problem has been detected. The specific cause of the dialog not starting is available by accessing the 'reason' field, which is listed below.

field name	data type	summary
`name`	string	error.dialog.notstarted
`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`).
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.DIALOG.NOTPREPARED

If a <dialogprepare> directive fails to properly prepare the VoiceXML dialog for execution, then this event will be generated as a notification. As with similar events of this nature, the specific cause of the failure can be determined by accessing the 'reason' field, listed below.

field name	data type	summary
`name`	string	error.dialog.notprepared
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.
`reason`	string	Contains descriptive text explaining why the error occurred.

Miscellaneous Errors

ERROR.FETCH

The 'error.fetch' event is thrown when a fetch operation fails to complete successfully. The 'reason' field will usually hold specific information that details the cause of the problem in greater detail.

field name	data type	summary
`name`	string	error.fetch
`fetchid`	string	Contains the unique fetch identifier for the fetch attempt.
`reason`	string	Contains descriptive text explaining why the error occurred.
`statuscode`	int	Contains the numeric HTTP status code of the HTTP `<fetch>`request that failed.
`uri`	Lists the URI of the resource that was fetched. Note that if the fetch resulted in one or more HTTP redirects (e.g. 302), then the value of this property is set to the final target URI.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.CREATECCXML

This event will be generated when a <createccxml> request fails. Note that this event is delivered to the document that originally issued the request.

field name	data type	summary
`name`	string	error.createccxml
`sessionid`	string	Contains the identifier of the CCXML session that failed. This is the same identifier as was returned on the relevant 'sessionid' attribute of the `<createccxml` request that created the session.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.UNSUPPORTED

The 'error.unsupported' event is indicative of the developer specifying an application-scoped action that is unsupported by the CCXML 1.0 platform. Seeing this usually means that there is a typo in the code, or that some misinterpretation of what is, and is not supported has occurred.

field name	data type	summary
`name`	string	error.unsupported
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.NOTALLOWED

This event is thrown only when the execution of an element results in an invalid operation to be executed on a session/connection.

field name	data type	summary
`name`	string	error.notallowed
`sessionid`	string	Contains the unique ID of the affected session that encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.SEMANTIC

The 'error.semantic' event is the result of improper application code, such as improper ECMAScript, or an incorrect datatype being specified in an element of attribute.

field name	data type	summary
`name`	string	error.semantic
`reason`	string	Contains descriptive text explaining why the error occurred.
`tagname`	string	This property lists the ECMAScript string value of the name of the element that produced the error.
`attributelist`	ECMAScript Object	this property is set to an object whose properties are the names of the attributes of the element that caused the error. The value of each attribute property is the corresponding string value of the 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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.SEND.TARGETUNAVAILABLE

In the event that a directive to <send> an event to a session that results in the target being unavailable for any reason, a 'error.send.targetunavailable' will be thrown to the CCXML 1.0 interpreter.

field name	data type	summary
`name`	string	error.send.targetunavailable
`sendid`	string	Contains the unique ID of the event that encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.SEND.TARGETTYPEINVALID

An 'error.send.targettypeinvalid' event will only be thrown when the I/O processor specified in the <send> element cannot receive the inbound connection request.

field name	data type	summary
`name`	string	error.send.targettypeinvalid
`sendid`	string	Contains the unique ID of the event that encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.SEND.FAILED

In the event that a <send> event is not received by the target, then this error will be thrown, indicating that the message was not received.

field name	data type	summary
`name`	string	error.send.failed
`sendid`	string	Contains the unique ID of the event that encountered the error.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ERROR.MOVE

Should a <move> request fail to complete successfully, this event will be generated and indicates that a problem occurred, and that the session has not been moved as directed.

field name	data type	summary
`name`	string	error.move
`sourceid`	string	Contains the unique ID of the event source referenced, either directly via the 'source' attribute, or indirectly via the event attribute of the `<move>` element.
`sessionid`	string	Contains the ID of the target session to which it was attempted to move the event source.
`reason`	string	Contains descriptive text explaining why the error occurred.
`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 CCXML 1.0 I/O Processor that sent the event.
`eventsourcetype`	string	This defines the name of the Event I/O Processor that sent the event.

ANNOTATIONS: EXISTING POSTS

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

Miscellaneous Event Field Listing

| TOC

| Sending Custom Events