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.
`_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.).

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

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.

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.merged'.
`connectionid`	string	This will contain the ID of the Connection associated with the event.
`mergeid`	string	This field will contain the ID of the Connection with which the Connected referenced by the event was merged.
`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.FAILED

This event is sent as soon as an attempt to connect a call fails. The classic scenario where this happens is an outbound call where the call destination returns a 'busy' or 'unavailable' status. Again, after this event, the call leg will be unavailable. The call failure reason is a well-defined string, of which a few of the more common returns are enumerated below:

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, 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, 404 not found, or anything between 501-599

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.failed'.
`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 connection failure reason code. Possible values include: busy, noanswer, unreachable (if a SIP address doesn't answer), badnumber (if a SIP address doesn't parse), rejected, outofports, unknown, not connected (far end hangup occurred while busy), cannot answer, (<answer> failed), cannot hangup (<disconnect> fails), cannot reject (<reject> fails).
`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.
`_sipreason`	string	Contains a SIP response code that indicates the reason for the disconnect, (503, 501, 603, etc.).

CONNECTION.SIGNAL

The 'connection.signal' event can be thrown to the CCXML 1.0 application in a number of scenarios, and usually indicates that a network scoped signal has been received in the execution context. This can occur when a call is answered via a TDD-capable device is dialed, or when DTMF tones are received on the media stream immediately after connection that is used for passing call setup data.

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.signal'.
`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.MERGE.FAILED

This event will only occur when a <merge> operation has failed to complete. In many cases, the exact cause failure to complete a <merge> directive will be displayed in the 'reason' property.

field name	data type	summary
`name`	string	This will always return the static string value of 'error.merge'.
`connectionid1`	string	This field contains the ID of the first Connection identified when the merge was invoked.
`connectionid2`	string	This field contains the ID of the second Connection identified when the merge was invoked.
`reason`	string	This field will contain a description of the reason the merge failed.
`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.REDIRECT.FAILED

This event is the result of a <redirect> operation that has failed to complete due to any number of causes: The 'reason' property will allow the developer to access the exact explanation for why the request failed. Note that when this event is generated, it does not change the state of the call, thereby allowing the developer to specify an alternate <redirect> URI, or to gracefully handle the event without ending the call session.

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.redirect.failed'.
`connectionid`	string	This will contain the ID of the Connection associated with the event.
`reason`	string	This field will contain a description of the reason the redirect failed. Currently, the value will be connection.failed, which is a bug (fix pending).
`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.ACCEPT.FAILED

This event being thrown is indicative of an <accept> directive that has been denied for any number of reasons: again, the handy 'reason' property allows us to see exactly why the event was generated. Note that when this event is thrown, the Connection Object remains unchanged.

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.accept.failed'.
`connectionid`	string	Contains the ID of the first connection identified when the `<accept>` was invoked.
`reason`	string	This field will contain a description of the reason the accept failed. Possible values include: connection.failed.
`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.REJECT.FAILED

Similar to the 'connection.accept.failed' event, this event occurs only when a directive to <reject> a call has failed. Also similar to 'connection.accept.failed', we can access the 'reason' property to see exactly why the operation failed. Again similar to the 'connection.accept.failed' event, the Connection Object remains unchanged when this event is generated.

field name	data type	summary
`name`	string	This will always return the static string value of 'connection.reject.failed'.
`connectionid`		Contains the ID of the first connection identified when the `<reject>` was invoked
`reason`	string	This field will contain a description of the reason the reject failed. Possible values include: connection.failed.
`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

mtatum111

10/7/2008 11:19 AM (EDT)

Is connection.progressing only used for an outbound call? It seems like I have seen other documentation saying that it is for inbound as well. However, I don't think that is the case.

The way that I understand it by reading docs on voxeo (which are fantastic!) is that you have the following

Inbound call
connection.alerting -> connection.connected

Outbound call
<creatcall> -> connection.progressing->connection.connected

is that correct?

Thanks for any explanation.

voxeojeff

10/7/2008 11:42 AM (EDT)

Hello,

Yes, you are correct. A call in the progressing state indicates that the call is in progress, and has not been answered yet (similar to a SIP 180 Ringing).

I hope this helps clarify, please let me know if you have any further questions.

Regards,
Jeff

bpcamac

2/3/2009 8:37 PM (EST)

(moved to support ticket)

Conference Event Field Listing

| TOC

| Dialog Event Field Listing