CCXML 1.0-W3C Development Guide

Home  |  Frameset Home

---

Conference Event Field Listing   |  TOC   |  Dialog Event Field Listing

Connection Event Field Listing

CONNECTION.ALERTING

On an incoming call, this event will be sent as part of the state machine for connections. At this stage, the call is not answered yet, and the associated evenbts are available when the <transition event="connection.alerting"> is matched.

field name	data type	summary
name	string	This will always return the static string value of 'connection.alerting'.
connectionid	string	This will contain the ID of the Connection associated with the event.
protocol	string	Contains the platform protocol ID of the Connection protocol.
info	ECMAScript Object	Contains an Object reference that will contain additional protocol information.
connection	ECMAScript Object	This field will contain 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.

CONNECTION.PROGRESSING

This event occurs when the <transition event="connection.progressing"> is thrown and caught by the application, and is indicative of an outbound call that has not yet been answered, but is in progress. Note that this event occurring does not mean that the call is successful or unsuccessful at this point, it merely serves as a "bookmark" that indicates that a 'connection.connected' event, (or maybe even a 'connection.failed' event), is forthcoming.

field name	data type	summary
name	string	This will always return the static string value of ''.
connectionid	string	This will contain the ID of the Connection associated with the event.
protocol	string	Contains the platform protocol ID of the Connection protocol.
info	ECMAScript Object	Contains an Object reference that will contain additional protocol information.
connection	ECMAScript Object	This field will contain 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.

CONNECTION.CONNECTED

This event is sent as soon as a call is answered, and the <transition event="connection.connected"> is matched. For an inbound call, this will occur as a direct result of an <accept> operation. For outbound calls, it will be sent as soon as the called party picks up the line.

field name	data type	summary
name	string	This will always return the static string value of 'connection.connected'.
connectionid	string	This will contain the ID of the Connection associated with the event.
protocol	string	Contains the platform protocol ID of the Connection protocol.
info	ECMAScript Object	Contains an Object reference that will contain additional protocol information.
connection	ECMAScript Object	This field will contain 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.

CONNECTION.DISCONNECTED

As soon as a previously connected call is disconnected, this event will be thrown to the application. The disconnection can either happen due to programmatic action, (such as encountering a <disconnect> directive), or due to an endpoint terminating the call, (i.e., the caller hangs up the phone). Note that even if the connectionid is available, you cannot perform any new operations on it...as soon as a call is deemed to be invalid, the call object will be internally detached from its formerly associated session. Note that this can, in some circumstances, also result in a 'conference.unjoined' event being fired off immediately after this 'connection.disconnect' event has processed.

field name	data type	summary
name	string	This will always return the static string value of 'connection.disconnected'.
connectionid	string	This will contain the ID of the Connection associated with the event.
protocol	string	Contains the platform protocol ID of the Connection protocol.
reason	string	This field will contain the disconnection reason code.  Currently, this will always be noreason - this will be expanded/enhanced.
info	ECMAScript Object	Contains an Object reference that will contain additional protocol information.
connection	ECMAScript Object	This field will contain 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.
trigger	string	Indicates which entity cause the disconnection to occur. Valid values are 'network' for network-initiated disconnections, 'platform' for disconnections triggered by platform-based rules (such as a maximum connection duration), or 'application' for disconnections performed as a result of application actions.  Note that this field is not currently supported at this time.
_callendtime	string	Contains a GMT timestamp that denotes the end of the call
_callstarttime	string	Contains a GMT timestamp that denotes the start of the call
_sipreason	string	Contains a SIP response code that indicates the reason for the disconnect, (503, 501, 603, etc.).  Note that this field is not currently supported at this time.

CONNECTION.REDIRECTED

This event will occur when a directive to redirect an incoming call to a endpoint has been received, and the <transition event="connection.redirected"> is matched within the CCXML 1.0 application: this implies a successful redirect operation. Redirects can be generated via the endpoint, for such reasons as 'busy', 'unknown', etc. Note that in the event that the configuration of the platform precludes the possibility of a redirect operation, then a 'connection.redirect.failed' event will be thrown to the CCXML 1.0 interpreter.

field name	data type	summary
name	string	This will always return the static string value of 'connection.redirected'.
connectionid	string	This will contain the ID of the Connection associated with the event.
protocol	string	Contains the platform protocol ID of the Connection protocol.
reason	string	This field will contain the redirect reason code.  Possible values are: redirect successful.
info	ECMAScript Object	Contains an Object reference that will contain additional protocol information.
connection	ECMAScript Object	This field will contain 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.

CONNECTION.MERGED

Note that <merge> is currently unsupported on the CCXML 1.0 platform. When this feature is made available, a notification will be posted here. Until then, this section of the documentation is strictly for informative purposes.

The 'connection.merged' event will occur when the network successfully merges the call with a seperate connection. An important caveat is that a single connection.merged event is received on each of the two connections that are merged.Note that as a direct consequence of a successful <merge>, the platform will  destroy any existing connection bridges, (with the exception of the merged connections), and will generate a 'conference.unjoined' event to be trapped by the CCXML 1.0 application. 

CONNECTION.FAILED

• badnumber: the number formatting defined in the outdial syntax, usually via <createcall>, is improperly formatted. This can be thrown in the event of 500 server internal, 404 not found, 484 address incomplete, etc.
• busy: the called number returned an ISDN 'busy' signal, (480 temporarily unavailable, 486 busy here, 603 busy decline)
• rejected: the number dialed was rejected at the telco level, (usually resulting in a 'fast busy' when dialed manually).
• timeout: the called party did not pick up the phone before the defined 'timeout' value expired, (408).
• unknown: the call was rejected by the endpoint for unspecified reasons
• unreachable: the called party was unreachable, due to a  403 forbidden, or anything between 501-599

CONNECTION.SIGNAL

CONNECTION.MERGE.FAILED

CONNECTION.REDIRECT.FAILED

CONNECTION.ACCEPT.FAILED

CONNECTION.REJECT.FAILED

Conference Event Field Listing   |  TOC   |  Dialog Event Field Listing