Section II – Functional Modules > Voice Interaction Interface > Action Elements Bottom of Page
| Genesys 8.0 SCXML Technical Reference
< Parameter Elements Events >

## Action Elements

#### <createcall>

This is the initiation or creation of a voice interaction between a customer or resource and a resource. This is equivalent to the T-Server TMakeCall or TMakePredictiveCall functions.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
from | true | value expression | none | Any valid string or resource object | A value expression which returns the address that this call is to be made from. See SCXML Legal Data Values and Value Expressions
to | true | value expression | none | Any valid string or resource object | A value expression which returns the destination address for this call. See SCXML Legal Data Values and Value Expressions
type | false | NMTOKEN | regular | regular, agent, supervisor, priority, agent priority, predictive | This defines the type of call that is to be created. Regular — is a call to a customer. Agent — is a call to another agent. Supervisor — is a call to a supervisor. Priority — is a priority call to a customer. Agentpriority — is a priority call to another agent. Predictive — is a predictive call to a customer.
reason | false | value expression | none | Any valid string | A value expression which returns the reason for making this call. See SCXML Legal Data Values and Value Expressions for details.
udata | false | value expression | none | Any valid ECMAScript object | A value expression which returns a valid ECMAScript object. This object's data will become part of the call's interaction object. See SCXML Legal Data Values and Value Expressions for details.
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when establishing this call. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.
timeout | false | value expression | none | A value expression which returns an integer | A value expression which returns an integer which represents the number of seconds to wait. See SCXML Legal Data Values and Value Expressions for details. The integer returned is interpreted as a time interval. This interval begins when `<createcall>` is executed. The `<createcall>` must fail if not completed by the end of this interval. Completion is defined as the call getting to a CONNECTED state as signaled by an interaction.created event. A failed `<createcall>` must return either error.voice.createcall event or the interaction.partystatechanged event. This attribute is only used when the type attribute is set to "predictive".

The following is an example:

    <state id="do_createcall">
    <datamodel>
    	<data id="reqid"/>
    </datamodel>
    <onentry>
    	<ixn:createcall requestid="_data.reqid" from="'1234'" to="'+1919466600'" />
    </onentry>
    <transition event="voice.createcall.done" target="statex"/>
    <transition event="error.voice.createcall" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.createcall.done — This event is sent when the request has been accepted by the system and the call has started the creation process.
- Interaction.added — This event is sent when either party is connected to the call.
- interaction.partystatechanged — This event is sent when the call has been created and either party is connected to the call.
- interaction.partystatechanged — This event is sent when the call has failed for some reason. This includes timeouts based on the timeout attribute.
- error.voice.createcall — This event is sent when the request itself has failed for some reason.

#### <hold>

This action puts a voice interaction on hold for a specific resource's device. This is equivalent to the T-Server THoldCall function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
interactionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
resource | true | value expression | none | Any valid string or resource object | A value expression which returns the holding device address for this call. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when holding this call. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_holdcall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="ixnid"/>
    </datamodel>
    <onentry>
    	<ixn:hold requestid="_data.reqid" interactionid="_data.ixnid" resource="'1234'" />
    </onentry>
    <transition event="voice.hold.done" target="statex"/>
    <transition event="error.voice.hold" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.hold.done — This event is sent when the request has been accepted by the system and the interaction has started the hold process.
- Interaction.partystatuschanged — This event is sent when the actual resource is on hold for the call.
- error.voice.hold — This event is sent when the request itself has failed for some reason.

#### <retrieve>

This action retrieves a voice interaction from hold for a specific resource's device. This is equivalent to the T-Server TRetrieveCall function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
interactionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
resource | true | value expression | none | Any valid string or resource object | A value expression which returns the retrieved device address for this call. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when retrieving this call. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_retrievecall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="ixnid"/>
    </datamodel>
    <onentry>
    	<ixn:retrieve requestid="_data.reqid" interactionid="_data.ixnid" resource="'1234'" />
    </onentry>
    <transition event="voice.retrieve.done" target="statex"/>
    <transition event="error.voice.retrieve" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.retrieve.done — This event is sent when the request has been accepted by the system and the interaction has started the retrieve process.
- interaction.partystatuschanged — This event is sent when the actual resource is retrieved from hold for the call.
- error.voice.retrieve — This event is sent when the request itself has failed for some reason.

#### <consultation>

This action extends an existing voice interaction to consult with a new resource's device. This is equivalent to the T-Server TInitiateTransfer and TInitiateConference functions.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
interactionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
from | true | value expression | none | Any valid string or resource object | A value expression which returns the address that this consultation is to be made from. See SCXML Legal Data Values and Value Expressions
to | true | value expression | none | Any valid string or resource object | A value expression which returns the destination address for this consultation See SCXML Legal Data Values and Value Expressions
udata | false | value expression | none | Any valid ECMAScript object | A value expression which returns a valid ECMAScript object. This object's data will be come part of the consultation call's interaction object. See SCXML Legal Data Values and Value Expressions for details.
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when consulting. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_consultationcall">
    <datamodel>
    	</datamodel>
    <onentry>
    	<ixn:consultation requestid="_data.reqid" interactionid="_data.ixnid" from="'1234'" to="'5678'" />
    </onentry>
    <transition event="voice.consultation.done" target="statex"/>
    <transition event="error.voice.consultation" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.consultation.done — This event is sent when the request has been accepted by the system and it has started the consultation process.
- Interaction.partycreated — This event is sent when the consulted resource is added to the consulted call.
- Interaction.partystatuschanged — This event is sent when the consulting resource is put on hold for the existing call.
- Interaction.partyadded — This event is sent when the consulted and consulting resources are added to the consulted call.
- error.voice.consultation — This event is sent when the request itself has failed for some reason.

#### <alternate>

This action alternates a resource from a held call and an active call. This is equivalent to the T-Server TAlternateCall function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
heldinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
heldresource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is the held call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
activeinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
activeresource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is in the active call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when altering. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_alternatecall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="Aixnid"/>
    	<data id="Hixnid"/>
    </datamodel>
    <onentry>
    	<ixn:alternate requestid="_data.reqid" heldinteractionid="_data.Hixnid"
    		heldresource="'1234'" activeinteractionid="_data.Aixnid" activeresource="'5678'" />
    </onentry>
    <transition event="voice.alternate.done" target="statex"/>
    <transition event="error.voice.alternate" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.alternate.done — This event is sent when the request has been accepted and the system has started the alternate process.
- Interaction.partystatuschanged — This event is sent when the held and active resource in the calls changes state (held to active and active to held).
- error.voice.alternate — This event is sent when the request itself has failed for some reason.

#### <reconnect>

This action drops the active call in the consultation and retrieves the held call for a specific resource. This is equivalent to the T-Server TReconnectCall function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
heldinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
heldresource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is the held call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
activeinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
activeresource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is in the active call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when reconnection is done. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_reconnectcall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="Aixnid"/>
    	<data id="Hixnid"/>
    </datamodel>
    <onentry>
    	<ixn:reconnect requestid="_data.reqid" heldinteractionid="_data.Hixnid" heldresource="'1234'"
    		activeinteractionid="_data.Aixnid" activeresource="'5678'" />
    </onentry>
    <transition event="voice.reconnect.done" target="statex"/>
    <transition event="error.voice.reconnect" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.reconnect.done — This event is sent when the request has been accepted by the system, which has started the reconnect process.
- interaction.partystatuschanged — This event is sent when the held resource in the calls changes state.
- interaction.partydeleted — This event is sent when the parties of the active call are dropped.
- interaction.deleted — This event is sent when the active call is terminated.
- error.voice.reconnect — This event is sent when the request itself has failed for some reason.

#### <conference>

This action conferences a consultation call from a specific resource. This is equivalent to the T-Server TCompleteConference function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
heldinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
activeinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
resource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is conferencing the call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when conferencing. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_conferencecall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="Aixnid"/>
    	<data id="Hixnid"/>
    </datamodel>
    <onentry>
    	<ixn:conference requestid="_data.reqid" heldinteractionid="_data.Hixnid"
    		activeinteractionid="_data.Aixnid" resource="'1234'"/>
    </onentry>
    <transition event="voice.conference.done" target="statex"/>
    <transition event="error.voice.conference" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.conference.done — This event is sent when the request has been accepted by the system, which has started the conference process.
- interaction.partystatuschanged — This event is sent when the held resource in the calls changes state.
- interaction.partydeleted — This event is sent when the parties of the active and held calls are dropped.
- interaction.deleted — This event is sent when the held call is terminated.
- error.voice.conference — This event is sent when the request itself has failed for some reason.

#### <transfer>

This action transfers a consultation call from a specific resource. This is equivalent to the T-Server TCompleteTransfer function.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the fetch completion event. Every request must receive a unique identifier.
heldinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
activeinteractionid | true | value expression |  | Any value expression that returns a valid string | A value expression which returns the _genesys.FMname.interactions[x].g_uid associated with this request. See SCXML Legal Data Values and Value Expressions for details.
resource | true | value expression | none | Any valid string or resource object | A value expression which returns the address that is transferring the call. For details, see Addressing Resources section. See SCXML Legal Data Values and Value Expressions
hints | false | value expression | none | Any valid ECMAScript object | A value expression which returns the ECMAScript object containing information which may be used by the implementing functional module when transferring. This information may consist of protocol-specific parameters, protocol selection guidelines, and so on. Note: The meaning of these hints is specific to the implementing functional module. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <state id="do_transfercall">
    <datamodel>
    	<data id="reqid"/>
    	<data id="Aixnid"/>
    	<data id="Hixnid"/>
    </datamodel>
    <onentry>
    	<ixn:conference requestid="_data.reqid" heldinteractionid="_data.Hixnid"
    		activeinteractionid="_data.Aixnid" resource="'1234'"/>
    </onentry>
    <transition event="voice.transfer.done" target="statex"/>
    <transition event="error.voice.transfer" target="statey"/>
    </state>

##### Children

None

##### Events

The following events can be generated as part of this action:

- voice.transfer.done — This event is sent when the request has been accepted by the system, which has started the transfer process.
- interaction.partyadded — This event is sent when the transferred party is added to the active call.
- interaction.partydeleted — This event is sent when the transferring party drops.
- interaction.deleted — This event is sent when the held call is terminated.
- error.voice.transfer — This event is sent when the request itself has failed for some reason.

Section II – Functional Modules > Voice Interaction Interface > Action Elements Top of Page
| Genesys 8.0 SCXML Technical Reference
< Parameter Elements Events >