Sipgetheader

Allows scripts and the Sipputheader 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. A setting must be enabled on the SIP trunk groups within the CXone platform to allow for 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.
• If the same SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. header is received multiple times in a message, only one of the values for the SIP header can be “got” no matter how many times Sipgetheader is invoked.
• 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.
• 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 The portion of an interaction that takes place between CXone and the agent..

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 include at least one character. Can include any characters, though only printable ASCII characters can match a SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. header name.
HeaderValue	The value of the header. Must include at least one character.

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.