Sipputheader

Allows scripts and Sipgetheader action to interact with remote SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. carriers via SIP headers. You can have Sipputheader execute multiple times if needed. The same SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. header can be put multiple times. This would result in the same header with different values bring repeated in the SIP messages. A setting must be enabled on the SIP trunk groups within the CXone platform to allow headers to be accepted. Contact your CXone Account Representative to enable the setting.

Dependencies

• This action only affects headers used with a Placecall action. If you need to affect headers for a blind transfer, use the SIPXFERPUTHD action.
• Place the Sipputheader action before a Placecall action.
• If the call with the remote carrier does not use SIP, the SIP header actions have no effect. No SIP header can be sent and no SIP header can be received for the call leg.
• SIP headers can be sent and received only on the initial SIP Invite message or the final 2xx response to an initial Invite. Only headers that start with “X-“ can be sent or received.
• You can have Sipputheader execute multiple times if needed.
• The same SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. header can be put multiple times. This would result in the same header with different values bring repeated in the SIP messages.

Supported Script Types

Phone

Similar Action

The SIPXFERPUTHD action is similar to Sipputheader, but is for use when doing blind transfers.

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.

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.

Script Example

This example is not a complete script. Additional scripting work is required to use this action.