CCXML Event Field Listing

CCXML.CREATED

When a <createccxml> request executed and completes successfully, a 'ccxml.created' event will be generated to the document that issued the original request to notify the application that the new session has fetched, parsed and has begun execution of the CCXML document specified. In all cases, a 'ccxml.loaded event' will be subsequently thown to the new session.

field name	data type	summary
`name`	string	This will always return the static string value of 'ccxml.created'.
`sessionid`	string	This value will be populated with the identifier of the newly created CCXML 1.0 session, (ie, the same as the `<createccxml>` request that created the session).
`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.

CCXML.EXIT

In the event that a CCXML 1.0 document executes an <exit> element, or the document has an unhandled 'error.*' or if a 'ccxml.kill' event is generated, a 'ccxml.exit' event will be thrown. Note that if the session executing the <exit> does not have a parent session, then this event will never be thrown.

field name	data type	summary
`name`	string	This will always return the static string value of 'ccxml.exit'.
`sessionid`	string	The 'sessionid' field will always contain the identifier of the current session, (which will be the same value that is returned to the 'sessionid' attribute of the invoking `<createccxml>` that created the session.
`expr`	string	This field contains the value of the exit 'expr' attribute. Note that if this attribute is omitted in the `<exit>`, the value will be 'undefined'.
`values.*`	ECMAScript Object	This will contain the return values from the ccxml session, (ie, the values of each of the objects listed in the CCXML `<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 define 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 the reason for the session ending. Possible values include: exit: session ended due to an `<exit>` directive error: session ended due to an unhandled error event kill: session ended due to any ccxml.kill* event

CCXML.KILL

The 'ccxml.kill' event can be used to terminate a session without having to invoke an explicit <exit> directive. Note that there are two types of this event: one which can be caught and handled, and the other which cannot be caught at all. This event can be caught, (usually for post-processing at the end of a call session). In this scenario, the call will not inherently end unless the developer specifies an <exit> within the event handling <transition>. If the event is not caught, then the session will be automatically ended at the platform scope.

Note that a 'ccxml.kill.unconditional' event is not catchable in any scenarios at all, and it will, as its nomenclature implies, terminate the call session unconditionally, regardless of any begging or pleading.

field name	data type	summary
`name`	string	This will always return the static string value of 'ccxml.kill'
`sessionid`	string	Contains the unique identifier of the session
`reason`	string	Contains a string describing the reason the platform sent the 'kill' 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 define 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.

CCXML.LOADED

When the CCXML 1.0 application has been parsed and is ready to execute, the 'ccxml.loaded' event will be generated to the application.

field name	data type	summary
`name`	string	This will always return the static string value of 'ccxml.loaded'.
`sessionid`	string	Contains the unique identifier of the session in which the document is executing.
`parent`	string	This field will contain the identifier of the session that issued the `<createccxml>,/code> to start the document. Note that in the event that the document was started directly by the CCXML platform, the value will return 'undefined'.`
`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

Event Handling Basics

| TOC

| Conference Event Field Listing