Sipgetheader

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

An old-style phone receiver with the letters SIP above it.

Allows scripts and the Sipputheader action to interact with remote SIPClosed 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

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

Add Caption

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

Header Name

The name of the header. Must include at least one character. Can include any characters, though only printable ASCII characters can match a SIPClosed Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls. header name.

Header Value

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.

Error

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.