CCXML classes

Table 1 shows the CCXML objects, descriptions of their properties and whether a property is optional or mandatory.

Table 1. Summary of CCXML classes and their properties.
This table lists for each Class, its Properties, corresponding Property Descriptions, and whether or not the property is optional.
Class	Property	Description	Optional
Connection Class	connectionid	Unique string identifier for connection instance	No
	state	A number that identifies the current state of the class instance. The number can be converted back to a String using `Connection.states[ConnectionObjectName.state]`	No
	substate	Depending on protocol being used, more details of state, which will be one of the following: ALERTING, PROGRESSING, CONNECTED, FAILED, DISCONNECTED, and ERROR	Yes
	dialogid	Identifier of a dialog currently using the connection. Not implemented in Blueworx Voice Response.	Yes
	endpoint	Connection identifier for second party in a call ‘bridge'. Updated by a `<join>`. Not implemented in Blueworx Voice Response.	No
	input	The identifier (connectionid/dialogid) of the single media endpoint (connection, dialog or conference) providing the input stream to this media endpoint or undefined if there is no input stream. This property must be updated each time a <join>/<unjoin> or any other media operation changes the media source to this media endpoint. If the media endpoint does not have a media source the value must be ECMAScript undefined.	No
	outputs	An array containing the identifiers of all media endpoints to which the output stream of this media endpoint is sent. If the media endpoint does not have any media destinations the length of the array must be 0.	No
Connection Class	local	URI address of CCXML Browser. Possible values are: Call Type URI Incoming Called number Redirected Last specified number Outgoing Calling number	Yes
	remote	URI address of a remote device. Possible values are: Call Type URI Incoming Calling number Redirected Last requestor specified number Outgoing Called number	Yes
	redirect	An array of redirection information, which can be any of the following: uri Connection address pi Presentation info si Screening info reason Why call was redirected The original call is represented by `connection.redirect[0]`, and the last redirection is represented by the last array element. Not implemented in Blueworx Voice Response.	Yes
	protocol	Reference to an object defining protocol information	Yes
Connection Class	aai	Information passed from application to application when a connection is created Not implemented in Blueworx Voice Response	Yes
	originator	Source of a call. Possible string values are: `"local"` — incoming call `"remote"` — outgoing call	Yes
	objecttype	The type of this object which must be `connection`.	No
conferenceid	Not implemented in Blueworx Voice Response
Dialog Class	id	Unique string identifier for dialog instance	No
	connectionid	Identifier of connection to which the dialog connection is ‘bridged'	No
	type	MIME type of the document that loaded the dialog Note: The audio/wav MIME-type is not supported by Blueworx Voice Response.	No
	src	URI address of a dialog document	No
	input	The identifier (connectiondid/dialogid) of the single media endpoint (connection, dialog or conference) providing the input stream to this media endpoint or undefined if there is no input stream. This property must be updated each time a <join>/<unjoin> or any other media operation changes the media source to this media endpoint. If the media endpoint does not have a media source the value must be ECMAScript undefined.	No
	outputs	An array containing the identifiers of all media endpoints to which the output stream of this media endpoint is sent. If the media endpoint does not have any media destinations the length of the array must be 0.	No
	objecttype	The type of this object which must be `dialog`.	No
	conferenceid	Not implemented in Blueworx Voice Response