SIPXFERPUTHD

This help page is for Desktop Studio. This information is also available for Studio.

Allows additions to be made to the SIP header of a call prior to a transfer or blind transfer. Use with the BLINDXFER action.

The SIPXFERPUTHD action is found in the Framework tab in Studio, not the Tools tab. The path is Framework > Voice > SIP > SIPXFERPUTHD.

A setting must be enabled on the SIP trunk groups within the CXone Mpower platform to allow for headers to be accepted. Contact your customer service representative to enable the setting.

Supported Script Types

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

Phone

Similar Actions

The Sipgetheader action and the Sipputheader action perform a similar function as SIPXFERPUTHD but are for use with the Placecall action.

Input Properties

These properties define data that the action uses when executing.

Property	Description
Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.
HeaderName	The name of the header. Must be one of the following: User-to-User: One User-to-User header is allowed with outbound calls in the SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. Invite message. X-: Any number of custom headers prefixed by "X-" can be included in outgoing SIP Invite messages. P-: Any number of custom headers prefixed by "P-" can be included in outgoing SIP Invite messages, with the following exceptions (headers that can manipulate billing rules): p-asserted-identity p-charge-info
HeaderValue	Header values can be arbitrary data or script variables.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

HeaderName

The name of the header. Must be one of the following:

User-to-User: One User-to-User header is allowed with outbound calls in the SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. Invite message.
X-*: Any number of custom headers prefixed by "X-" can be included in outgoing SIP Invite messages.
P-*: Any number of custom headers prefixed by "P-" can be included in outgoing SIP Invite messages, with the following exceptions (headers that can manipulate billing rules):
- p-asserted-identity
- p-charge-info

HeaderValue

Header values can be arbitrary data or script variables.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition	Description
Default	Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the action's other branches are not defined.
OnError	Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.